TiaPortalProjectSettingsBuilder Class¶
-
class
NXOpen.AME.TiaPortalProjectSettingsBuilder¶ Bases:
NXOpen.BuilderTo create a new instance of this class, use
NXOpen.AME.AMEManager.CreateTiaPortalProjectSettingsBuilder()New in version NX12.0.0.
Properties¶
| Property | Description |
|---|---|
| CompatibleVersion | Returns or sets the compatible version |
| IsCompatibleVersionLocked | Returns the compatible version lock |
| 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. |
| LockCompatibleVersion | Lock the compatible version setting |
| 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. |
Enumerations¶
| TiaPortalProjectSettingsBuilderTiaPortalVersionType Enumeration | represents TIA Portal Version type |
Property Detail¶
CompatibleVersion¶
-
TiaPortalProjectSettingsBuilder.CompatibleVersion¶ Returns or sets the compatible version
-------------------------------------Getter Method
Signature
CompatibleVersionReturns: Return type: NXOpen.AME.TiaPortalProjectSettingsBuilderTiaPortalVersionTypeNew in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------Setter Method
Signature
CompatibleVersionParameters: compatibleVersion ( NXOpen.AME.TiaPortalProjectSettingsBuilderTiaPortalVersionType) –New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
IsCompatibleVersionLocked¶
-
TiaPortalProjectSettingsBuilder.IsCompatibleVersionLocked¶ Returns the compatible version lock
-------------------------------------Getter Method
Signature
IsCompatibleVersionLockedReturns: Return type: bool New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Method Detail¶
LockCompatibleVersion¶
-
TiaPortalProjectSettingsBuilder.LockCompatibleVersion¶ Lock the compatible version setting
Signature
LockCompatibleVersion()New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Validate¶
-
TiaPortalProjectSettingsBuilder.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.