NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Routing::PortConnection Class Reference

The Routing PortConnection object is used by Routing to position ports while placing parts. More...

Inheritance diagram for NXOpen::Routing::PortConnection:
NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject

List of all members.

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.

Detailed Description

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.


Member Enumeration Documentation

Overridden port connection validity.

Enumerator:
OverriddenValidityNone 

The port connection validity has not been overridden.

OverriddenValidityValid 

The port connection validity has been overridden to be valid.

OverriddenValidityInvalid 

The port connection validity has been overridden to be invalid.


Member Function Documentation

Returns whether the ports in the port connection are aligned correctly.

Both direction and rotation are evaluated.

Returns:
validity of the current connection.
Created in NX8.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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")

Parameters:
reasonThe reason why this connection was forced to be valid.

Returns the engagement distance between the two ports connected by a Port Connection object.

Returns:
engagement distance between the 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")

Returns the overridden validity value of the port connection.

Returns:
overridden validity value.
Created in NX8.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Gets the reason why a port connection's validity was overridden.

Returns:
The reason why this 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")

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")

Parameters:
port1first Port connected by the Port Connection object
port2second Port connected by the Port Connection object

Returns whether the connection is forced to be valid.

Returns:
validity of the current connection.
Created in NX8.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns whether the connection is valid.

Validity is initially determined by the alignment of the ports but can be overridden by OverrideValidity or ForceValid

Returns:
validity of the current connection.
Created in NX8.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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")

Parameters:
overriddenValidityoverridden 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")

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")

Parameters:
engagementengagement distance to be set between the ports connected by the Port Connection object

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")

Parameters:
reasonThe reason why this connection's validity was overridden.

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")

Parameters:
port1first port to be connected by the Port Connection object
port2second port to be connected by the Port Connection object

The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.