AdapterSignalBuilder Class¶
-
class
NXOpen.Mechatronics.AdapterSignalBuilder¶ Bases:
NXOpen.Mechatronics.ProxyObjectBuilderRepresents a
NXOpen.Mechatronics.AdapterSignalBuilder.To create a new instance of this class, use
NXOpen.Mechatronics.AdapterSignalCollection.CreateAdapterSignalBuilder()New in version NX8.5.0.
Properties¶
| Property | Description |
|---|---|
| AssignedFormula | Returns or sets the assigned formula. |
| BuilderType | Returns or sets the use type of this builder. |
| Context | Returns or sets the context part of the proxy object |
| InputOutput | Returns or sets the input/output (0 - Input, 1 - Output). |
| MaxParamId | Returns or sets the maximum parameter id used in the proxy object |
| ParameterList | Returns the parameter data |
| ProxyObjectName | Returns or sets the name of the proxy object |
| SelectGeomObject | Returns the select geometry object that describes the proxy object |
| SelectPhysicsObject | Returns the select physics objects that are encapsulated in the proxy object |
| Tag | Returns the Tag for this object. |
| UseType | Returns or sets the use type used in the proxy 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¶
AssignedFormula¶
-
AdapterSignalBuilder.AssignedFormula¶ Returns or sets the assigned formula.
-------------------------------------Getter Method
Signature
AssignedFormulaReturns: Return type: NXOpen.Mechatronics.AdapterFormulaNew in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------Setter Method
Signature
AssignedFormulaParameters: assignedFormula ( NXOpen.Mechatronics.AdapterFormula) –New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
InputOutput¶
-
AdapterSignalBuilder.InputOutput¶ Returns or sets the input/output (0 - Input, 1 - Output).
-------------------------------------Getter Method
Signature
InputOutputReturns: Return type: int New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------Setter Method
Signature
InputOutputParameters: inputOutput (int) – New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Method Detail¶
Validate¶
-
AdapterSignalBuilder.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.