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

Routing Port Object is a parent class for FixturePort, ExtractPort, FittingPort, Multiport, StockPort and TerminalPort
Creator not available in KF. More...

Inheritance diagram for NXOpen::Routing::Port:
NXOpen::SmartObject NXOpen::Routing::IRoutePosition NXOpen::DisplayableObject NXOpen::Routing::ICharacteristic NXOpen::NXObject NXOpen::IFitTo NXOpen::INXObject NXOpen::TaggedObject NXOpen::INXObject NXOpen::INXObject NXOpen::Routing::ExtractPort NXOpen::Routing::FittingPort NXOpen::Routing::FixturePort NXOpen::Routing::MultiPort NXOpen::Routing::ProxyPort NXOpen::Routing::StockOffsetPort NXOpen::Routing::StockPort NXOpen::Routing::TerminalPort

List of all members.

Public Types

enum  FlowDirectionType { FlowDirectionTypeRouteFlowEither, FlowDirectionTypeRouteFlowIn, FlowDirectionTypeRouteFlowOut, FlowDirectionTypeFlowNone }
 Allowed types for flow direction. More...
enum  PortType {
  PortTypeUnknownPort, PortTypeFittingPort, PortTypeFixturePort, PortTypeMultiPort,
  PortTypeTerminalPort, PortTypeStockPort
}
 Specifies the port type. More...

Public Member Functions

bool AllowMultipleConnections ()
 Returns the Allow Multiple Connections property for a Routing::Port .
NXOpen::Routing::FeaturePortAskFeature ()
 Ask Routing::FeaturePort object associated with Routing::Port .
NXOpen::ExpressionClockIncrementObject ()
 Returns the clock angle increment expression of a Routing::Port , i.e.
NXOpen::Routing::PortConnectionConnect ()
 Finds another Routing::Port to connect this port to.
virtual void DeleteCharacterstics (NXOpen::Routing::CharacteristicList *values)
 Removes the input list of characteristics from this object.
void Disconnect ()
 Deletes any Routing::PortConnection objects that reference this port.
int FindPortIntegerCharacteristic (const NXString &name)
 Searches for an integer characteristics on the port, then on the ports component and prototype port if the port is an occurrence.
double FindPortRealCharacteristic (const NXString &name)
 Searches for a real characteristics on the port, then on the ports component and prototype port if the port is an occurrence.
NXString FindPortStringCharacteristic (const NXString &name)
 Searches for a string characteristics on the port, then on the ports component and prototype port if the port is an occurrence.
NXOpen::Vector3d GetAlignmentVector ()
 Retrieves the alignment vector of Port.
virtual
NXOpen::Routing::CharacteristicList
GetCharacteristics ()
 Get all of the characteristics values on the this object.
double GetClockIncrement ()
 The clock angle increment value of Port.
double GetCutbackLength ()
 Returns the cutback length of a port, i.e.
virtual
NXOpen::Routing::CharacteristicList
GetDestinationCharacteristics ()
 Returns the destination characteristics from the input object.
double GetEngagement ()
 Returns the engagement distance of a port, i.e.
NXOpen::Routing::Port::FlowDirectionType GetFlowDirection ()
 Get the value of flow direction of Port.
double GetForwardExtension ()
 Returns the forward extension value for a port i.e.
virtual int GetIntegerCharacteristic (const NXString &name)
 Get the value of an integer characteristic associated with the input name.
NXOpen::Routing::Port::PortType GetPortType ()
 Get the type of Port.
virtual double GetRealCharacteristic (const NXString &name)
 Get the value of a real characteristic associated with the input name.
NXString GetReferenceCharacteristic (const NXString &name)
 Gets a reference characteristic from the port.
NXOpen::DisplayableObjectGetRotationObject ()
 Retrieves the object used to derive the rotation vector of Port.
NXOpen::Vector3d GetRotationVector ()
 Retrieves the rotation vector of Port.
NXOpen::Routing::ISegmentGetSegment ()
 Return the segment the port position and alignment are derived from Returns NULL if the port is not derived from segment.
virtual NXString GetStringCharacteristic (const NXString &name)
 Get the value of a string characteristic associated with the input name.
bool IsEngagementLocked (NXOpen::Routing::Port *portToCheck)
 Checks to see if ports are engaged.
