SystemObject Class

class NXOpen.Mechatronics.SystemObject

Bases: NXOpen.NXObject

Represents the System Object.

System Object is the entity displaying in System Navigator. This is an abstract class and cannot be created.

New in version NX8.5.0.

Properties

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

Methods

Method Description
AddComponent Adds Assemblies.Component.
AddOperation Adds operation object.
AddPhysicsObjects Adds behavioral physics objects.
AddSignalAdapters Adds signal adapter objects.
ApplyNamingRule Perform naming rule check and update the designation.
AssociateItem Associate a specified item to this system object.
CreateAttributeIterator Create an attribute iterator
CreateTraceLink Creates the trace link for system objects.
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
DissociateItem Dissociate a specified item from this system object.
FindObject Finds the NXOpen.NXObject with the given identifier as recorded in a journal.
GetAssociateItem Query the associated item with a specified type.
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.
GetPhysicsObjects Gets behavioral physics objects.
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.
GetSingleDesignation Get the single designation including aspect, letter code and index.
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.
RemoveComponent Removes Assemblies.Component.
RemoveOperation Removes operation object.
RemovePhysicsObjects Removes behavioral physics objects.
RemoveSignalAdapters Removes signal adapter objects.
RemoveTraceLink Removes the trace link for system objects.
RenameInstance Renames system object instance.
ReorderObject Reorders system objects.
RestructureObject Restructure system object.
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.
SetSingleDesignation Set the single designation including aspect, letter code and index.
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

SystemObjectRelationType Enumeration Relation type.
SystemObjectReorderType Enumeration Reorder object type to specify the relative position.

Property Detail

IsOccurrence

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

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

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

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

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

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

Method Detail

AddComponent

SystemObject.AddComponent

Adds Assemblies.Component.

Signature AddComponent(comps)

Parameters:comps (list of NXOpen.Assemblies.Component) –

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

AddOperation

SystemObject.AddOperation

Adds operation object.

Signature AddOperation(opers)

Parameters:opers (list of NXOpen.NXObject) –

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

AddPhysicsObjects

SystemObject.AddPhysicsObjects

Adds behavioral physics objects.

Signature AddPhysicsObjects(objects)

Parameters:objects (list of NXOpen.NXObject) –

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

AddSignalAdapters

SystemObject.AddSignalAdapters

Adds signal adapter objects.

Signature AddSignalAdapters(adapters)

Parameters:adapters (list of NXOpen.NXObject) –

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

ApplyNamingRule

SystemObject.ApplyNamingRule

Perform naming rule check and update the designation.

Signature ApplyNamingRule()

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

AssociateItem

SystemObject.AssociateItem

Associate a specified item to this system object.

This method only makes sense in NX Manager mode.

Signature AssociateItem(type, itemMFKID, revisionID)

Parameters:

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

DissociateItem

SystemObject.DissociateItem

Dissociate a specified item from this system object.

This method only makes sense in NX Manager mode.

Signature DissociateItem(itemMFKID, revisionID)

Parameters:
  • itemMFKID (str) – The item MFK ID of dissociation item.
  • revisionID (str) – The revision ID of dissociation item.

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

FindObject

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

GetAssociateItem

SystemObject.GetAssociateItem

Query the associated item with a specified type.

This method only makes sense in NX Manager mode.

Signature GetAssociateItem(type)

Parameters:type (NXOpen.Mechatronics.SystemObjectRelationType) – The relation type.
Returns:a tuple
Return type:A tuple consisting of (itemMFKID, revisionID) itemMFKID is a str. The item MFK ID of association item. revisionID is a str. The revision ID of association item.

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

GetPhysicsObjects

SystemObject.GetPhysicsObjects

Gets behavioral physics objects.

Signature GetPhysicsObjects()

Returns:
Return type:list of NXOpen.NXObject

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

GetSingleDesignation

SystemObject.GetSingleDesignation

Get the single designation including aspect, letter code and index.

Signature GetSingleDesignation()

Returns:
Return type:str

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Print

SystemObject.Print

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

Signature Print()

New in version NX3.0.0.

License requirements: None.

RemoveComponent

SystemObject.RemoveComponent

Removes Assemblies.Component.

Signature RemoveComponent(comps)

Parameters:comps (list of NXOpen.Assemblies.Component) –

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

RemoveOperation

SystemObject.RemoveOperation

Removes operation object.

Signature RemoveOperation(opers)

Parameters:opers (list of NXOpen.NXObject) –

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

RemovePhysicsObjects

SystemObject.RemovePhysicsObjects

Removes behavioral physics objects.

Signature RemovePhysicsObjects(objects)

Parameters:objects (list of NXOpen.NXObject) –

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

RemoveSignalAdapters

SystemObject.RemoveSignalAdapters

Removes signal adapter objects.

Signature RemoveSignalAdapters(adapters)

Parameters:adapters (list of NXOpen.NXObject) –

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

RenameInstance

SystemObject.RenameInstance

Renames system object instance.

Signature RenameInstance(name)

Parameters:name (str) –

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

ReorderObject

SystemObject.ReorderObject

Reorders system objects.

The method will reorder the objects in the same level of the structure. The source object will be moved to the destination and the sibling will update the order accordingly.

Signature ReorderObject(pDestination, beforeOrAfter)

Parameters:

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

RestructureObject

SystemObject.RestructureObject

Restructure system object.

Signature RestructureObject(pDestination)

Parameters:pDestination (NXOpen.Mechatronics.SystemObject) –

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SetName

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

SetSingleDesignation

SystemObject.SetSingleDesignation

Set the single designation including aspect, letter code and index.

The aspect, letter code and index are joined together and comply with the rules defined in the configuration file.

Signature SetSingleDesignation(designation)

Parameters:designation (str) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)