Order Class

class NXOpen.Assemblies.Order

Bases: NXOpen.NXObject

Represents base class for all Order classes.

It is an abstract class and cannot be instantiated on its own. All Order classes should inherit from this class. This is an abstract class, and cannot be instantiated.

New in version NX9.0.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.
OrderState	Returns the state of NXOpen.Assemblies.Order.
OrderType	Returns the type of NXOpen.Assemblies.Order.
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
Activate	Applies this order
CreateAttributeIterator	Create an attribute iterator
Delete	Deletes an order
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.
GetChildrenOrder	Returns immediate children of input NXOpen.Assemblies.Component as they are ordered in this NXOpen.Assemblies.ComponentOrder
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.
GetReversed	Gets the reverse state of the NXOpen.Assemblies.Order
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
IsActive	Returns true if this order is the active order in owning NXOpen.Assemblies.ComponentAssembly>
Print	Prints a representation of this object to the system log file.
Save	Saves an order
SaveAs	Creates a copy of the order, and gives the copy a new name.
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.
SetReversed	Sets the reverse state of the NXOpen.Assemblies.Order
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

OrderState Enumeration	Represents whether an order is saved or not
OrderType Enumeration	Represents the type of an order

Property Detail

IsOccurrence

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

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

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

OrderState

Order.OrderState

Returns the state of NXOpen.Assemblies.Order.

An order can be in one of the NXOpen.Assemblies.OrderState.

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

Getter Method

Signature OrderState

Returns: Return type:NXOpen.Assemblies.OrderState

New in version NX9.0.0.

License requirements: None.

OrderType

Order.OrderType

Returns the type of NXOpen.Assemblies.Order.

An order can be of NXOpen.Assemblies.OrderType

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

Getter Method

Signature OrderType

Returns: Return type:NXOpen.Assemblies.OrderType

New in version NX9.0.0.

License requirements: None.

OwningComponent

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

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

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

Activate

Order.Activate

Applies this order

Signature Activate()

New in version NX9.0.0.

License requirements: None.

Delete

Order.Delete

Deletes an order

Signature Delete()

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

FindObject

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

GetChildrenOrder

Order.GetChildrenOrder

Returns immediate children of input NXOpen.Assemblies.Component as they are ordered in this NXOpen.Assemblies.ComponentOrder

Signature GetChildrenOrder(parent)

Parameters:parent (NXOpen.Assemblies.Component) – Returns:Returns children in order Return type:list of NXOpen.Assemblies.Component

New in version NX9.0.0.

Deprecated since version NX10.0.0: Use NXOpen.Assemblies.ComponentOrder.AskChildrenOrder() instead to get children order in this NXOpen.Assemblies.ComponentOrder.

License requirements: None.

GetReversed

Order.GetReversed

Gets the reverse state of the NXOpen.Assemblies.Order

Signature GetReversed()

Returns:True if order is reversed else False Return type:bool

New in version NX9.0.0.

License requirements: None.

IsActive

Order.IsActive

Returns true if this order is the active order in owning NXOpen.Assemblies.ComponentAssembly>

Signature IsActive()

Returns:True if the current order is active Return type:bool

New in version NX10.0.3.

License requirements: assemblies (“ASSEMBLIES MODULE”)

Print

Order.Print

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

Signature Print()

New in version NX3.0.0.

License requirements: None.

Save

Order.Save

Saves an order

Signature Save()

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

SaveAs

Order.SaveAs

Creates a copy of the order, and gives the copy a new name.

Each NXOpen.Assemblies.ComponentAssembly contains a set of system defined orders, which could be queried using NXOpen.Assemblies.ComponentAssembly.GetComponentOrders() method. A new NXOpen.Assemblies.OrderType.UserDefinedComponent order can only be created using this method.

Signature SaveAs(newName)

Parameters:newName (str) – Returns:The new Order Return type:NXOpen.Assemblies.Order

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

SetName

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

SetReversed

Order.SetReversed

Sets the reverse state of the NXOpen.Assemblies.Order

Signature SetReversed(isReversed)

Parameters:isReversed (bool) –

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)