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	CreateRotationVector { CreateRotationVectorNo, CreateRotationVectorYes }
	Used by NXOpen::Routing::FittingPortCollection::CreateFromCsys and Routing::FixturePortCollection::CreateFromCsys to determine if the rotation vector on the port should be created. More...

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

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

NXOpen::Features::WaveRouting *	AskWaveFeature ()
	Ask NXOpen::Features::WaveRouting object associated with this NXOpen::Routing::Port . More...

double	BackwardExtension ()
	Returns the backward extension value for a port (i.e. More...

NXOpen::Expression *	BackwardExtensionObject ()
	Returns the backward extension object for a port. More...

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

NXOpen::Routing::PortConnection *	Connect ()
	Finds another NXOpen::Routing::Port to connect this port to. More...

virtual void	DeleteCharacterstics (NXOpen::Routing::CharacteristicList *values)
	Removes the input list of characteristics from this object. More...

void	Disconnect ()
	Deletes any NXOpen::Routing::PortConnection objects that reference this port. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

NXOpen::Vector3d	GetAlignmentVector ()
	Retrieves the alignment vector of Port. More...

virtual NXOpen::Routing::CharacteristicList *	GetCharacteristics ()
	Get all of the characteristics values on the this object. More...

double	GetClockIncrement ()
	The clock angle increment value of NXOpen::Routing::Port. More...

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

void	GetConnectedPorts (NXOpen::Routing::Port connectedPort1, NXOpen::Routing::Port connectedPort2)
	If port is connected to another port, returns both connected ports. More...

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

double	GetCutbackLength ()
	Returns the cutback length of a port, i.e. More...

virtual NXOpen::Routing::CharacteristicList *	GetDestinationCharacteristics ()
	Returns the destination characteristics from the input object. More...

double	GetEngagement ()
	Returns the engagement distance of a port, i.e. More...

NXOpen::Point3d	GetEngagementPosition ()
	Returns the position of the port taking into account the engagement distance. More...

NXOpen::Routing::Port::FlowDirectionType	GetFlowDirection ()
	Get the value of flow direction of NXOpen::Routing::Port. More...

double	GetForwardExtension ()
	Returns the forward extension value for a port i.e. More...

NXOpen::Expression *	GetForwardExtensionObject ()
	Returns the forward extension object for a port. More...

virtual int	GetIntegerCharacteristic (const NXString &name)
	Get the value of an integer characteristic associated with the input name. More...

virtual int	GetIntegerCharacteristic (const char *name)
	Get the value of an integer characteristic associated with the input name. More...

NXOpen::NXObject *	GetOccurrence ()
	Returns the occurrence of the given port. More...

NXOpen::Routing::PortConnection *	GetPortConnection ()
	If port is connected to another port, returns the Port Connection that links them. More...

NXOpen::Routing::Port::PortType	GetPortType ()
	Get the type of Port. More...

virtual double	GetRealCharacteristic (const NXString &name)
	Get the value of a real characteristic associated with the input name. More...

virtual double	GetRealCharacteristic (const char *name)
	Get the value of a real characteristic associated with the input name. More...

NXString	GetReferenceCharacteristic (const NXString &name)
	Gets a reference characteristic from the port. More...

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

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

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

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. More...

NXOpen::Routing::Stock *	GetStockOfPort ()
	For a Routing::StockPort , returns the Routing::Stock to which this port is attached, if any. More...

virtual NXString	GetStringCharacteristic (const NXString &name)
	Get the value of a string characteristic associated with the input name. More...

virtual NXString	GetStringCharacteristic (const char *name)
	Get the value of a string characteristic associated with the input name. More...

bool	IsEngagementLocked (NXOpen::Routing::Port *portToCheck)
	Checks to see if ports are engaged. More...

bool	IsRotationLocked (NXOpen::Routing::Port *portToCheck)
	Checks if ports have their rotation vectors locked. More...

std::vector < NXOpen::Positioning::Constraint * >	LockEngagement (NXOpen::Routing::Port *portToLock)
	Locks the port engagement using dcm3 constraints. More...

std::vector < NXOpen::Positioning::Constraint * >	LockRotation (NXOpen::Routing::Port *portToLock)
	Locks the port rotation vector using dcm3 constraints. More...

virtual NXOpen::Point *	Point ()
	Returns the NXOpen::Point that specifies the location of the NXOpen::Routing::IRoutePosition object. More...

virtual NXOpen::Point3d	Position ()
	Returns the current location of the object in ABS coordinates. More...

void	ReorderFeature ()
	Reorders the NXOpen::Routing::FeaturePort object associated with NXOpen::Routing::Port after all of the features on which the port feature depends. More...

void	SetAllowMultipleConnections (bool allowMultipleConnections)
	Sets the Allow Multiple Connections property for a NXOpen::Routing::Port . More...

void	SetBackwardExtension (double extension)
	Sets the backward extension value for a port (i.e. More...

void	SetBackwardExtensionObject (NXOpen::Expression *backwardExtension)
	Sets the backward extension object for a port. More...

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. More...

virtual 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. More...

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. More...

virtual 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. More...

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. More...

virtual 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. More...

virtual void	SetCharacteristic2 (const NXString &title, int value)
	Sets or creates an integer type attribute associated with the input title. More...

virtual void	SetCharacteristic2 (const char *title, int value)
	Sets or creates an integer type attribute associated with the input title. More...

virtual void	SetCharacteristic2 (const NXString &title, double value)
	Sets or creates a double type attribute associated with the input title. More...

virtual void	SetCharacteristic2 (const char *title, double value)
	Sets or creates a double type attribute associated with the input title. More...

virtual void	SetCharacteristic2 (const NXString &title, const NXString &value)
	Sets or creates a string type type attribute associated with the input title. More...

virtual void	SetCharacteristic2 (const char title, const char value)
	Sets or creates a string type type attribute associated with the input title. More...

virtual void	SetCharacteristics (NXOpen::Routing::CharacteristicList *values)
	Set all of the characteristics values on this object. More...

virtual void	SetCharacteristics2 (NXOpen::Routing::CharacteristicList *values)
	Sets all attributes associated with the titles from the input list, creating new attributes for the ones that don't exist already. More...

void	SetClockIncrement (double increment)
	The clock angle increment value of NXOpen::Routing::Port Created in NX4.0.0. More...

void	SetClockIncrementObject (NXOpen::Expression *increment)
	Sets the clock angle increment expression of a NXOpen::Routing::Port , i.e. More...

void	SetFlowDirection (NXOpen::Routing::Port::FlowDirectionType flowDirection)
	Set the flow direction value of NXOpen::Routing::Port Created in NX5.0.0. More...

virtual void	SetPoint (NXOpen::Point *point)
	Sets the NXOpen::Point that specifies the location of the NXOpen::Routing::IRoutePosition object. More...

virtual void	SetPosition (const NXOpen::Point3d &position)
	Sets the current location of the object in ABS coordinates. More...

void	SetReferenceCharacteristic (const NXString &name, const NXString &value)
	Sets a reference characteristics on the port. More...

void	SetReferenceCharacteristic (const char name, const char value)
	Sets a reference characteristics on the port. More...

void	UnlockEngagement (NXOpen::Routing::Port *portToUnlock)
	Unlocks the port engagement Created in NX5.0.0. More...

void	UnlockRotation (NXOpen::Routing::Port *portToUnlock)
	Unlocks the port rotation Created in NX5.0.0. More...

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

void	ProtectFromDelete ()
	Protects the SmartObject from being deleted if any referencing objects are deleted. More...

void	ReleaseDeleteProtection ()
	Removes delete protection from the SmartObject. More...

void	RemoveParameters ()
	Removes the smart object parameters. More...

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

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

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

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

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

int	Color ()
	Returns the color of the object. More...

void	Highlight ()
	Highlights the object. More...

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

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

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

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

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

void	RedisplayObject ()
	Redisplays the object in all views. More...

void	RemoveViewDependency ()
	Remove dependency on all views from an object. More...

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

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

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

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

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

void	Unblank ()
	Unblanks the object. More...

void	Unhighlight ()
	Unhighlights the object. More...

Public Member Functions inherited from NXOpen::NXObject
NXOpen::AttributeIterator *	CreateAttributeIterator ()
	Create an attribute iterator. More...

void	DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type)
	Deletes all attributes of a specific type. More...

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

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

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

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. More...

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. More...

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. More...

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. More...

void	DeleteUserAttributes (NXOpen::AttributeIterator *iterator, NXOpen::Update::Option option)
	Deletes the attributes on the object, if any, that satisfy the given iterator Created in NX8.0.0. More...

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

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

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

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

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

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

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

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

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

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

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

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

bool	GetNextUserAttribute (NXOpen::AttributeIterator iterator, NXOpen::NXObject::AttributeInformation info)
	Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More...

NXString	GetPdmReferenceAttributeValue (const NXString &attributeTitle)
	Gets the value of PDM Reference attribute for given object. More...

NXString	GetPdmReferenceAttributeValue (const char *attributeTitle)
	Gets the value of PDM Reference attribute for given object. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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. More...

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. More...

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttribute (const NXString &title, bool includeUnset, bool addStringValues, NXOpen::NXObject::AttributeType type)
	Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttribute (const char *title, bool includeUnset, bool addStringValues, NXOpen::NXObject::AttributeType type)
	Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...

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. More...

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. More...

int	GetUserAttributeCount (NXOpen::AttributeIterator *iterator)
	Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...

int	GetUserAttributeCount (NXOpen::AttributeIterator *iterator, bool countArrayAsOneAttribute)
	Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...

int	GetUserAttributeCount (NXOpen::NXObject::AttributeType type)
	Gets the count of set attributes on the object, if any, of the given type. More...

int	GetUserAttributeCount (NXOpen::NXObject::AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
	Gets the count of attributes on the object, if any, of the given type. More...

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

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

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (NXOpen::AttributeIterator *iterator)
	Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. More...

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

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset)
	Gets all the attributes of the given object. More...

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset, bool addStringValues)
	Gets all the attributes of the given object. More...

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

