DeviceRelationship Class

class NXOpen.Routing.DeviceRelationship

Bases: NXOpen.Routing.ObjectRelationship

Represents a relationship between NXOpen.Routing.SingleDevice objects.

ObjectRelationship is the abstract base class for NXOpen.Routing.InterfaceTerminalRelationshipBase and NXOpen.Routing.DeviceRelationship.

No creator is available in KF because this is an abstract class.

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 relationship.
Tag	Returns the Tag for this object.

Methods

Method	Description
AddRelatedSingleDevice	Adds a NXOpen.Routing.SingleDevice to the collection of related NXOpen.Routing.SingleDevice objects.
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.
GetRelatedSingleDevices	Returns the list of related NXOpen.Routing.SingleDevice objects.
GetRelatingSingleDevice	Returns the one NXOpen.Routing.SingleDevice to which the other NXOpen.Routing.SingleDevice objects are related.
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
Print	Prints a representation of this object to the system log file.
RemoveRelatedSingleDevice	Removes a NXOpen.Routing.SingleDevice from the collection of related NXOpen.Routing.SingleDevice objects.
ReplaceRelatedSingleDevices	Replaces the collection of related NXOpen.Routing.SingleDevice objects.
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.
SetRelatingSingleDevice	Sets the one Relating NXOpen.Routing.SingleDevice.
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

DeviceRelationshipRelationType Enumeration

Specifies the nature of the relationship between the related and relating objects.

Property Detail

IsOccurrence

DeviceRelationship.IsOccurrence

Returns whether this object is an occurrence or not.

-------------------------------------

Getter Method

Signature IsOccurrence

Returns:This object is an occurrence Return type:bool

New in version NX3.0.0.

License requirements: None.

JournalIdentifier

DeviceRelationship.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 JournalIdentifier

Returns: Return type:str

New in version NX3.0.0.

License requirements: None.

Name

DeviceRelationship.Name

Returns the custom name of the object.

-------------------------------------

Getter Method

Signature Name

Returns: Return type:str

New in version NX3.0.0.

License requirements: None.

OwningComponent

DeviceRelationship.OwningComponent

Returns the owning component, if this object is an occurrence.

-------------------------------------

Getter Method

Signature OwningComponent

Returns: Return type:NXOpen.Assemblies.Component

New in version NX3.0.0.

License requirements: None.

OwningPart

DeviceRelationship.OwningPart

Returns the owning part of this object

-------------------------------------

Getter Method

Signature OwningPart

Returns:The owning part of this object or null if it does not have an owner Return type:NXOpen.BasePart

New in version NX3.0.0.

License requirements: None.

Prototype

DeviceRelationship.Prototype

Returns the prototype of this object if it is an occurrence.

-------------------------------------

Getter Method

Signature Prototype

Returns:The prototype of this object or null if this object is not an occurrence Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

RelationshipType

DeviceRelationship.RelationshipType

Returns or sets the type of the relationship.

-------------------------------------

Getter Method

Signature RelationshipType

Returns: Return type:NXOpen.Routing.DeviceRelationshipRelationType

New in version NX4.0.2.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

-------------------------------------

Setter Method

Signature RelationshipType

Parameters:relationshipType (NXOpen.Routing.DeviceRelationshipRelationType) – The new type of the relationship

New in version NX4.0.2.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

Method Detail

AddRelatedSingleDevice

DeviceRelationship.AddRelatedSingleDevice

Adds a NXOpen.Routing.SingleDevice to the collection of related NXOpen.Routing.SingleDevice objects.

Signature AddRelatedSingleDevice(relatedDevice)

Parameters:relatedDevice (NXOpen.Routing.SingleDevice) – The NXOpen.Routing.SingleDevice to add to the set of related objects

New in version NX4.0.2.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

FindObject

DeviceRelationship.FindObject

Finds the NXOpen.NXObject with 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.INXObject

New in version NX3.0.0.

License requirements: None.

GetRelatedSingleDevices

DeviceRelationship.GetRelatedSingleDevices

Returns the list of related NXOpen.Routing.SingleDevice objects.

The objects in the list are related to the relating NXOpen.Routing.SingleDevice object.

Signature GetRelatedSingleDevices()

Returns:Set of NXOpen.Routing.SingleDevice objects that are related to the Relating SingleDevice Return type:list of NXOpen.Routing.SingleDevice

New in version NX4.0.2.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

GetRelatingSingleDevice

DeviceRelationship.GetRelatingSingleDevice

Returns the one NXOpen.Routing.SingleDevice to which the other NXOpen.Routing.SingleDevice objects are related.

Signature GetRelatingSingleDevice()

Returns: Return type:NXOpen.Routing.SingleDevice

New in version NX4.0.2.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

Print

DeviceRelationship.Print

Prints a representation of this object to the system log file.

Signature Print()

New in version NX3.0.0.

License requirements: None.

RemoveRelatedSingleDevice

DeviceRelationship.RemoveRelatedSingleDevice

Removes a NXOpen.Routing.SingleDevice from the collection of related NXOpen.Routing.SingleDevice objects.

Signature RemoveRelatedSingleDevice(relatedDevice)

Parameters:relatedDevice (NXOpen.Routing.SingleDevice) – The NXOpen.Routing.SingleDevice that is removed from the set of related objects

New in version NX4.0.2.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

ReplaceRelatedSingleDevices

DeviceRelationship.ReplaceRelatedSingleDevices

Replaces the collection of related NXOpen.Routing.SingleDevice objects.

Signature ReplaceRelatedSingleDevices(relatedDevices)

Parameters:relatedDevices (list of NXOpen.Routing.SingleDevice) – A set of NXOpen.Routing.SingleDevice objects that replaces the current set of related objects

New in version NX4.0.2.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SetName

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

SetRelatingSingleDevice

DeviceRelationship.SetRelatingSingleDevice

Sets the one Relating NXOpen.Routing.SingleDevice.

Signature SetRelatingSingleDevice(relatingDevice)

Parameters:relatingDevice (NXOpen.Routing.SingleDevice) – The new Relating device

New in version NX4.0.2.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)