NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Routing::TerminalPort Class Reference

A NXOpen::Routing::TerminalPort models the pins on an electrical connector. More...

Inheritance diagram for NXOpen::Routing::TerminalPort:
NXOpen::Routing::Port NXOpen::Routing::IAxisPort NXOpen::SmartObject NXOpen::Routing::IRoutePosition NXOpen::Routing::IRoutePosition NXOpen::DisplayableObject NXOpen::Routing::ICharacteristic NXOpen::Routing::ICharacteristic NXOpen::NXObject NXOpen::IFitTo NXOpen::INXObject NXOpen::INXObject NXOpen::TaggedObject NXOpen::INXObject NXOpen::INXObject

Public Member Functions

virtual NXOpen::AxisAxis ()
 Returns the axis that defines the port
Created in NX5.0.0. More...
 
virtual NXOpen::ExpressionCutbackLengthObject ()
 Returns the cutback length object of a port, i.e. More...
 
virtual NXOpen::ExpressionEngagementObject ()
 Returns the engagement object of a port, i.e. More...
 
virtual NXOpen::ExpressionForwardExtensionObject ()
 Returns the forward extension object of a port, i.e. More...
 
NXOpen::Routing::MultiPortMultiPort ()
 Returns the parent NXOpen::Routing::MultiPort of the NXOpen::Routing::TerminalPort. More...
 
NXString PinIdentifier ()
 Returns the pin identifier (name) of the NXOpen::Routing::TerminalPort
Created in NX4.0.0. More...
 
virtual void SetAlignVector (const NXOpen::Vector3d &vector)
 Sets the align vector of Port
Created in NX4.0.0. More...
 
virtual void SetAxis (NXOpen::Axis *axis)
 Sets the axis that defines the port
Created in NX5.0.0. More...
 
virtual void SetCutbackLength (double cutbackLength)
 Sets the cutback length of a port, i.e. More...
 
virtual void SetCutbackLengthObject (NXOpen::Expression *cutbackLength)
 Sets the cutback length object of a port, i.e. More...
 
virtual void SetEngagement (double engagement)
 The engagment distance of a NXOpen::Routing::IAxisPort , i.e. More...
 
virtual void SetEngagementObject (NXOpen::Expression *engagement)
 Sets the engagement object of a port, i.e. More...
 
virtual void SetForwardExtension (double forwardExtension)
 Sets the forward extension value of a port, i.e. More...
 
virtual void SetForwardExtensionObject (NXOpen::Expression *forwardExtension)
 Sets the forward extension object of a port, i.e. More...
 
void SetPinIdentifier (const NXString &pinIdentifier)
 Sets the pin identifier (name) of the NXOpen::Routing::TerminalPort
Created in NX4.0.0. More...
 
void SetPinIdentifier (const char *pinIdentifier)
 Sets the pin identifier (name) of the NXOpen::Routing::TerminalPort
Created in NX4.0.0. More...
 
virtual void SetRotationObject (NXOpen::DisplayableObject *rotationObject)
 Sets the object used to derive the rotation vector of Port
Created in NX4.0.0. More...
 
virtual void SetRotationVector (const NXOpen::Vector3d &vector)
 Sets the rotation vector of Port
Created in NX4.0.0. More...
 
- Public Member Functions inherited from NXOpen::Routing::Port
bool AllowMultipleConnections ()
 Returns the Allow Multiple Connections property for a NXOpen::Routing::Port . More...
 
NXOpen::Routing::FeaturePortAskFeature ()
 Ask NXOpen::Routing::FeaturePort object associated with NXOpen::Routing::Port . More...
 
NXOpen::Features::WaveRoutingAskWaveFeature ()
 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::ExpressionBackwardExtensionObject ()
 Returns the backward extension object for a port. More...
 
NXOpen::ExpressionClockIncrementObject ()
 Returns the clock angle increment expression of a NXOpen::Routing::Port , i.e. More...
 
NXOpen::Routing::PortConnectionConnect ()
 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::ComponentGetComponent ()
 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::ControlPointGetControlPoint ()
 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::ExpressionGetForwardExtensionObject ()
 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::NXObjectGetOccurrence ()
 Returns the occurrence of the given port. More...
 
NXOpen::Routing::PortConnectionGetPortConnection ()
 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::DisplayableObjectGetRotationObject ()
 Retrieves the object used to derive the rotation vector of Port. More...
 
NXOpen::Vector3d GetRotationVector ()
 Retrieves the rotation vector of Port. More...
 
NXOpen::Routing::ISegmentGetSegment ()
 Return the segment the port position and alignment are derived from Returns NULL if the port is not derived from segment. More...
 
NXOpen::Routing::StockGetStockOfPort ()
 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::PointPoint ()
 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::AttributeIteratorCreateAttributeIterator ()
 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::INXObjectFindObject (const NXString &journalIdentifier)
 Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...
 
