TiaProjectItemBuilder Class¶
-
class
NXOpen.AME.TiaProjectItemBuilder¶ Bases:
NXOpen.Builderthe TIA project item builder
To create a new instance of this class, use
NXOpen.AME.AMEManager.CreateTiaprojectItemBuilder()New in version NX11.0.0.
Properties¶
| Property | Description |
|---|---|
| FullPath | Returns or sets the project item full path (project folder path plus project file name with extension) |
| Name | Returns or sets the project item name |
| Path | Returns or sets the project item path |
| 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¶
FullPath¶
-
TiaProjectItemBuilder.FullPath¶ Returns or sets the project item full path (project folder path plus project file name with extension)
-------------------------------------Getter Method
Signature
FullPathReturns: Return type: str New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------Setter Method
Signature
FullPathParameters: projectFullPath (str) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Name¶
-
TiaProjectItemBuilder.Name¶ Returns or sets the project item name
-------------------------------------Getter Method
Signature
NameReturns: Return type: str New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------Setter Method
Signature
NameParameters: projectName (str) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Path¶
-
TiaProjectItemBuilder.Path¶ Returns or sets the project item path
-------------------------------------Getter Method
Signature
PathReturns: Return type: str New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------Setter Method
Signature
PathParameters: projectPath (str) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Method Detail¶
Validate¶
-
TiaProjectItemBuilder.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.