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:

Public Types
enum	FlowDirectionType { FlowDirectionTypeRouteFlowEither, FlowDirectionTypeRouteFlowIn, FlowDirectionTypeRouteFlowOut, FlowDirectionTypeFlowNone }
	Allowed types for flow direction. More...

enum	PortType { PortTypeUnknownPort, PortTypeFittingPort, PortTypeFixturePort, PortTypeMultiPort, PortTypeTerminalPort, PortTypeStockPort, PortTypeStockOffsetPort }
	Specifies the port type. More...

Public Types inherited from NXOpen::SmartObject
enum	UpdateOption { UpdateOptionDontUpdate, UpdateOptionWithinModeling, UpdateOptionAfterModeling, UpdateOptionAfterParentBody, UpdateOptionMixed }
	Specifies when the smart object updates. More...

enum	VisibilityOption { VisibilityOptionInvisible, VisibilityOptionVisible, VisibilityOptionVisibleIfParentInvisible }
	Specifies the smart object visibility. More...

Public Types inherited from NXOpen::DisplayableObject
enum	ObjectFont { ObjectFontSolid = 1, ObjectFontDashed, ObjectFontPhantom, ObjectFontCenterline, ObjectFontDotted, ObjectFontLongDashed, ObjectFontDottedDashed }
	specifies the object font for objects such as lines Created in NX3.0.0. More...

enum	ObjectWidth { ObjectWidthNormal, ObjectWidthThick, ObjectWidthThin, ObjectWidthOne = 5, ObjectWidthTwo, ObjectWidthThree, ObjectWidthFour, ObjectWidthFive, ObjectWidthSix, ObjectWidthSeven, ObjectWidthEight, ObjectWidthNine }
	specifies object width for objects such as lines and text Created in NX3.0.0. More...

Public Types inherited from NXOpen::NXObject
enum	AttributeType { AttributeTypeInvalid, AttributeTypeNull, AttributeTypeBoolean, AttributeTypeInteger, AttributeTypeReal, AttributeTypeString, AttributeTypeTime, AttributeTypeReference, AttributeTypeAny = 100 }
	Specifies attribute type. More...

enum	DateAndTimeFormat { DateAndTimeFormatNumeric, DateAndTimeFormatTextual }
	Specifies the format of the date and time attribute. More...

Public Member Functions
bool	AllowMultipleConnections ()
	Returns the Allow Multiple Connections property for a Routing::Port .

NXOpen::Routing::FeaturePort *	AskFeature ()
	Ask Routing::FeaturePort object associated with Routing::Port .

NXOpen::Expression *	ClockIncrementObject ()
	Returns the clock angle increment expression of a Routing::Port , i.e.

NXOpen::Routing::PortConnection *	Connect ()
	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.

