SymbolTableBuilder Class¶
-
class
NXOpen.Mechatronics.
SymbolTableBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.Mechatronics.SymbolTableBuilder
builder.SymbolTableBuilder is used to maintain the
NXOpen.Mechatronics.SymbolTable
which is used for Signal creation.To create a new instance of this class, use
NXOpen.Mechatronics.SymbolTableCollection.CreateSymbolTableBuilder()
New in version NX11.0.0.
Properties¶
Property | Description |
---|---|
Name | Returns or sets the name. |
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. |
GetSymbols | Gets all Symbols. |
SetSymbols | Sets all Symbols. |
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¶
SymbolTableBuilderDataType Enumeration | Represents the data type. |
SymbolTableBuilderIOType Enumeration | Represents the IO type. |
Structs¶
SymbolTableBuilderSymbol_Struct Struct |
|
Property Detail¶
Name¶
-
SymbolTableBuilder.
Name
¶ Returns or sets the name.
-------------------------------------
Getter Method
Signature
Name
Returns: Return type: str New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Name
Parameters: name (str) – New in version NX11.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Method Detail¶
GetSymbols¶
-
SymbolTableBuilder.
GetSymbols
¶ Gets all Symbols.
Signature
GetSymbols()
Returns: Array of Symbols Return type: list of NXOpen.Mechatronics.SymbolTableBuilderSymbol_Struct
New in version NX11.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
SetSymbols¶
-
SymbolTableBuilder.
SetSymbols
¶ Sets all Symbols.
Each Symbol name must be unique in the context of input Symbol list. Or the builder will raise an exception.
Signature
SetSymbols(symbols)
Parameters: symbols (list of NXOpen.Mechatronics.SymbolTableBuilderSymbol_Struct
) – Array of SymbolsNew in version NX11.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Validate¶
-
SymbolTableBuilder.
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.