ControlInputBuilder Class¶
-
class
NXOpen.Motion.ControlInputBuilder¶ Bases:
NXOpen.Motion.MotionBuilderRepresents a
Motion.ControlInputbuilderTo create a new instance of this class, use
NXOpen.Motion.ControlInputCollection.CreateControlInputBuilder()New in version NX11.0.0.
Properties¶
| Property | Description |
|---|---|
| DisplayScale | Returns or sets the icon display scale |
| GroupName | Returns or sets the group name |
| GroupType | Returns or sets the group type |
| MeasurementLinkAttachment | Returns the measurement link attachment. |
| Name | Returns or sets the control input name. |
| PortsList | Returns the list of all child control input ports. |
| ReferenceLinkAttachment | Returns the reference link attachment and its components are optional. |
| RelativeLinkAttachment | Returns the relative link attachment and its components are optional. |
| Tag | Returns the Tag for this object. |
| Type | Returns or sets the type of control input element. |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| CreateControlInputPortBuilder | Creates a new control input port item and adds to the PortsList. |
| 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¶
| ControlInputBuilderInputType Enumeration | Control Input type |
Property Detail¶
MeasurementLinkAttachment¶
-
ControlInputBuilder.MeasurementLinkAttachment¶ Returns the measurement link attachment.
The control input element measures the kinematic variables at the reference frame defined by this attachment.
-------------------------------------Getter Method
Signature
MeasurementLinkAttachmentReturns: Return type: NXOpen.Motion.LinkAttachmentDataNew in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
Name¶
-
ControlInputBuilder.Name¶ Returns or sets the control input name.
Must be unique across all motion elements.
-------------------------------------Getter Method
Signature
NameReturns: Return type: str New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------Setter Method
Signature
NameParameters: name (str) – New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
PortsList¶
-
ControlInputBuilder.PortsList¶ Returns the list of all child control input ports.
-------------------------------------Getter Method
Signature
PortsListReturns: Return type: NXOpen.Motion.ControlInputPortBuilderListNew in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
ReferenceLinkAttachment¶
-
ControlInputBuilder.ReferenceLinkAttachment¶ Returns the reference link attachment and its components are optional.
When the link, point or csys are not defined, they are interpreted as ground link, ground origin or ground csys respectively. The measurement is computed in the reference frame defined by this attachment.
-------------------------------------Getter Method
Signature
ReferenceLinkAttachmentReturns: Return type: NXOpen.Motion.LinkAttachmentDataNew in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
RelativeLinkAttachment¶
-
ControlInputBuilder.RelativeLinkAttachment¶ Returns the relative link attachment and its components are optional.
When the link, point or csys are not defined, they are interpreted as ground link, ground origin or ground csys respectively. The measurement is made relative to the reference frame defined by this attachment.
-------------------------------------Getter Method
Signature
RelativeLinkAttachmentReturns: Return type: NXOpen.Motion.LinkAttachmentDataNew in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
Type¶
-
ControlInputBuilder.Type¶ Returns or sets the type of control input element.
Link is the default value
-------------------------------------Getter Method
Signature
TypeReturns: Return type: NXOpen.Motion.ControlInputBuilderInputTypeNew in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------Setter Method
Signature
TypeParameters: type ( NXOpen.Motion.ControlInputBuilderInputType) –New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
Method Detail¶
CreateControlInputPortBuilder¶
-
ControlInputBuilder.CreateControlInputPortBuilder¶ Creates a new control input port item and adds to the PortsList.
Signature
CreateControlInputPortBuilder()Returns: Return type: NXOpen.Motion.ControlInputPortBuilderNew in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
Validate¶
-
ControlInputBuilder.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.