bool IsRotationLocked (NXOpen::Routing::Port *portToCheck)
 Checks if ports have their rotation vectors locked.
std::vector
< NXOpen::Positioning::Constraint * > 
LockEngagement (NXOpen::Routing::Port *portToLock)
 Locks the port engagement using dcm3 constraints.
std::vector
< NXOpen::Positioning::Constraint * > 
LockRotation (NXOpen::Routing::Port *portToLock)
 Locks the port rotation vector using dcm3 constraints.
virtual NXOpen::PointPoint ()
 Returns the Point that specifies the location of the Routing::IRoutePosition object.
virtual NXOpen::Point3d Position ()
 Returns the current location of the object in ABS coordinates.
void ReorderFeature ()
 Reorders the Routing::FeaturePort object associated with Routing::Port after all of the features on which the port feature depends.
void SetAllowMultipleConnections (bool allowMultipleConnections)
 Sets the Allow Multiple Connections property for a Routing::Port .
virtual void SetCharacteristic (const NXString &name, int value)
 Set the value of an integer characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.
virtual void SetCharacteristic (const NXString &name, double value)
 Set the value of an real characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.
virtual void SetCharacteristic (const NXString &name, const NXString &value)
 Set the value of an string characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.
virtual void SetCharacteristics (NXOpen::Routing::CharacteristicList *values)
 Set all of the characteristics values on this object.
void SetClockIncrement (double increment)
 The clock angle increment value of Port
Created in NX4.0.0.
void SetClockIncrementObject (NXOpen::Expression *increment)
 Sets the clock angle increment expression of a Routing::Port , i.e.
void SetFlowDirection (NXOpen::Routing::Port::FlowDirectionType flowDirection)
 Set the flow direction value of Port
Created in NX5.0.0.
virtual void SetPoint (NXOpen::Point *point)
 Sets the Point that specifies the location of the Routing::IRoutePosition object.
virtual void SetPosition (const NXOpen::Point3d &position)
 Sets the current location of the object in ABS coordinates.
void SetReferenceCharacteristic (const NXString &name, const NXString &value)
 Sets a reference characteristics on the port.
void UnlockEngagement (NXOpen::Routing::Port *portToUnlock)
 Unlocks the port engagement
Created in NX5.0.0.
void UnlockRotation (NXOpen::Routing::Port *portToUnlock)
 Unlocks the port rotation
Created in NX5.0.0.

Detailed Description

Routing Port Object is a parent class for FixturePort, ExtractPort, FittingPort, Multiport, StockPort and TerminalPort
Creator not available in KF.



Created in NX4.0.0.


Member Enumeration Documentation

Allowed types for flow direction.

Enumerator:
FlowDirectionTypeRouteFlowEither 

route flow either

FlowDirectionTypeRouteFlowIn 

route flow in

FlowDirectionTypeRouteFlowOut 

route flow out

FlowDirectionTypeFlowNone 

flow none

Specifies the port type.

Enumerator:
PortTypeUnknownPort 

Unknown Port.

PortTypeFittingPort 

Fitting Port.

PortTypeFixturePort 

Fixture Port.

PortTypeMultiPort 

Multi Port.

PortTypeTerminalPort 

Terminal Port.

PortTypeStockPort 

Stock Port.


Member Function Documentation

Returns the Allow Multiple Connections property for a Routing::Port .

The property controls the number of connections that can be routed to this Routing::Port . Although this can be specified in the Mechanical application, the Electrical application is where this property is most used.


Created in NX5.0.0.

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

Ask Routing::FeaturePort object associated with Routing::Port .

Returns NULL if the port was created in preNX6 release and not converted to Routing::FeaturePort . To convert Routing::Port object to Routing::FeaturePort object use Routing::PortCollection::ConvertToFeatures .

Returns:

Created in NX6.0.0.

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

Returns the clock angle increment expression of a Routing::Port , i.e.

an expression representing the minimum angle for clocking the Routing::Port .
Created in NX5.0.0.

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

Finds another Routing::Port to connect this port to.

Builds a Routing::PortConnection object if a connectable port is found. See Routing::PortConnectionCollection::CanPortsConnect . Does nothing if this port already has a Routing::PortConnection object referencing it.

Returns:

