RelayBuilder Class¶
-
class
NXOpen.Mechatronics.RelayBuilder¶ Bases:
NXOpen.Mechatronics.PhysicsConstraintBuilderRepresents a
NXOpen.Mechatronics.Relaybuilder.To create a new instance of this class, use
NXOpen.Mechatronics.RelayCollection.CreateRelayBuilder()New in version NX11.0.0.
Properties¶
| Property | Description |
|---|---|
| LowerLimit | Returns the lower switch point used to judge whether need to switch the state. |
| Name | Returns or sets the name. |
| PersistentTag | Returns or sets the Persistent Tag used in the physics object |
| SelectedPhysicsObject | Returns the physics select. This can be a physics object. |
| Tag | Returns the Tag for this object. |
| UpperLimit | Returns the upper switch point used to judge whether need to switch the state. |
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¶
LowerLimit¶
-
RelayBuilder.LowerLimit¶ Returns the lower switch point used to judge whether need to switch the state.
-------------------------------------Getter Method
Signature
LowerLimitReturns: Return type: NXOpen.ExpressionNew in version NX11.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
PersistentTag¶
-
RelayBuilder.PersistentTag¶ Returns or sets the Persistent Tag used in the physics object
-------------------------------------Getter Method
Signature
PersistentTagReturns: Return type: int New in version NX11.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------Setter Method
Signature
PersistentTagParameters: persistentTag (int) – New in version NX11.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
SelectedPhysicsObject¶
-
RelayBuilder.SelectedPhysicsObject¶ Returns the physics select. This can be a physics object.
-------------------------------------Getter Method
Signature
SelectedPhysicsObjectReturns: Return type: NXOpen.SelectNXObjectNew in version NX11.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
UpperLimit¶
-
RelayBuilder.UpperLimit¶ Returns the upper switch point used to judge whether need to switch the state.
-------------------------------------Getter Method
Signature
UpperLimitReturns: Return type: NXOpen.ExpressionNew in version NX11.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Method Detail¶
Validate¶
-
RelayBuilder.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.