int	GetUserAttributeSize (const NXString &title, NXOpen::NXObject::AttributeType type)
	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...

int	GetUserAttributeSize (const char *title, NXOpen::NXObject::AttributeType type)
	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...

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

bool	HasUserAttribute (NXOpen::AttributeIterator *iterator)
	Determines if an attribute exists on the object, that satisfies the given iterator. More...

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 Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...

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 Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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. More...

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. More...

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

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

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

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

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. More...

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. More...

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

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

void	SetPdmReferenceAttribute (const NXString &attributeTitle, const NXString &attributeValue)
	Sets the value of PDM Reference attribute on the object. More...

void	SetPdmReferenceAttribute (const char attributeTitle, const char attributeValue)
	Sets the value of PDM Reference attribute on the object. More...

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

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

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. More...

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. More...

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

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

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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

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

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

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

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

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::CreateRotationVector

Used by NXOpen::Routing::FittingPortCollection::CreateFromCsys and Routing::FixturePortCollection::CreateFromCsys to determine if the rotation vector on the port should be created.

Enumerator
CreateRotationVectorNo	Do not create the rotation vector on the port created from a coordinate system.
CreateRotationVectorYes	Create the rotation vector on the port created from a coordinate system.

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

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

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

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

Returns NULL if the port was created in preNX6 release and not converted to NXOpen::Routing::FeaturePort or the port is a WAVE-linked port. To convert NXOpen::Routing::Port object to NXOpen::Routing::FeaturePort object use Routing::PortCollection::ConvertToFeatures .

