EplanProjectTemplateAndStructureBuilder Class

class NXOpen.AME.EplanProjectTemplateAndStructureBuilder

Bases: NXOpen.Builder

JA class for the Eplan project template dialog

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

New in version NX12.0.0.

Properties

Property Description
StructureOrderFunctionIndex Returns or sets the structure order index for function
StructureOrderLocationIndex Returns or sets the structure order index for location
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.
GetObject Returns the object currently being edited by this builder.
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

StructureOrderFunctionIndex

EplanProjectTemplateAndStructureBuilder.StructureOrderFunctionIndex

Returns or sets the structure order index for function

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

Getter Method

Signature StructureOrderFunctionIndex

Returns:
Return type:int

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature StructureOrderFunctionIndex

Parameters:structureOrderFunctionState (int) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

StructureOrderLocationIndex

EplanProjectTemplateAndStructureBuilder.StructureOrderLocationIndex

Returns or sets the structure order index for location

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

Getter Method

Signature StructureOrderLocationIndex

Returns:
Return type:int

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature StructureOrderLocationIndex

Parameters:structureOrderLocationState (int) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Method Detail

Validate

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