SymbolCatalogParameterBuilder Class¶
-
class
NXOpen.Annotations.SymbolCatalogParameterBuilder¶ Bases:
NXOpen.BuilderThis builder allows you to define one parameter for a symbol
To create a new instance of this class, use
NXOpen.Annotations.SymbolCatalogBuilder.NewParameter()New in version NX8.0.0.
Properties¶
| Property | Description |
|---|---|
| Label | Returns or sets the label string of the parameter, NOTE: Client must free the returned char* with SM_free |
| LogicalName | Returns or sets the logical name of the parameter, NOTE: Client must free the returned char* with SM_free |
| Tag | Returns the Tag for this object. |
| Value | Returns or sets the value string of the parameter, NOTE: Client must free the returned char* with SM_free |
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¶
Label¶
-
SymbolCatalogParameterBuilder.Label¶ Returns or sets the label string of the parameter, NOTE: Client must free the returned char* with SM_free
-------------------------------------Getter Method
Signature
LabelReturns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LabelParameters: label (str) – New in version NX8.0.0.
License requirements: nx_layout (“NX Layout”)
LogicalName¶
-
SymbolCatalogParameterBuilder.LogicalName¶ Returns or sets the logical name of the parameter, NOTE: Client must free the returned char* with SM_free
-------------------------------------Getter Method
Signature
LogicalNameReturns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LogicalNameParameters: name (str) – New in version NX8.0.0.
License requirements: nx_layout (“NX Layout”)
Value¶
-
SymbolCatalogParameterBuilder.Value¶ Returns or sets the value string of the parameter, NOTE: Client must free the returned char* with SM_free
-------------------------------------Getter Method
Signature
ValueReturns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ValueParameters: paraValue (str) – New in version NX8.0.0.
License requirements: nx_layout (“NX Layout”)
Method Detail¶
Validate¶
-
SymbolCatalogParameterBuilder.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.