Created in NX5.0.0.

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

Removes the input list of characteristics from this object.


Created in NX4.0.0.

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

Parameters:
valuesvalues

Implements NXOpen::Routing::ICharacteristic.

Deletes any Routing::PortConnection objects that reference this port.


Created in NX5.0.0.

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

Searches for an integer characteristics on the port, then on the ports component and prototype port if the port is an occurrence.

Returns:

Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
name
NOTE: The full Unicode character set is not supported for this parameter.

Searches for a real characteristics on the port, then on the ports component and prototype port if the port is an occurrence.

Returns:

Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
name
NOTE: The full Unicode character set is not supported for this parameter.

Searches for a string characteristics on the port, then on the ports component and prototype port if the port is an occurrence.

Returns:

Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
name
NOTE: The full Unicode character set is not supported for this parameter.

Retrieves the alignment vector of Port.

Returns:
Vector direction in absolute co-ordinate system
Created in NX4.0.0.

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

Get all of the characteristics values on the this object.

Returns:

Created in NX4.0.0.

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

Implements NXOpen::Routing::ICharacteristic.

The clock angle increment value of Port.

Returns:
Clock increment value in degrees
Created in NX4.0.0.

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

Returns the cutback length of a port, i.e.

the length along the wire from the port where individual wires leave a bundle to attach to pins

Returns:
Cutback length
Created in NX4.0.0.

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

Returns the destination characteristics from the input object.

Retrieves the description of which destination characteristics to read from the application view and then reads those destination characteristics from the object

  • Ports: Reads characteristics from the port.
  • RCPs: Attempts to find a port at the RCP, reads characteristics from the port if it exists, otherwise reads from the stock associated with the rcp.
  • Segments: Reads characteristics from the stock associated with the segment.
  • Components: Reads characteristics directly from the component.
  • Stock: Reads characteristics from the stock or from the stock's data.
Returns:

Created in NX4.0.0.

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

Implements NXOpen::Routing::ICharacteristic.

Returns the engagement distance of a port, i.e.

the distance behind the port that another fitting or stock may engage

Returns:
Engagement distance
Created in NX4.0.0.

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

Get the value of flow direction of Port.

Returns:

Created in NX5.0.0.

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

Returns the forward extension value for a port i.e.

the minimum length that a segment must remain straight coming out of a Port

Returns:
Port extension
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
virtual int NXOpen::Routing::Port::GetIntegerCharacteristic ( const NXString name) [virtual]

Get the value of an integer characteristic associated with the input name.

Returns:

Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
name
NOTE: The full Unicode character set is not supported for this parameter.

Implements NXOpen::Routing::ICharacteristic.

Get the type of Port.

Returns:
Port Type
Created in NX7.5.2.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
virtual double NXOpen::Routing::Port::GetRealCharacteristic ( const NXString name) [virtual]

Get the value of a real characteristic associated with the input name.

Returns:

Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
name
NOTE: The full Unicode character set is not supported for this parameter.

Implements NXOpen::Routing::ICharacteristic.

Gets a reference characteristic from the port.

Returns:

Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
name
NOTE: The full Unicode character set is not supported for this parameter.

Retrieves the object used to derive the rotation vector of Port.

Returns:
Object used to derive the rotation vector
Created in NX4.0.0.

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

Retrieves the rotation vector of Port.

Returns:
Vector direction in absolute co-ordinate system
Created in NX4.0.0.

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

Return the segment the port position and alignment are derived from Returns NULL if the port is not derived from segment.

Returns:
ISegment from which the port is derived
Created in NX4.0.0.

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

Get the value of a string characteristic associated with the input name.

Returns:

Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
name
NOTE: The full Unicode character set is not supported for this parameter.

Implements NXOpen::Routing::ICharacteristic.

Checks to see if ports are engaged.

Returns:

Created in NX5.0.0.

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

Checks if ports have their rotation vectors locked.

Returns:

Created in NX5.0.0.

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

Locks the port engagement using dcm3 constraints.

Returns:
Newly created port constraints
Created in NX5.0.0.

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

Locks the port rotation vector using dcm3 constraints.

Returns:
Newly created port constraints
Created in NX5.0.0.

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

Returns the Point that specifies the location of the Routing::IRoutePosition object.

