TagFormBuilder Class¶
-
class
NXOpen.Mechatronics.TagFormBuilder¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.Mechatronics.TagFormBuilder.To create a new instance of this class, use
NXOpen.Mechatronics.TagFormCollection.CreateTagFormBuilder()New in version NX10.0.0.
Properties¶
| Property | Description |
|---|---|
| Name | Returns or sets the name. |
| ParameterStock | Returns the parameter stock builder that holds the parameter data. |
| 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¶
Name¶
-
TagFormBuilder.Name¶ Returns or sets the name.
-------------------------------------Getter Method
Signature
NameReturns: Return type: str New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
NameParameters: name (str) – New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
ParameterStock¶
-
TagFormBuilder.ParameterStock¶ Returns the parameter stock builder that holds the parameter data.
-------------------------------------Getter Method
Signature
ParameterStockReturns: Return type: NXOpen.Mechatronics.ParameterStockBuilderNew in version NX10.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
TagFormBuilder.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.