PlantOutputBuilder Class¶
-
class
NXOpen.Motion.PlantOutputBuilder¶ Bases:
NXOpen.Motion.MotionBuilderRepresents a
NXOpen.Motion.PlantOutputbuilderTo create a new instance of this class, use
NXOpen.Motion.PlantOutputCollection.CreatePlantOutputBuilder()New in version NX6.0.0.
Properties¶
| Property | Description |
|---|---|
| DisplayScale | Returns or sets the icon display scale |
| Function | Returns or sets the function |
| GroupName | Returns or sets the group name |
| GroupType | Returns or sets the group type |
| Name | Returns or sets the name |
| Sensor | Returns or sets the sensor |
| Tag | Returns the Tag for this object. |
| Type | Returns or sets the type |
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. |
Enumerations¶
| PlantOutputBuilderPoutype Enumeration | the type enum |
Property Detail¶
Function¶
-
PlantOutputBuilder.Function¶ Returns or sets the function
-------------------------------------Getter Method
Signature
FunctionReturns: Return type: NXOpen.CAE.FunctionNew in version NX6.0.0.
License requirements: nx_motion_cosim (“NX Motion CoSimulation”)
-------------------------------------Setter Method
Signature
FunctionParameters: function ( NXOpen.CAE.Function) –New in version NX6.0.0.
License requirements: nx_motion_cosim (“NX Motion CoSimulation”)
Name¶
-
PlantOutputBuilder.Name¶ Returns or sets the name
-------------------------------------Getter Method
Signature
NameReturns: Return type: str New in version NX6.0.0.
License requirements: nx_motion_cosim (“NX Motion CoSimulation”)
-------------------------------------Setter Method
Signature
NameParameters: name (str) – New in version NX6.0.0.
License requirements: nx_motion_cosim (“NX Motion CoSimulation”)
Sensor¶
-
PlantOutputBuilder.Sensor¶ Returns or sets the sensor
-------------------------------------Getter Method
Signature
SensorReturns: Return type: NXOpen.NXObjectNew in version NX6.0.0.
License requirements: nx_motion_cosim (“NX Motion CoSimulation”)
-------------------------------------Setter Method
Signature
SensorParameters: sensor ( NXOpen.NXObject) –New in version NX6.0.0.
License requirements: nx_motion_cosim (“NX Motion CoSimulation”)
Type¶
-
PlantOutputBuilder.Type¶ Returns or sets the type
-------------------------------------Getter Method
Signature
TypeReturns: Return type: NXOpen.Motion.PlantOutputBuilderPoutypeNew in version NX6.0.0.
License requirements: nx_motion_cosim (“NX Motion CoSimulation”)
-------------------------------------Setter Method
Signature
TypeParameters: type ( NXOpen.Motion.PlantOutputBuilderPoutype) –New in version NX6.0.0.
License requirements: nx_motion_cosim (“NX Motion CoSimulation”)
Method Detail¶
Validate¶
-
PlantOutputBuilder.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.