ObjectNameIndexBuilder Class

class NXOpen.AME.ObjectNameIndexBuilder

Bases: NXOpen.TaggedObject, NXOpen.GeometricUtilities.IComponentBuilder

Object Name Index JA class

New in version NX11.0.0.

Properties

Property Description
ObjectDescription Returns or sets the object description
ObjectIndex Returns the object index
ObjectName Returns or sets the object name
Tag Returns the Tag for this object.

Methods

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

Property Detail

ObjectDescription

ObjectNameIndexBuilder.ObjectDescription

Returns or sets the object description

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

Getter Method

Signature ObjectDescription

Returns:
Return type:str

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature ObjectDescription

Parameters:objectDescription (str) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

ObjectIndex

ObjectNameIndexBuilder.ObjectIndex

Returns the object index

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

Getter Method

Signature ObjectIndex

Returns:
Return type:str

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

ObjectName

ObjectNameIndexBuilder.ObjectName

Returns or sets the object name

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

Getter Method

Signature ObjectName

Returns:
Return type:str

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature ObjectName

Parameters:objectName (str) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Method Detail

Validate

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