int	FindPortIntegerCharacteristic (const char *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.

double	FindPortRealCharacteristic (const char *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.

NXString	FindPortStringCharacteristic (const char *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.

NXOpen::Assemblies::Component *	GetComponent ()
	If this port is an occurrence, returns the component part to which it belongs.

NXOpen::Routing::ControlPoint *	GetControlPoint ()
	Returns the Control Point to which this port is constrained, if any.

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.

int	GetIntegerCharacteristic (const char *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.

double	GetRealCharacteristic (const char *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.

NXString	GetReferenceCharacteristic (const char *name)
	Gets a reference characteristic from the port.

NXOpen::DisplayableObject *	GetRotationObject ()
	Retrieves the object used to derive the rotation vector of Port.

NXOpen::Vector3d	GetRotationVector ()
	Retrieves the rotation vector of Port.

NXOpen::Routing::ISegment *	GetSegment ()
	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.

NXString	GetStringCharacteristic (const char *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::Point *	Point ()
	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.

void	SetCharacteristic (const char *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.

void	SetCharacteristic (const char *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.

void	SetCharacteristic (const char name, const char 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	SetReferenceCharacteristic (const char name, const char 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.

Public Member Functions inherited from NXOpen::SmartObject
void	Evaluate ()
	Evaluate a smart object.

void	RemoveParameters ()
	Removes the smart object parameters.

void	ReplaceParameters (NXOpen::SmartObject *otherSo)
	Edit a smart object by replacing its parameters using parameters of other smart object of the same class.

void	SetVisibility (NXOpen::SmartObject::VisibilityOption visibility)
	Sets the visibility.

NXOpen::SmartObject::UpdateOption	Update ()
	Returns the update option.

NXOpen::SmartObject::VisibilityOption	Visibility ()
	Returns the visibility.

Public Member Functions inherited from NXOpen::DisplayableObject
void	Blank ()
	Blanks the object.

int	Color ()
	Returns the color of the object.

void	Highlight ()
	Highlights the object.

bool	IsBlanked ()
	Returns the blank status of this object.

int	Layer ()
	Returns the layer that the object is in.

NXOpen::DisplayableObject::ObjectFont	LineFont ()
	Returns the line font of the object.

NXOpen::DisplayableObject::ObjectWidth	LineWidth ()
	Returns the line width of the object.

NXOpen::Point3d	NameLocation ()
	Returns the location of the object's name.

void	RedisplayObject ()
	Redisplays the object in all views.

void	SetColor (int color)
	Sets the color of the object.

void	SetLayer (int layer)
	Sets the layer that the object is in.

void	SetLineFont (NXOpen::DisplayableObject::ObjectFont font)
	Sets the line font of the object.

void	SetLineWidth (NXOpen::DisplayableObject::ObjectWidth width)
	Sets the line width of the object.

void	SetNameLocation (const NXOpen::Point3d &location)
	Sets the location of the object's name.

void	Unblank ()
	Unblanks the object.

void	Unhighlight ()
	Unhighlights the object.

Public Member Functions inherited from NXOpen::NXObject
void	DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type)
	Deletes all attributes of a specific type.

void	DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
	Deletes all attributes of a specific type with the option to update or not.

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title)
	Deletes an attribute by type and title.

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title)
	Deletes an attribute by type and title.

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title, NXOpen::Update::Option option)
	Deletes an attribute by type and title with the option to update or not.

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title, NXOpen::Update::Option option)
	Deletes an attribute by type and title with the option to update or not.

void	DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const NXString &title, bool deleteEntireArray, NXOpen::Update::Option option)
	Deletes the first attribute encountered with the given Type, Title and Index.

void	DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const char *title, bool deleteEntireArray, NXOpen::Update::Option option)
	Deletes the first attribute encountered with the given Type, Title and Index.

void	DeleteUserAttributes (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
	Deletes the attributes encountered with the given Type with option to update or not.

virtual NXOpen::INXObject *	FindObject (const NXString &journalIdentifier)
	Finds the NXObject with the given identifier as recorded in a journal.

NXOpen::INXObject *	FindObject (const char *journalIdentifier)
	Finds the NXObject with the given identifier as recorded in a journal.

std::vector < NXOpen::NXObject::AttributeInformation >	GetAttributeTitlesByType (NXOpen::NXObject::AttributeType type)
	Gets all the attribute titles of a specific type.

bool	GetBooleanUserAttribute (const NXString &title, int index)
	Gets a boolean attribute by Title and array Index.

bool	GetBooleanUserAttribute (const char *title, int index)
	Gets a boolean attribute by Title and array Index.

NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const NXString &title, int index)
	Gets a time attribute by Title and array Index.

NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const char *title, int index)
	Gets a time attribute by Title and array Index.

int	GetIntegerAttribute (const NXString &title)
	Gets an integer attribute by title.

int	GetIntegerAttribute (const char *title)
	Gets an integer attribute by title.

int	GetIntegerUserAttribute (const NXString &title, int index)
	Gets an integer attribute by Title and array Index.

int	GetIntegerUserAttribute (const char *title, int index)
	Gets an integer attribute by Title and array Index.

double	GetRealAttribute (const NXString &title)
	Gets a real attribute by title.

double	GetRealAttribute (const char *title)
	Gets a real attribute by title.

double	GetRealUserAttribute (const NXString &title, int index)
	Gets a real attribute by Title and array Index.

double	GetRealUserAttribute (const char *title, int index)
	Gets a real attribute by Title and array Index.

NXString	GetReferenceAttribute (const NXString &title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string.

NXString	GetReferenceAttribute (const char *title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string.

NXString	GetStringAttribute (const NXString &title)
	Gets a string attribute value by title.

NXString	GetStringAttribute (const char *title)
	Gets a string attribute value by title.

NXString	GetStringUserAttribute (const NXString &title, int index)
	Gets a string attribute by Title and array Index.

NXString	GetStringUserAttribute (const char *title, int index)
	Gets a string attribute by Title and array Index.

NXString	GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const NXString &title)
	Gets a time attribute by title.

NXString	GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const char *title)
	Gets a time attribute by title.

NXString	GetTimeUserAttribute (const NXString &title, int index)
	Gets a time attribute by Title and array Index.

NXString	GetTimeUserAttribute (const char *title, int index)
	Gets a time attribute by Title and array Index.

NXOpen::NXObject::AttributeInformation	GetUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.

NXOpen::NXObject::AttributeInformation	GetUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.

NXString	GetUserAttributeAsString (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given title, type and array index.

NXString	GetUserAttributeAsString (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given title, type and array index.

bool	GetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type)
	Determine the lock of the given attribute.

bool	GetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type)
	Determine the lock of the given attribute.

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes ()
	Gets all the attributes that have been set on the given object.

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset)
	Gets all the attributes that have been set on the given object.

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset, bool addStringValues)
	Gets all the attributes that have been set on the given object.

