ObjectInformationBuilder Class

class NXOpen.Mechatronics.ObjectInformationBuilder

Bases: NXOpen.Builder

Represents a NXOpen.Mechatronics.ObjectInformationBuilder

This is a sub-builder class and cannot be directly instantiated

New in version NX8.5.0.

Properties

Property	Description
ItemID	Returns or sets the item ID.
ItemName	Returns or sets the name of item.
ItemTypes	Returns or sets the item types.
RevisionID	Returns or sets the revision ID.
Tag	Returns the Tag for this object.

Methods

Method	Description
Commit	Commits any edits that have been applied to the builder.
Destroy	Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetDescription	Gets the description.
GetObject	Returns the object currently being edited by this builder.
SetDescription	Sets the description.
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

ItemID

ObjectInformationBuilder.ItemID

Returns or sets the item ID.

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

Getter Method

Signature ItemID

Returns: Return type:str

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature ItemID

Parameters:itemID (str) –

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

ItemName

ObjectInformationBuilder.ItemName

Returns or sets the name of item.

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

Getter Method

Signature ItemName

Returns: Return type:str

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature ItemName

Parameters:name (str) –

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

ItemTypes

ObjectInformationBuilder.ItemTypes

Returns or sets the item types.

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

Getter Method

Signature ItemTypes

Returns: Return type:str

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature ItemTypes

Parameters:itemTypes (str) –

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

RevisionID

ObjectInformationBuilder.RevisionID

Returns or sets the revision ID.

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

Getter Method

Signature RevisionID

Returns: Return type:str

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature RevisionID

Parameters:revID (str) –

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Method Detail

GetDescription

ObjectInformationBuilder.GetDescription

Gets the description.

Signature GetDescription()

Returns: Return type:list of str

New in version NX8.5.0.

License requirements: None.

SetDescription

ObjectInformationBuilder.SetDescription

Sets the description.

Signature SetDescription(description)

Parameters:description (list of str) –

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Validate

ObjectInformationBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful Return type:bool

New in version NX3.0.1.

License requirements: None.