virtual NXOpen::INXObjectFindObject (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< NXStringGetUserAttributesAsStrings ()
 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::BasePartOwningPart ()
 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::INXObjectPrototype ()
 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...
 

Additional Inherited Members

- Public Types inherited from NXOpen::Routing::Port
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...
 

Detailed Description

A NXOpen::Routing::TerminalPort models the pins on an electrical connector.

NXOpen::Routing::TerminalPort s are a NXOpen::Routing::MultiPort 's children.


Created in NX4.0.0.

Member Function Documentation

virtual NXOpen::Axis* NXOpen::Routing::TerminalPort::Axis ( )
virtual

Returns the axis that defines the port
Created in NX5.0.0.



License requirements : routing_base ("Routing Basic")

Implements NXOpen::Routing::IAxisPort.

virtual NXOpen::Expression* NXOpen::Routing::TerminalPort::CutbackLengthObject ( )
virtual

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

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


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Implements NXOpen::Routing::IAxisPort.

virtual NXOpen::Expression* NXOpen::Routing::TerminalPort::EngagementObject ( )
virtual

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

an expression representing the distance behind the port that another fitting or stock may engage


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Implements NXOpen::Routing::IAxisPort.

virtual NXOpen::Expression* NXOpen::Routing::TerminalPort::ForwardExtensionObject ( )
virtual

Returns the forward extension object of a port, i.e.

an expression representing the minimum length that a segment must remain straight coming out of a NXOpen::Routing::Port


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Implements NXOpen::Routing::IAxisPort.

NXOpen::Routing::MultiPort* NXOpen::Routing::TerminalPort::MultiPort ( )

Returns the parent NXOpen::Routing::MultiPort of the NXOpen::Routing::TerminalPort.


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

NXString NXOpen::Routing::TerminalPort::PinIdentifier ( )

Returns the pin identifier (name) of the NXOpen::Routing::TerminalPort
Created in NX4.0.0.



License requirements : routing_base ("Routing Basic")

virtual void NXOpen::Routing::TerminalPort::SetAlignVector ( const NXOpen::Vector3d vector)
virtual

Sets the align vector of Port
Created in NX4.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
vectorVector direction in absolute co-ordinate system

Implements NXOpen::Routing::IAxisPort.

virtual void NXOpen::Routing::TerminalPort::SetAxis ( NXOpen::Axis axis)
virtual

Sets the axis that defines the port
Created in NX5.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
axisaxis

Implements NXOpen::Routing::IAxisPort.

virtual void NXOpen::Routing::TerminalPort::SetCutbackLength ( double  cutbackLength)
virtual

Sets 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


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
cutbackLengthCutback Length

Implements NXOpen::Routing::IAxisPort.

virtual void NXOpen::Routing::TerminalPort::SetCutbackLengthObject ( NXOpen::Expression cutbackLength)
virtual

Sets the cutback length object of a port, i.e.

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


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
cutbackLengthCutback Length Expression

Implements NXOpen::Routing::IAxisPort.

virtual void NXOpen::Routing::TerminalPort::SetEngagement ( double  engagement)
virtual

The engagment distance of a NXOpen::Routing::IAxisPort , i.e.

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


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
engagementEngagement distance

Implements NXOpen::Routing::IAxisPort.

virtual void NXOpen::Routing::TerminalPort::SetEngagementObject ( NXOpen::Expression engagement)
virtual

Sets the engagement object of a port, i.e.

an expression representing the distance behind the port that another fitting or stock may engage


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
engagementEngagement Expression

Implements NXOpen::Routing::IAxisPort.

virtual void NXOpen::Routing::TerminalPort::SetForwardExtension ( double  forwardExtension)
virtual

Sets the forward extension value of a port, i.e.

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


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
forwardExtensionPort extension

Implements NXOpen::Routing::IAxisPort.

virtual void NXOpen::Routing::TerminalPort::SetForwardExtensionObject ( NXOpen::Expression forwardExtension)
virtual

Sets the forward extension object of a port, i.e.

an expression representing the minimum length that a segment must remain straight coming out of a NXOpen::Routing::Port


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
forwardExtensionForward Extension Expression

Implements NXOpen::Routing::IAxisPort.

void NXOpen::Routing::TerminalPort::SetPinIdentifier ( const NXString pinIdentifier)

Sets the pin identifier (name) of the NXOpen::Routing::TerminalPort
Created in NX4.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
pinIdentifierpin identifier
void NXOpen::Routing::TerminalPort::SetPinIdentifier ( const char *  pinIdentifier)

Sets the pin identifier (name) of the NXOpen::Routing::TerminalPort
Created in NX4.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
pinIdentifierpin identifier
virtual void NXOpen::Routing::TerminalPort::SetRotationObject ( NXOpen::DisplayableObject rotationObject)
virtual

Sets the object used to derive the rotation vector of Port
Created in NX4.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
rotationObjectObject used to derive the rotation vector

Implements NXOpen::Routing::IAxisPort.

virtual void NXOpen::Routing::TerminalPort::SetRotationVector ( const NXOpen::Vector3d vector)
virtual

Sets the rotation vector of Port
Created in NX4.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
vectorVector direction in absolute co-ordinate system

Implements NXOpen::Routing::IAxisPort.


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