Returns: Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Features::WaveRouting* NXOpen::Routing::Port::AskWaveFeature ( )

Ask NXOpen::Features::WaveRouting object associated with this NXOpen::Routing::Port .

Returns NULL if the port is not WAVE-linked.

Returns: Created in NX11.0.1.

License requirements : routing_base ("Routing Basic")

double NXOpen::Routing::Port::BackwardExtension ( )

Returns the backward extension value for a port (i.e.

the minimum length that a segment must remain straight going into the back of a NXOpen::Routing::Port )
Created in NX11.0.1.

License requirements : routing_base ("Routing Basic")

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

Returns the backward extension object for a port.

Created in NX11.0.1.

License requirements : routing_base ("Routing Basic")

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

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

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

License requirements : routing_base ("Routing Basic")

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

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

Builds a NXOpen::Routing::PortConnection object if a connectable port is found. See Routing::PortConnectionCollection::CanPortsConnect . Does nothing if this port already has a NXOpen::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 NXOpen::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.

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name name

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.

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name name

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.

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name name

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.

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name name

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.

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name name

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.

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name name

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

Returns: Created in NX8.0.3.

License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::Port::GetConnectedPorts	(	NXOpen::Routing::Port **	connectedPort1,
		NXOpen::Routing::Port **	connectedPort2
	)

