InterfaceTerminalRelationshipBase Class¶
-
class
NXOpen.Routing.InterfaceTerminalRelationshipBase¶ Bases:
NXOpen.Routing.ObjectRelationshipThe abstract class
NXOpen.Routing.InterfaceTerminalRelationshipBaserelates manyNXOpen.Routing.Port`s to one :py:class:`NXOpen.Routing.Port.See NX Routing help for the Connectivity data model documentation.
Creator not available in KF.
New in version NX4.0.2.
Properties¶
| Property | Description |
|---|---|
| Guid | Returns or sets the object’s Global Unique Identifier (GUID). |
| IsOccurrence | Returns whether this object is an occurrence or not. |
| JournalIdentifier | Returns the identifier that would be recorded in a journal for this object. |
| Name | Returns the custom name of the object. |
| OwningComponent | Returns the owning component, if this object is an occurrence. |
| OwningPart | Returns the owning part of this object |
| Prototype | Returns the prototype of this object if it is an occurrence. |
| RelationshipType | Returns or sets the type of the NXOpen.Routing.InterfaceTerminalRelationshipBase object. |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| AddRelatedInterfaceTerminal | Adds a NXOpen.Routing.Port to the NXOpen.Routing.InterfaceTerminalRelationshipBase object with a relationship of related. |
| CreateAttributeIterator | Create an attribute iterator |
| DeleteAllAttributesByType | Deletes all attributes of a specific type. |
| DeleteAttributeByTypeAndTitle | Deletes an attribute by type and title. |
| DeleteUserAttribute | Deletes the first attribute encountered with the given Type, Title. |
| DeleteUserAttributes | Deletes the attributes on the object, if any, that satisfy the given iterator |
| FindObject | Finds the NXOpen.NXObject with the given identifier as recorded in a journal. |
| GetAttributeTitlesByType | Gets all the attribute titles of a specific type. |
| GetBooleanUserAttribute | Gets a boolean attribute by Title and array Index. |
| GetComputationalTimeUserAttribute | Gets a time attribute by Title and array Index. |
| GetIntegerAttribute | Gets an integer attribute by title. |
| GetIntegerUserAttribute | Gets an integer attribute by Title and array Index. |
| GetNextUserAttribute | Gets the next attribute encountered on the object, if any, that satisfies the given iterator. |
| GetPdmReferenceAttributeValue | Gets the value of PDM Reference attribute for given object. |
| GetRealAttribute | Gets a real attribute by title. |
| GetRealUserAttribute | Gets a real attribute by Title and array Index. |
| GetReferenceAttribute | Gets the reference string (not the calculated value) of a string attribute that uses a reference string. |
| GetRelatedInterfaceTerminals | Gets the list of NXOpen.Routing.Port`s in the :py:class:`NXOpen.Routing.InterfaceTerminalRelationshipBase object with a relationship of related. |
| GetRelatingInterfaceTerminal | Gets the NXOpen.Routing.Port in the NXOpen.Routing.InterfaceTerminalRelationshipBase with a relationship of relating. |
| GetStringAttribute | Gets a string attribute value by title. |
| GetStringUserAttribute | Gets a string attribute by Title and array Index. |
| GetTimeAttribute | Gets a time attribute by title. |
| GetTimeUserAttribute | Gets a time attribute by Title and array Index. |
| GetUserAttribute | Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. |
| GetUserAttributeAsString | Gets the first attribute encountered on the object, if any, with a given title, type and array index. |
| GetUserAttributeCount | Gets the count of set attributes on the object, if any, that satisfy the given iterator. |
| GetUserAttributeLock | Determine the lock of the given attribute. |
| GetUserAttributeSize | Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. |
| GetUserAttributeSourceObjects | Returns an array of objects from which this object presents attributes. |
| GetUserAttributes | Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. |
| GetUserAttributesAsStrings | Gets all the attributes that have been set on the given object. |
| HasUserAttribute | Determines if an attribute exists on the object, that satisfies the given iterator |
| Prints a representation of this object to the system log file. | |
| RemoveRelatedInterfaceTerminal | Removes a related NXOpen.Routing.Port from the list of related terminals in the NXOpen.Routing.InterfaceTerminalRelationshipBase object. |
| ReplaceRelatedInterfaceTerminals | Replaces the existing related NXOpen.Routing.Port`s in the :py:class:`NXOpen.Routing.InterfaceTerminalRelationshipBase object with input ones. |
| SetAttribute | Creates or modifies an integer attribute. |
| SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not. |
| SetName | Sets the custom name of the object. |
| SetPdmReferenceAttribute | Sets the value of PDM Reference attribute on the object. |
| SetReferenceAttribute | Creates or modifies a string attribute which uses a reference string. |
| SetRelatingInterfaceTerminal | |
| SetTimeAttribute | Creates or modifies a time attribute. |
| SetTimeUserAttribute | Creates or modifies a time attribute with the option to update or not. |
| SetUserAttribute | Creates or modifies an attribute with the option to update or not. |
| SetUserAttributeLock | Lock or unlock the given attribute. |
Enumerations¶
| InterfaceTerminalRelationshipBaseRelationType Enumeration | Type of interface terminal relationships as per STEP 212 Standards. |
Property Detail¶
IsOccurrence¶
-
InterfaceTerminalRelationshipBase.IsOccurrence¶ Returns whether this object is an occurrence or not.
-------------------------------------Getter Method
Signature
IsOccurrenceReturns: This object is an occurrence Return type: bool New in version NX3.0.0.
License requirements: None.
JournalIdentifier¶
-
InterfaceTerminalRelationshipBase.JournalIdentifier¶ Returns the identifier that would be recorded in a journal for this object.
This may not be the same across different releases of the software.
-------------------------------------Getter Method
Signature
JournalIdentifierReturns: Return type: str New in version NX3.0.0.
License requirements: None.
Name¶
-
InterfaceTerminalRelationshipBase.Name¶ Returns the custom name of the object.
-------------------------------------Getter Method
Signature
NameReturns: Return type: str New in version NX3.0.0.
License requirements: None.
OwningComponent¶
-
InterfaceTerminalRelationshipBase.OwningComponent¶ Returns the owning component, if this object is an occurrence.
-------------------------------------Getter Method
Signature
OwningComponentReturns: Return type: NXOpen.Assemblies.ComponentNew in version NX3.0.0.
License requirements: None.
OwningPart¶
-
InterfaceTerminalRelationshipBase.OwningPart¶ Returns the owning part of this object
-------------------------------------Getter Method
Signature
OwningPartReturns: The owning part of this object or null if it does not have an owner Return type: NXOpen.BasePartNew in version NX3.0.0.
License requirements: None.
Prototype¶
-
InterfaceTerminalRelationshipBase.Prototype¶ Returns the prototype of this object if it is an occurrence.
-------------------------------------Getter Method
Signature
PrototypeReturns: The prototype of this object or null if this object is not an occurrence Return type: NXOpen.INXObjectNew in version NX3.0.0.
License requirements: None.
RelationshipType¶
-
InterfaceTerminalRelationshipBase.RelationshipType¶ Returns or sets the type of the
NXOpen.Routing.InterfaceTerminalRelationshipBaseobject.Interface Terminal Relationship can be of following types:
NXOpen.Routing.InterfaceTerminalRelationshipBaseRelationType.Decomposition-------------------------------------Getter Method
Signature
RelationshipTypeReturns: Return type: NXOpen.Routing.InterfaceTerminalRelationshipBaseRelationTypeNew in version NX4.0.2.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
-------------------------------------Setter Method
Signature
RelationshipTypeParameters: relationshipType ( NXOpen.Routing.InterfaceTerminalRelationshipBaseRelationType) –New in version NX4.0.2.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
Method Detail¶
FindObject¶
-
InterfaceTerminalRelationshipBase.FindObject¶ Finds the
NXOpen.NXObjectwith the given identifier as recorded in a journal.An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.
An exception will be thrown if no object can be found with the given journal identifier.
Signature
FindObject(journalIdentifier)Parameters: journalIdentifier (str) – Journal identifier of the object Returns: Return type: NXOpen.INXObjectNew in version NX3.0.0.
License requirements: None.
GetRelatingInterfaceTerminal¶
-
InterfaceTerminalRelationshipBase.GetRelatingInterfaceTerminal¶ Gets the
NXOpen.Routing.Portin theNXOpen.Routing.InterfaceTerminalRelationshipBasewith a relationship of relating.A
NXOpen.Routing.InterfaceTerminalRelationshipBaseobject can have only one relatingNXOpen.Routing.Portassociated with one or more related :py:class:`NXOpen.Routing.Port`s.Signature
GetRelatingInterfaceTerminal()Returns: Return type: NXOpen.Routing.InterfaceTerminalShadowNew in version NX4.0.2.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
Print¶
-
InterfaceTerminalRelationshipBase.Print¶ Prints a representation of this object to the system log file.
Signature
Print()New in version NX3.0.0.
License requirements: None.
SetName¶
-
InterfaceTerminalRelationshipBase.SetName¶ Sets the custom name of the object.
NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Signature
SetName(name)Parameters: name (str) – New in version NX3.0.0.
License requirements: None.
SetRelatingInterfaceTerminal¶
-
InterfaceTerminalRelationshipBase.SetRelatingInterfaceTerminal¶ Signature
SetRelatingInterfaceTerminal(relatingInterfaceTerminal)Parameters: relatingInterfaceTerminal ( NXOpen.Routing.InterfaceTerminalShadow) –New in version NX4.0.2.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)