SubnetBuilder Class¶
-
class
NXOpen.AME.SubnetBuilder¶ Bases:
NXOpen.BuilderRepresents a Subnet creation class Builder
To create a new instance of this class, use
NXOpen.AME.AMEManager.CreateSubnetBuilder()New in version NX12.0.0.
Properties¶
| Property | Description |
|---|---|
| Description | Returns or sets the subnet description |
| Name | Returns or sets the subnet name |
| SelectionObject | Returns the selection object which is parent station. |
| Tag | Returns the Tag for this object. |
| Types | Returns or sets the subnet type |
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¶
Description¶
-
SubnetBuilder.Description¶ Returns or sets the subnet description
-------------------------------------Getter Method
Signature
DescriptionReturns: Return type: str New in version NX12.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DescriptionParameters: description (str) – New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Name¶
-
SubnetBuilder.Name¶ Returns or sets the subnet name
-------------------------------------Getter Method
Signature
NameReturns: Return type: str New in version NX12.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
NameParameters: name (str) – New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
SelectionObject¶
-
SubnetBuilder.SelectionObject¶ Returns the selection object which is parent station.
-------------------------------------Getter Method
Signature
SelectionObjectReturns: Return type: NXOpen.SelectNXObjectNew in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Types¶
-
SubnetBuilder.Types¶ Returns or sets the subnet type
-------------------------------------Getter Method
Signature
TypesReturns: Return type: str New in version NX12.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TypesParameters: types (str) – New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Method Detail¶
Validate¶
-
SubnetBuilder.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.