If port is connected to another port, returns both connected ports.

Returns NULL otherwise.
Created in NX10.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

connectedPort1	connectedport1
connectedPort2	connectedport2

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

Returns the Routing::ControlPoint to which this port is constrained, if any.

Returns NULL otherwise.

Returns: 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

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_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::Point3d NXOpen::Routing::Port::GetEngagementPosition ( )

Returns the position of the port taking into account the engagement distance.

Returns: Location of engagement position in ABS coordinates
Created in NX11.0.1.

License requirements : routing_base ("Routing Basic")

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

Get the value of flow direction of NXOpen::Routing::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 NXOpen::Routing::Port

Returns: Port extension
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

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

Returns the forward extension object for a port.

Returns: Forward Extension Expression.
Created in NX11.0.1.

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 name

Implements NXOpen::Routing::ICharacteristic.

virtual int NXOpen::Routing::Port::GetIntegerCharacteristic ( const char * 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 name

Implements NXOpen::Routing::ICharacteristic.

NXOpen::NXObject* NXOpen::Routing::Port::GetOccurrence ( )

Returns the occurrence of the given port.

If the given port is a port extract, uses the port extract data to find the source occurrence. Only establishes an occurrence if the extract xform and the source (prototype) port are loaded. Returns a NULL otherwise.

Given any other port, tries to find an occurrence under the work occurrence.

Returns: Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

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

If port is connected to another port, returns the Port Connection that links them.

Returns NULL otherwise.

Returns: Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

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 name

Implements NXOpen::Routing::ICharacteristic.

virtual double NXOpen::Routing::Port::GetRealCharacteristic ( const char * 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 name

Implements NXOpen::Routing::ICharacteristic.

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 name

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 name

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

NXOpen::Routing::Stock* NXOpen::Routing::Port::GetStockOfPort ( )

For a Routing::StockPort , returns the Routing::Stock to which this port is attached, if any.

Returns NULL otherwise for all other types of ports.

Returns: Created in NX11.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 name

Implements NXOpen::Routing::ICharacteristic.

virtual NXString NXOpen::Routing::Port::GetStringCharacteristic ( const char * 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 name

Implements NXOpen::Routing::ICharacteristic.

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 NXOpen::Point that specifies the location of the NXOpen::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 NXOpen::Routing::FeaturePort object associated with NXOpen::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 NXOpen::Routing::FeaturePort . To convert NXOpen::Routing::Port object to NXOpen::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 NXOpen::Routing::Port .

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

Parameters

allowMultipleConnections Should the multiport allow multiple connections?

void NXOpen::Routing::Port::SetBackwardExtension ( double extension )

Sets the backward extension value for a port (i.e.

the minimum length that a segment must remain straight going into the back of a NXOpen::Routing::Port )
Created in NX11.0.1.

License requirements : routing_base ("Routing Basic")

Parameters

extension Port extension

void NXOpen::Routing::Port::SetBackwardExtensionObject ( NXOpen::Expression * backwardExtension )

Sets the backward extension object for a port.

Created in NX11.0.1.

License requirements : routing_base ("Routing Basic")

Parameters

backwardExtension Backward Extension Expression.

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.

Deprecated:: Deprecated in NX11.0.0. Use NXOpen::Routing::ICharacteristic::SetCharacteristic2 instead.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name	name
value	value

Implements NXOpen::Routing::ICharacteristic.

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

Deprecated:: Deprecated in NX11.0.0. Use NXOpen::Routing::ICharacteristic::SetCharacteristic2 instead.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name	name
value	value

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.

Deprecated:: Deprecated in NX11.0.0. Use NXOpen::Routing::ICharacteristic::SetCharacteristic2 instead.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name	name
value	value

Implements NXOpen::Routing::ICharacteristic.

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

Deprecated:: Deprecated in NX11.0.0. Use NXOpen::Routing::ICharacteristic::SetCharacteristic2 instead.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name	name
value	value

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.

Deprecated:: Deprecated in NX11.0.0. Use NXOpen::Routing::ICharacteristic::SetCharacteristic2 instead.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name	name
value	value

Implements NXOpen::Routing::ICharacteristic.

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

Deprecated:: Deprecated in NX11.0.0. Use NXOpen::Routing::ICharacteristic::SetCharacteristic2 instead.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name	name
value	value

Implements NXOpen::Routing::ICharacteristic.

virtual void NXOpen::Routing::Port::SetCharacteristic2	(	const NXString &	title,
		int	value
	)

virtual

Sets or creates an integer type attribute associated with the input title.

creating a new attribute if one doesn't exist already.

If the method is called on a stock Assemblies::Component , the method will create or edit a part attribute on the stock part. For legacy parts where the attribute is on the stock component, the attribute will be moved to the stock part.

If the method is called on a non-stock Assemblies::Component , the method will create or edit an attribute on the corresponding instance. For legacy parts where the attribute is on the component, the attribute will be moved to the corresponding instance.

If the method is called on any non-component object, the method will access or create an attribute on the object itself.
Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

title	Unique title for the Attribute or Characteristic
value	New Value to be set on the Attribute

Implements NXOpen::Routing::ICharacteristic.

virtual void NXOpen::Routing::Port::SetCharacteristic2	(	const char *	title,
		int	value
	)

virtual

Sets or creates an integer type attribute associated with the input title.

creating a new attribute if one doesn't exist already.

If the method is called on a stock Assemblies::Component , the method will create or edit a part attribute on the stock part. For legacy parts where the attribute is on the stock component, the attribute will be moved to the stock part.

If the method is called on a non-stock Assemblies::Component , the method will create or edit an attribute on the corresponding instance. For legacy parts where the attribute is on the component, the attribute will be moved to the corresponding instance.

If the method is called on any non-component object, the method will access or create an attribute on the object itself.
Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

title	Unique title for the Attribute or Characteristic
value	New Value to be set on the Attribute

Implements NXOpen::Routing::ICharacteristic.

virtual void NXOpen::Routing::Port::SetCharacteristic2	(	const NXString &	title,
		double	value
	)

virtual

Sets or creates a double type attribute associated with the input title.

creating a new attribute if one doesn't exist already.

If the method is called on a stock Assemblies::Component , the method will create or edit a part attribute on the stock part. For legacy parts where the attribute is on the stock component, the attribute will be moved to the stock part.

If the method is called on a non-stock Assemblies::Component , the method will create or edit an attribute on the corresponding instance. For legacy parts where the attribute is on the component, the attribute will be moved to the corresponding instance.

If the method is called on any non-component object, the method will access or create an attribute on the object itself.
Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

title	Unique title for the Attribute or Characteristic
value	New Value to be set on the Attribute

Implements NXOpen::Routing::ICharacteristic.

virtual void NXOpen::Routing::Port::SetCharacteristic2	(	const char *	title,
		double	value
	)

virtual

Sets or creates a double type attribute associated with the input title.

creating a new attribute if one doesn't exist already.

If the method is called on a stock Assemblies::Component , the method will create or edit a part attribute on the stock part. For legacy parts where the attribute is on the stock component, the attribute will be moved to the stock part.

If the method is called on a non-stock Assemblies::Component , the method will create or edit an attribute on the corresponding instance. For legacy parts where the attribute is on the component, the attribute will be moved to the corresponding instance.

If the method is called on any non-component object, the method will access or create an attribute on the object itself.
Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

title	Unique title for the Attribute or Characteristic
value	New Value to be set on the Attribute

Implements NXOpen::Routing::ICharacteristic.

virtual void NXOpen::Routing::Port::SetCharacteristic2	(	const NXString &	title,
		const NXString &	value
	)

virtual

Sets or creates a string type type attribute associated with the input title.

creating a new attribute if one doesn't exist already.

If the method is called on a stock Assemblies::Component , the method will create or edit a part attribute on the stock part. For legacy parts where the attribute is on the stock component, the attribute will be moved to the stock part.

If the method is called on a non-stock Assemblies::Component , the method will create or edit an attribute on the corresponding instance. For legacy parts where the attribute is on the component, the attribute will be moved to the corresponding instance.

If the method is called on any non-component object, the method will access or create an attribute on the object itself.
Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

title	Unique title for the Attribute or Characteristic
value	New Value to be set on the Attribute

Implements NXOpen::Routing::ICharacteristic.

virtual void NXOpen::Routing::Port::SetCharacteristic2	(	const char *	title,
		const char *	value
	)

virtual

Sets or creates a string type type attribute associated with the input title.

creating a new attribute if one doesn't exist already.

If the method is called on a stock Assemblies::Component , the method will create or edit a part attribute on the stock part. For legacy parts where the attribute is on the stock component, the attribute will be moved to the stock part.

If the method is called on a non-stock Assemblies::Component , the method will create or edit an attribute on the corresponding instance. For legacy parts where the attribute is on the component, the attribute will be moved to the corresponding instance.

If the method is called on any non-component object, the method will access or create an attribute on the object itself.
Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

title	Unique title for the Attribute or Characteristic
value	New Value to be set on the Attribute

Implements NXOpen::Routing::ICharacteristic.

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

virtual

Set all of the characteristics values on this object.

Deprecated:: Deprecated in NX11.0.0. Use NXOpen::Routing::ICharacteristic::SetCharacteristics2 instead.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

values values

Implements NXOpen::Routing::ICharacteristic.

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

virtual

Sets all attributes associated with the titles from the input list, creating new attributes for the ones that don't exist already.

If the method is called on a stock Assemblies::Component , the method will create or edit part attributes on the stock part. For legacy parts where the attributes are on the stock component, the attributes will be moved to the stock part.

If the method is called on a non-stock Assemblies::Component , the method will create or edit attributes on the corresponding instance. For legacy parts where the attribute is on the component, the attributes will be moved to the corresponding instance.

If the method is called on any non-component object, the method will access or create attributes on the object itself.
Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

values NXOpen::Routing::CharacteristicList having the titles, types and values of Attributes to be set

Implements NXOpen::Routing::ICharacteristic.

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

The clock angle increment value of NXOpen::Routing::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 NXOpen::Routing::Port , i.e.

an expression representing the minimum angle for clocking the NXOpen::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 NXOpen::Routing::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 NXOpen::Point that specifies the location of the NXOpen::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	name
value	value

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	name
value	value

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