ControlOutputBuilder Class¶
-
class
NXOpen.Motion.
ControlOutputBuilder
¶ Bases:
NXOpen.Motion.MotionBuilder
Represents a
Motion.ControlOutput
builderTo create a new instance of this class, use
NXOpen.Motion.ControlOutputCollection.CreateControlOutputBuilder()
Default values.
Property Value Direction Z OutputType Link Variable Force New in version NX11.0.0.
Properties¶
Property | Description |
---|---|
ActionLinkAttachment | Returns the action link attachment. |
BaseLinkAttachment | Returns the base link attachment. |
Direction | Returns or sets the control Output Variable direction. |
DisplayScale | Returns or sets the icon display scale |
GroupName | Returns or sets the group name |
GroupType | Returns or sets the group type |
JointSelection | Returns the joint selection. |
Name | Returns or sets the name of the control output element. |
OutputType | Returns or sets the Control Output type. |
PortSelection | Returns the control output port |
Tag | Returns the Tag for this object. |
Variable | Returns or sets the control Output Variable 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¶
ControlOutputBuilderControlOutputType Enumeration | Control Output type |
ControlOutputBuilderDirectionType Enumeration | Output Variable Direction |
ControlOutputBuilderVariableType Enumeration | Output Variable type |
Property Detail¶
ActionLinkAttachment¶
-
ControlOutputBuilder.
ActionLinkAttachment
¶ Returns the action link attachment.
Required in type of Control Output is Link.
-------------------------------------
Getter Method
Signature
ActionLinkAttachment
Returns: Return type: NXOpen.Motion.LinkAttachmentData
New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
BaseLinkAttachment¶
-
ControlOutputBuilder.
BaseLinkAttachment
¶ Returns the base link attachment.
Used if the type of Control Output is Link.
-------------------------------------
Getter Method
Signature
BaseLinkAttachment
Returns: Return type: NXOpen.Motion.LinkAttachmentData
New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
Direction¶
-
ControlOutputBuilder.
Direction
¶ Returns or sets the control Output Variable direction.
Default Control Output Variable Direction is Z direction.
-------------------------------------
Getter Method
Signature
Direction
Returns: Return type: NXOpen.Motion.ControlOutputBuilderDirectionType
New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------
Setter Method
Signature
Direction
Parameters: direction ( NXOpen.Motion.ControlOutputBuilderDirectionType
) –New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
JointSelection¶
-
ControlOutputBuilder.
JointSelection
¶ Returns the joint selection.
Required if the type of Control Output is Joint/Constraint.
-------------------------------------
Getter Method
Signature
JointSelection
Returns: Return type: NXOpen.Motion.SelectJoint
New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
Name¶
-
ControlOutputBuilder.
Name
¶ Returns or sets the name of the control output element.
Must be unique across all motion elements. An unique name is set by default.
-------------------------------------
Getter Method
Signature
Name
Returns: Return type: str New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------
Setter Method
Signature
Name
Parameters: name (str) – New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
OutputType¶
-
ControlOutputBuilder.
OutputType
¶ Returns or sets the Control Output type.
Default Control Output Type is Link.
-------------------------------------
Getter Method
Signature
OutputType
Returns: Return type: NXOpen.Motion.ControlOutputBuilderControlOutputType
New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------
Setter Method
Signature
OutputType
Parameters: outputType ( NXOpen.Motion.ControlOutputBuilderControlOutputType
) –New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
PortSelection¶
-
ControlOutputBuilder.
PortSelection
¶ Returns the control output port
-------------------------------------
Getter Method
Signature
PortSelection
Returns: Return type: NXOpen.Motion.SelectControlPort
New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
Variable¶
-
ControlOutputBuilder.
Variable
¶ Returns or sets the control Output Variable type.
Default Control Output Variable Type is Force.
-------------------------------------
Getter Method
Signature
Variable
Returns: Return type: NXOpen.Motion.ControlOutputBuilderVariableType
New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------
Setter Method
Signature
Variable
Parameters: variable ( NXOpen.Motion.ControlOutputBuilderVariableType
) –New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
Method Detail¶
Validate¶
-
ControlOutputBuilder.
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.