std::vector< NXString >	GetUserAttributesAsStrings ()
	Gets all the attributes that have been set on the given object.

std::vector< NXOpen::NXObject * >	GetUserAttributeSourceObjects ()
	Returns an array of objects from which this object presents attributes.

bool	HasUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time).

bool	HasUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time).

virtual bool	IsOccurrence ()
	Returns whether this object is an occurrence or not.

virtual NXString	JournalIdentifier ()
	Returns the identifier that would be recorded in a journal for this object.

virtual NXString	Name ()
	Returns the custom name of the object.

virtual NXOpen::Assemblies::Component *	OwningComponent ()
	Returns the owning component, if this object is an occurrence.

virtual NXOpen::BasePart *	OwningPart ()
	Returns the owning part of this object Created in NX3.0.0.

virtual void	Print ()
	Prints a representation of this object to the system log file.

virtual NXOpen::INXObject *	Prototype ()
	Returns the prototype of this object if it is an occurrence.

void	SetAttribute (const NXString &title, int value)
	Creates or modifies an integer attribute.

void	SetAttribute (const char *title, int value)
	Creates or modifies an integer attribute.

void	SetAttribute (const NXString &title, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.

void	SetAttribute (const char *title, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.

void	SetAttribute (const NXString &title, double value)
	Creates or modifies a real attribute.

void	SetAttribute (const char *title, double value)
	Creates or modifies a real attribute.

void	SetAttribute (const NXString &title, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.

void	SetAttribute (const char *title, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.

void	SetAttribute (const NXString &title, const NXString &value)
	Creates or modifies a string attribute.

void	SetAttribute (const char title, const char value)
	Creates or modifies a string attribute.

void	SetAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not.

void	SetAttribute (const char title, const char value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not.

void	SetAttribute (const NXString &title)
	Creates or modifies a null attribute which is an attribute with a title and no value.

void	SetAttribute (const char *title)
	Creates or modifies a null attribute which is an attribute with a title and no value.

void	SetAttribute (const NXString &title, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetAttribute (const char *title, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetBooleanUserAttribute (const NXString &title, int index, bool value, NXOpen::Update::Option option)
	Creates or modifies a boolean attribute with the option to update or not.

void	SetBooleanUserAttribute (const char *title, int index, bool value, NXOpen::Update::Option option)
	Creates or modifies a boolean attribute with the option to update or not.

virtual void	SetName (const NXString &name)
	Sets the custom name of the object.

void	SetName (const char *name)
	Sets the custom name of the object.

void	SetReferenceAttribute (const NXString &title, const NXString &value)
	Creates or modifies a string attribute which uses a reference string.

void	SetReferenceAttribute (const char title, const char value)
	Creates or modifies a string attribute which uses a reference string.

void	SetReferenceAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute which uses a reference string, with the option to update or not.

void	SetReferenceAttribute (const char title, const char value, NXOpen::Update::Option option)
	Creates or modifies a string attribute which uses a reference string, with the option to update or not.

void	SetTimeAttribute (const NXString &title, const NXString &value)
	Creates or modifies a time attribute.

void	SetTimeAttribute (const char title, const char value)
	Creates or modifies a time attribute.

void	SetTimeAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeAttribute (const char title, const char value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeUserAttribute (const char title, int index, const char value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeUserAttribute (const NXString &title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeUserAttribute (const char *title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetUserAttribute (const NXOpen::NXObject::AttributeInformation &info, NXOpen::Update::Option option)
	Creates or modifies an attribute with the option to update or not.

void	SetUserAttribute (const NXString &title, int index, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.

void	SetUserAttribute (const char *title, int index, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.

void	SetUserAttribute (const NXString &title, int index, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.

void	SetUserAttribute (const char *title, int index, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.

void	SetUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not.

void	SetUserAttribute (const char title, int index, const char value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not.

void	SetUserAttribute (const NXString &title, int index, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetUserAttribute (const char *title, int index, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock)
	Lock or unlock the given attribute.

void	SetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type, bool lock)
	Lock or unlock the given attribute.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Public Member Functions inherited from NXOpen::INXObject
NXOpen::INXObject *	FindObject (const char *journalIdentifier)
	Finds the NXObject with the given identifier as recorded in a journal.

void	SetName (const char *name)
	Sets the custom name of the object.

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

enum NXOpen::Routing::Port::FlowDirectionType

Allowed types for flow direction.

Enumerator:

FlowDirectionTypeRouteFlowEither	route flow either
FlowDirectionTypeRouteFlowIn	route flow in
FlowDirectionTypeRouteFlowOut	route flow out
FlowDirectionTypeFlowNone	flow none

enum NXOpen::Routing::Port::PortType

Specifies the port type.

Enumerator:

PortTypeUnknownPort	Unknown Port.
PortTypeFittingPort	Fitting Port.
PortTypeFixturePort	Fixture Port.
PortTypeMultiPort	Multi Port.
PortTypeTerminalPort	Terminal Port.
PortTypeStockPort	Stock Port.
PortTypeStockOffsetPort	Stock Offset Port.

Member Function Documentation

bool NXOpen::Routing::Port::AllowMultipleConnections ( )

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

       The property controls the number of connections that can be routed to this
       @link Routing::Port Routing::Port@endlink .  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_base ("Routing Basic")

NXOpen::Routing::FeaturePort* NXOpen::Routing::Port::AskFeature ( )

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_base ("Routing Basic")

NXOpen::Expression* NXOpen::Routing::Port::ClockIncrementObject ( )

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_base ("Routing Basic")

NXOpen::Routing::PortConnection* NXOpen::Routing::Port::Connect ( )

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_base ("Routing Basic")

virtual void NXOpen::Routing::Port::DeleteCharacterstics ( NXOpen::Routing::CharacteristicList * values )

virtual

Removes the input list of characteristics from this object.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

values values

Implements NXOpen::Routing::ICharacteristic.

void NXOpen::Routing::Port::Disconnect ( )

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

Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

int NXOpen::Routing::Port::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.

@return

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

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

int NXOpen::Routing::Port::FindPortIntegerCharacteristic ( const char * name )

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

@return

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

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

double NXOpen::Routing::Port::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.

@return

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

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

double NXOpen::Routing::Port::FindPortRealCharacteristic ( const char * name )

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

@return

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

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

NXString NXOpen::Routing::Port::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.

@return

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

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

NXString NXOpen::Routing::Port::FindPortStringCharacteristic ( const char * name )

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

@return

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

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

NXOpen::Vector3d NXOpen::Routing::Port::GetAlignmentVector ( )

Retrieves the alignment vector of Port.

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

License requirements : routing_base ("Routing Basic")

virtual NXOpen::Routing::CharacteristicList* NXOpen::Routing::Port::GetCharacteristics ( )

virtual

Get all of the characteristics values on the this object.

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Implements NXOpen::Routing::ICharacteristic.

double NXOpen::Routing::Port::GetClockIncrement ( )

The clock angle increment value of Port.

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

License requirements : routing_base ("Routing Basic")

NXOpen::Assemblies::Component* NXOpen::Routing::Port::GetComponent ( )

If this port is an occurrence, returns the component part to which it belongs.

       Returns NULL otherwise.  @return

Created in NX8.0.3.

License requirements : routing_base ("Routing Basic")

NXOpen::Routing::ControlPoint* NXOpen::Routing::Port::GetControlPoint ( )

Returns the Control Point to which this port is constrained, if any.

       Returns NULL otherwise.  @return

Created in NX8.0.3.

License requirements : routing_base ("Routing Basic")

double NXOpen::Routing::Port::GetCutbackLength ( )

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_base ("Routing Basic")

virtual NXOpen::Routing::CharacteristicList* NXOpen::Routing::Port::GetDestinationCharacteristics ( )

virtual

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
         <ul>
             <li>Ports: Reads characteristics from the port.</li>
             <li>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.</li>
             <li>Segments: Reads characteristics from the stock associated with the segment.</li>
             <li>Components: Reads characteristics directly from the component.</li>
             <li>Stock: Reads characteristics from the stock or from the stock's data.</li>
         </ul>
    @return

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Implements NXOpen::Routing::ICharacteristic.

double NXOpen::Routing::Port::GetEngagement ( )

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_base ("Routing Basic")

NXOpen::Routing::Port::FlowDirectionType NXOpen::Routing::Port::GetFlowDirection ( )

Get the value of flow direction of Port.

Returns: Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

double NXOpen::Routing::Port::GetForwardExtension ( )

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_base ("Routing Basic")

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_base ("Routing Basic")

Parameters

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

Implements NXOpen::Routing::ICharacteristic.

int NXOpen::Routing::Port::GetIntegerCharacteristic ( const char * name )

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

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

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

NXOpen::Routing::Port::PortType NXOpen::Routing::Port::GetPortType ( )

Get the type of Port.

Returns: Port Type
Created in NX7.5.2.

License requirements : routing_base ("Routing Basic")

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_base ("Routing Basic")

Parameters

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

Implements NXOpen::Routing::ICharacteristic.

double NXOpen::Routing::Port::GetRealCharacteristic ( const char * name )

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

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

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

NXString NXOpen::Routing::Port::GetReferenceCharacteristic ( const NXString & name )

Gets a reference characteristic from the port.

Returns: Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

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

NXString NXOpen::Routing::Port::GetReferenceCharacteristic ( const char * name )

Gets a reference characteristic from the port.

Returns: Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

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

NXOpen::DisplayableObject* NXOpen::Routing::Port::GetRotationObject ( )

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_base ("Routing Basic")

NXOpen::Vector3d NXOpen::Routing::Port::GetRotationVector ( )

Retrieves the rotation vector of Port.

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

License requirements : routing_base ("Routing Basic")

NXOpen::Routing::ISegment* NXOpen::Routing::Port::GetSegment ( )

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_base ("Routing Basic")

virtual NXString NXOpen::Routing::Port::GetStringCharacteristic ( const NXString & name )

virtual

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

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

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

Implements NXOpen::Routing::ICharacteristic.

NXString NXOpen::Routing::Port::GetStringCharacteristic ( const char * name )

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

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

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

bool NXOpen::Routing::Port::IsEngagementLocked ( NXOpen::Routing::Port * portToCheck )

Checks to see if ports are engaged.

Returns: Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

portToCheck porttocheck

bool NXOpen::Routing::Port::IsRotationLocked ( NXOpen::Routing::Port * portToCheck )

Checks if ports have their rotation vectors locked.

Returns: Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

portToCheck porttocheck

std::vector<NXOpen::Positioning::Constraint *> NXOpen::Routing::Port::LockEngagement ( NXOpen::Routing::Port * portToLock )

Locks the port engagement using dcm3 constraints.

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

License requirements : routing_base ("Routing Basic")

Parameters

portToLock porttolock

std::vector<NXOpen::Positioning::Constraint *> NXOpen::Routing::Port::LockRotation ( NXOpen::Routing::Port * portToLock )

Locks the port rotation vector using dcm3 constraints.

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

License requirements : routing_base ("Routing Basic")

Parameters

portToLock porttolock

virtual NXOpen::Point* NXOpen::Routing::Port::Point ( )

virtual

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_base ("Routing Basic")

Implements NXOpen::Routing::IRoutePosition.

virtual NXOpen::Point3d NXOpen::Routing::Port::Position ( )

virtual

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_base ("Routing Basic")

Implements NXOpen::Routing::IRoutePosition.

void NXOpen::Routing::Port::ReorderFeature ( )

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_base ("Routing Basic")

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
       @link Routing::Port Routing::Port@endlink .  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_base ("Routing Basic")

Parameters

allowMultipleConnections Should 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_base ("Routing Basic")

Parameters

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

Implements NXOpen::Routing::ICharacteristic.

void NXOpen::Routing::Port::SetCharacteristic	(	const char *	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.

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_base ("Routing Basic")

Parameters

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

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_base ("Routing Basic")

Parameters

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

Implements NXOpen::Routing::ICharacteristic.

void NXOpen::Routing::Port::SetCharacteristic	(	const char *	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.

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_base ("Routing Basic")

Parameters

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

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_base ("Routing Basic")

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.

void NXOpen::Routing::Port::SetCharacteristic	(	const char *	name,
		const char *	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.

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_base ("Routing Basic")

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.

virtual void NXOpen::Routing::Port::SetCharacteristics ( NXOpen::Routing::CharacteristicList * values )

virtual

Set all of the characteristics values on this object.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

values values

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_base ("Routing Basic")

Parameters

increment Clock increment value in degrees

void NXOpen::Routing::Port::SetClockIncrementObject ( NXOpen::Expression * increment )

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_base ("Routing Basic")

Parameters

increment Clock increment expression

void NXOpen::Routing::Port::SetFlowDirection ( NXOpen::Routing::Port::FlowDirectionType flowDirection )

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

License requirements : routing_base ("Routing Basic")

Parameters

flowDirection flow 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_base ("Routing Basic")

Parameters

point New 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_base ("Routing Basic")

Parameters

position New 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_base ("Routing Basic")

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.

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

Sets a reference characteristics on the port.

Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

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.

void NXOpen::Routing::Port::UnlockEngagement ( NXOpen::Routing::Port * portToUnlock )

Unlocks the port engagement
Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

portToUnlock porttounlock

void NXOpen::Routing::Port::UnlockRotation ( NXOpen::Routing::Port * portToUnlock )

Unlocks the port rotation
Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

portToUnlock porttounlock

The documentation for this class was generated from the following file:

Routing_Port.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation