NX Open C++ Reference Guide
|
The Routing PortConnection object is used by Routing to position ports while placing parts. More...
Public Types | |
enum | OverriddenValidity { OverriddenValidityNone, OverriddenValidityValid, OverriddenValidityInvalid } |
Overridden port connection validity. More... | |
Public Member Functions | |
bool | ArePortsAligned () |
Returns whether the ports in the port connection are aligned correctly. | |
void | ForceValid (const NXString &reason) |
Force the connection to be valid regardless of the port alignment or the overridden value. | |
double | GetEngagement () |
Returns the engagement distance between the two ports connected by a Port Connection object. | |
NXOpen::Routing::PortConnection::OverriddenValidity | GetOverriddenValidity () |
Returns the overridden validity value of the port connection. | |
NXString | GetOverrideReason () |
Gets the reason why a port connection's validity was overridden. | |
void | GetPorts (NXOpen::Routing::Port **port1, NXOpen::Routing::Port **port2) |
Returns the two ports connected by a Port Connection object. | |
bool | IsForcedValid () |
Returns whether the connection is forced to be valid. | |
bool | IsValid () |
Returns whether the connection is valid. | |
void | OverrideValidity (NXOpen::Routing::PortConnection::OverriddenValidity overriddenValidity) |
Overrides the validity of the port connection. | |
void | RemoveForcedValidity () |
Removes the forced validity setting on the connection. | |
void | SetEngagement (double engagement) |
Sets the engagement distance between the two ports connected by a Port Connection object. | |
void | SetOverrideReason (const NXString &reason) |
Sets the reason why a port connection's validity was overridden. | |
void | SetPorts (NXOpen::Routing::Port *port1, NXOpen::Routing::Port *port2) |
Sets the link between the two ports connected by the Port Connection object. |
The Routing PortConnection object is used by Routing to position ports while placing parts.
To create a new instance of this class, use Routing::PortConnectionCollection::CreatePortConnection
Created in NX4.0.0.
Overridden port connection validity.
Returns whether the ports in the port connection are aligned correctly.
Both direction and rotation are evaluated.
void NXOpen::Routing::PortConnection::ForceValid | ( | const NXString & | reason | ) |
Force the connection to be valid regardless of the port alignment or the overridden value.
The user's login name and the date and time are recorded automatically along with the given reason.
Created in NX8.0.0.
License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
reason | The reason why this connection was forced to be valid. |
Returns the engagement distance between the two ports connected by a Port Connection object.
NXOpen::Routing::PortConnection::OverriddenValidity NXOpen::Routing::PortConnection::GetOverriddenValidity | ( | ) |
Returns the overridden validity value of the port connection.
Gets the reason why a port connection's validity was overridden.
void NXOpen::Routing::PortConnection::GetPorts | ( | NXOpen::Routing::Port ** | port1, |
NXOpen::Routing::Port ** | port2 | ||
) |
Returns the two ports connected by a Port Connection object.
Created in NX4.0.0.
License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Returns whether the connection is forced to be valid.
Returns whether the connection is valid.
Validity is initially determined by the alignment of the ports but can be overridden by OverrideValidity or ForceValid
void NXOpen::Routing::PortConnection::OverrideValidity | ( | NXOpen::Routing::PortConnection::OverriddenValidity | overriddenValidity | ) |
Overrides the validity of the port connection.
By default, the validity is determined by evaluating the alignment of the connected ports.
Created in NX8.0.0.
License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
overriddenValidity | overridden validity value. |
Removes the forced validity setting on the connection.
Validity will now be determined based on the alignment or on the overridden validity setting.
Created in NX8.0.0.
License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
void NXOpen::Routing::PortConnection::SetEngagement | ( | double | engagement | ) |
Sets the engagement distance between the two ports connected by a Port Connection object.
Created in NX4.0.0.
License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
engagement | engagement distance to be set between the ports connected by the Port Connection object |
void NXOpen::Routing::PortConnection::SetOverrideReason | ( | const NXString & | reason | ) |
Sets the reason why a port connection's validity was overridden.
Created in NX8.0.0.
License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
reason | The reason why this connection's validity was overridden. |
void NXOpen::Routing::PortConnection::SetPorts | ( | NXOpen::Routing::Port * | port1, |
NXOpen::Routing::Port * | port2 | ||
) |
Sets the link between the two ports connected by the Port Connection object.
Created in NX4.0.0.
License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")