EplanStructureIdentifierOrderBuilder Class

class NXOpen.AME.EplanStructureIdentifierOrderBuilder

Bases: NXOpen.Builder

Represents a Eplan Structure identifier order Builder

To create a new instance of this class, use NXOpen.AME.AMEManager.CreateEplanStructureIdentifierOrderBuilder()

New in version NX12.0.0.

Properties

Property	Description
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.
GetFunctionIdentifierOrder	The structure order index for function
GetLocationIdentifierOrder	The structure order index for location
GetObject	Returns the object currently being edited by this builder.
SetFunctionIdentifierOrder	The structure order index for function
SetLocationIdentifierOrder	The structure order index for location
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UpdateStructureIdentifierOrder	Update structure identifier order.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Method Detail

GetFunctionIdentifierOrder

EplanStructureIdentifierOrderBuilder.GetFunctionIdentifierOrder

The structure order index for function

Signature GetFunctionIdentifierOrder()

Returns: Return type:list of str

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

GetLocationIdentifierOrder

EplanStructureIdentifierOrderBuilder.GetLocationIdentifierOrder

The structure order index for location

Signature GetLocationIdentifierOrder()

Returns: Return type:list of str

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SetFunctionIdentifierOrder

EplanStructureIdentifierOrderBuilder.SetFunctionIdentifierOrder

The structure order index for function

Signature SetFunctionIdentifierOrder(rowStrings)

Parameters:rowStrings (list of str) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SetLocationIdentifierOrder

EplanStructureIdentifierOrderBuilder.SetLocationIdentifierOrder

The structure order index for location

Signature SetLocationIdentifierOrder(rowStrings)

Parameters:rowStrings (list of str) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

UpdateStructureIdentifierOrder

EplanStructureIdentifierOrderBuilder.UpdateStructureIdentifierOrder

Update structure identifier order.

Signature UpdateStructureIdentifierOrder()

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Validate

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