EplanProjectGenerationBuilder Class¶
-
class
NXOpen.AME.EplanProjectGenerationBuilder¶ Bases:
NXOpen.Builderthe eplan project generation dialog builder
To create a new instance of this class, use
NXOpen.AME.AMEManager.CreateEplanProjectGenerationBuilder()Default values.
Property Value ToggleOpenInEplan 0 ToggleOverwrite 0 ToggleSaveNameChanges 0 ToggleSavePathChanges 0 New in version NX11.0.0.
Properties¶
| Property | Description |
|---|---|
| ProjectName | Returns or sets the project name |
| Tag | Returns the Tag for this object. |
| TargetPathFolderBrowser | Returns or sets the generation target folder path |
| ToggleOpenInEplan | Returns or sets the toggle whether to open EPLAN project after generation |
| ToggleOverwrite | Returns or sets the toggle whether to overwrite existing EPLAN project |
| ToggleSaveNameChanges | Returns or sets the toggle whether to save the project name changes to EPLAN project settings |
| ToggleSavePathChanges | Returns or sets the toggle whether to save the target path changes to EPLAN project settings |
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. |
| GenerateEplanProject | Generate EPLAN project |
| 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¶
ProjectName¶
-
EplanProjectGenerationBuilder.ProjectName¶ Returns or sets the project name
-------------------------------------Getter Method
Signature
ProjectNameReturns: Return type: str New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------Setter Method
Signature
ProjectNameParameters: projectName (str) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
TargetPathFolderBrowser¶
-
EplanProjectGenerationBuilder.TargetPathFolderBrowser¶ Returns or sets the generation target folder path
-------------------------------------Getter Method
Signature
TargetPathFolderBrowserReturns: Return type: str New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------Setter Method
Signature
TargetPathFolderBrowserParameters: filename (str) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
ToggleOpenInEplan¶
-
EplanProjectGenerationBuilder.ToggleOpenInEplan¶ Returns or sets the toggle whether to open EPLAN project after generation
-------------------------------------Getter Method
Signature
ToggleOpenInEplanReturns: Return type: bool New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------Setter Method
Signature
ToggleOpenInEplanParameters: toggleOpenInEplan (bool) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
ToggleOverwrite¶
-
EplanProjectGenerationBuilder.ToggleOverwrite¶ Returns or sets the toggle whether to overwrite existing EPLAN project
-------------------------------------Getter Method
Signature
ToggleOverwriteReturns: Return type: bool New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------Setter Method
Signature
ToggleOverwriteParameters: toggleOverwrite (bool) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
ToggleSaveNameChanges¶
-
EplanProjectGenerationBuilder.ToggleSaveNameChanges¶ Returns or sets the toggle whether to save the project name changes to EPLAN project settings
-------------------------------------Getter Method
Signature
ToggleSaveNameChangesReturns: Return type: bool New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------Setter Method
Signature
ToggleSaveNameChangesParameters: toggleSaveNameChanges (bool) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
ToggleSavePathChanges¶
-
EplanProjectGenerationBuilder.ToggleSavePathChanges¶ Returns or sets the toggle whether to save the target path changes to EPLAN project settings
-------------------------------------Getter Method
Signature
ToggleSavePathChangesReturns: Return type: bool New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------Setter Method
Signature
ToggleSavePathChangesParameters: toggleSavePathChanges (bool) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Method Detail¶
GenerateEplanProject¶
-
EplanProjectGenerationBuilder.GenerateEplanProject¶ Generate EPLAN project
Signature
GenerateEplanProject()New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Validate¶
-
EplanProjectGenerationBuilder.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.