EplanSettingsBuilder Class

class NXOpen.AME.EplanSettingsBuilder

Bases: NXOpen.Builder

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

New in version NX11.0.0.

Properties

Property	Description
Commission	Returns or sets the commission
ControlVoltage	Returns or sets the control voltage
Customer	Returns or sets the customer
Description	Returns or sets the description
Id	Returns or sets the id
Location	Returns or sets the location
ManufacturingYear	Returns or sets the manufacturing year
Name	Returns or sets the name
PowerInput	Returns or sets the power input
ProjectTargetPath	Returns or sets the generation path
ProjectTemplateFile	Returns or sets the project template file
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.
GetDetails	Returns the details
GetObject	Returns the object currently being edited by this builder.
ResetProjectTemplate	Reset the eplan project template information
SetDetails	Sets the details
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

Commission

EplanSettingsBuilder.Commission

Returns or sets the commission

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

Getter Method

Signature Commission

Returns: Return type:str

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature Commission

Parameters:commission (str) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

ControlVoltage

EplanSettingsBuilder.ControlVoltage

Returns or sets the control voltage

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

Getter Method

Signature ControlVoltage

Returns: Return type:str

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature ControlVoltage

Parameters:controlVoltage (str) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Customer

EplanSettingsBuilder.Customer

Returns or sets the customer

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

Getter Method

Signature Customer

Returns: Return type:str

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature Customer

Parameters:customer (str) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Description

EplanSettingsBuilder.Description

Returns or sets the description

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

Getter Method

Signature Description

Returns: Return type:str

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature Description

Parameters:description (str) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Id

EplanSettingsBuilder.Id

Returns or sets the id

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

Getter Method

Signature Id

Returns: Return type:str

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature Id

Parameters:id (str) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Location

EplanSettingsBuilder.Location

Returns or sets the location

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

Getter Method

Signature Location

Returns: Return type:str

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature Location

Parameters:location (str) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

ManufacturingYear

EplanSettingsBuilder.ManufacturingYear

Returns or sets the manufacturing year

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

Getter Method

Signature ManufacturingYear

Returns: Return type:str

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature ManufacturingYear

Parameters:manufacturingYear (str) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Name

EplanSettingsBuilder.Name

Returns or sets the name

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

Getter Method

Signature Name

Returns: Return type:str

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature Name

Parameters:name (str) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

PowerInput

EplanSettingsBuilder.PowerInput

Returns or sets the power input

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

Getter Method

Signature PowerInput

Returns: Return type:str

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature PowerInput

Parameters:powerInput (str) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

ProjectTargetPath

EplanSettingsBuilder.ProjectTargetPath

Returns or sets the generation path

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

Getter Method

Signature ProjectTargetPath

Returns: Return type:str

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature ProjectTargetPath

Parameters:projectTargetPath (str) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

ProjectTemplateFile

EplanSettingsBuilder.ProjectTemplateFile

Returns or sets the project template file

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

Getter Method

Signature ProjectTemplateFile

Returns: Return type:str

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature ProjectTemplateFile

Parameters:filename (str) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Method Detail

GetDetails

EplanSettingsBuilder.GetDetails

Returns the details

Signature GetDetails()

Returns: Return type:list of str

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

ResetProjectTemplate

EplanSettingsBuilder.ResetProjectTemplate

Reset the eplan project template information

Signature ResetProjectTemplate()

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SetDetails

EplanSettingsBuilder.SetDetails

Sets the details

Signature SetDetails(details)

Parameters:details (list of str) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Validate

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