A NULL object indicates that this object is not associated to any point.
Created in NX4.0.0.

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

Implements NXOpen::Routing::IRoutePosition.

Returns the current location of the object in ABS coordinates.

This value is overridden by the coordinates of the point associated with this object.
Created in NX4.0.0.

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

Implements NXOpen::Routing::IRoutePosition.

Reorders the Routing::FeaturePort object associated with Routing::Port after all of the features on which the port feature depends.

Does nothing if the port was created in preNX6 release and not converted to Routing::FeaturePort . To convert Routing::Port object to Routing::FeaturePort object use Routing::PortCollection::ConvertToFeatures .
Created in NX6.0.5.

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

void NXOpen::Routing::Port::SetAllowMultipleConnections ( bool  allowMultipleConnections)

Sets the Allow Multiple Connections property for a Routing::Port .

The property controls the number of connections that can be routed to this Routing::Port . Although this can be specified in the Mechanical application, the Electrical application is where this property is most used.


Created in NX5.0.0.

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

Parameters:
allowMultipleConnectionsShould the multiport allow multiple connections?
virtual void NXOpen::Routing::Port::SetCharacteristic ( const NXString name,
int  value 
) [virtual]

Set the value of an integer characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

Converts the type of an existing characteristic with the same name to integer if it's type is not integer.
Created in NX4.0.0.

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

Parameters:
name
NOTE: The full Unicode character set is not supported for this parameter.
valuevalue

Implements NXOpen::Routing::ICharacteristic.

virtual void NXOpen::Routing::Port::SetCharacteristic ( const NXString name,
double  value 
) [virtual]

Set the value of an real characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

Converts the type of an existing characteristic with the same name to real if it's type is not real.
Created in NX4.0.0.

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

Parameters:
name
NOTE: The full Unicode character set is not supported for this parameter.
valuevalue

Implements NXOpen::Routing::ICharacteristic.

virtual void NXOpen::Routing::Port::SetCharacteristic ( const NXString name,
const NXString value 
) [virtual]

Set the value of an string characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

Converts the type of an existing characteristic with the same name to string if it's type is not string.
Created in NX4.0.0.

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

Parameters:
name
NOTE: The full Unicode character set is not supported for this parameter.
value
NOTE: The full Unicode character set is not supported for this parameter.

Implements NXOpen::Routing::ICharacteristic.

Set all of the characteristics values on this object.


Created in NX4.0.0.

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

Parameters:
valuesvalues

Implements NXOpen::Routing::ICharacteristic.

void NXOpen::Routing::Port::SetClockIncrement ( double  increment)

The clock angle increment value of Port
Created in NX4.0.0.



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

Parameters:
incrementClock increment value in degrees

Sets the clock angle increment expression of a Routing::Port , i.e.

an expression representing the minimum angle for clocking the Routing::Port .
Created in NX5.0.0.

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

Parameters:
incrementClock increment expression

Set the flow direction value of Port
Created in NX5.0.0.



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

Parameters:
flowDirectionflow direction
virtual void NXOpen::Routing::Port::SetPoint ( NXOpen::Point point) [virtual]

Sets the Point that specifies the location of the Routing::IRoutePosition object.

A NULL object indicates that this object is not associated to any point.
Created in NX4.0.0.

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

Parameters:
pointNew location of object in ABS coordinates

Implements NXOpen::Routing::IRoutePosition.

virtual void NXOpen::Routing::Port::SetPosition ( const NXOpen::Point3d position) [virtual]

Sets the current location of the object in ABS coordinates.

This value is overridden by the coordinates of the point associated with this object.
Created in NX4.0.0.

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

Parameters:
positionNew location of object in ABS coordinates

Implements NXOpen::Routing::IRoutePosition.

void NXOpen::Routing::Port::SetReferenceCharacteristic ( const NXString name,
const NXString value 
)

Sets a reference characteristics on the port.


Created in NX5.0.0.

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

Parameters:
name
NOTE: The full Unicode character set is not supported for this parameter.
value
NOTE: The full Unicode character set is not supported for this parameter.

Unlocks the port engagement
Created in NX5.0.0.



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

Parameters:
portToUnlockporttounlock

Unlocks the port rotation
Created in NX5.0.0.



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

Parameters:
portToUnlockporttounlock

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