GeneralCouplerBuilder Class¶
-
class
NXOpen.Motion.
GeneralCouplerBuilder
¶ Bases:
NXOpen.Motion.MotionBuilder
Represents a
NXOpen.Motion.GeneralCouplerBuilder
To create a new instance of this class, use
NXOpen.Motion.GeneralCouplerCollection.CreateGeneralCouplerBuilder()
Default values.
Property Value DisplayScale 1.0 FirstScaleExpression.Value 1.0 SecondScaleExpression.Value 1.0 ThirdScaleExpression.Value 1.0 New in version NX7.5.0.
Properties¶
Property | Description |
---|---|
Attachment | Returns or sets the attachment type |
DisplayScale | Returns or sets the icon display scale |
FirstJoint | Returns the selected first joint |
FirstScale | Returns or sets the first joint scale |
FirstScaleExpression | Returns the first scale expression |
FirstType | Returns or sets the first joint movement type |
GroupName | Returns or sets the group name |
GroupType | Returns or sets the group type |
Name | Returns or sets the 2-3 joint coupler name |
SecondJoint | Returns the selected second joint |
SecondScale | Returns or sets the second joint scale |
SecondScaleExpression | Returns the second scale expression |
SecondType | Returns or sets the second joint movement type |
Tag | Returns the Tag for this object. |
ThirdJoint | Returns the selected third joint |
ThirdScale | Returns or sets the third joint scale |
ThirdScaleExpression | Returns the third scale expression |
ThirdType | Returns or sets the third joint movement 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¶
GeneralCouplerBuilderAttachmentType Enumeration | Definitions of joint coupler attachment type |
Property Detail¶
Attachment¶
-
GeneralCouplerBuilder.
Attachment
¶ Returns or sets the attachment type
-------------------------------------
Getter Method
Signature
Attachment()
Returns: Return type: NXOpen.Motion.GeneralCouplerBuilderAttachmentType
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Attachment(attachment)
Parameters: attachment ( NXOpen.Motion.GeneralCouplerBuilderAttachmentType
) –New in version NX7.5.0.
License requirements: mechanisms (“MECHANISMS”)
FirstJoint¶
-
GeneralCouplerBuilder.
FirstJoint
¶ Returns the selected first joint
-------------------------------------
Getter Method
Signature
FirstJoint()
Returns: Return type: NXOpen.Motion.SelectJoint
New in version NX7.5.0.
License requirements: None.
FirstScale¶
-
GeneralCouplerBuilder.
FirstScale
¶ Returns or sets the first joint scale
-------------------------------------
Getter Method
Signature
FirstScale()
Returns: Return type: float New in version NX7.5.0.
Deprecated since version NX8.5.0: Obtion the exression using
NXOpen.Motion.GeneralCouplerBuilder.FirstScaleExpression()
to query or edit it.License requirements: None.
-------------------------------------
Setter Method
Signature
FirstScale(firstScale)
Parameters: firstScale (float) – New in version NX7.5.0.
Deprecated since version NX8.5.0: Obtion the exression using
NXOpen.Motion.GeneralCouplerBuilder.FirstScaleExpression()
to query or edit it.License requirements: mechanisms (“MECHANISMS”)
FirstScaleExpression¶
-
GeneralCouplerBuilder.
FirstScaleExpression
¶ Returns the first scale expression
-------------------------------------
Getter Method
Signature
FirstScaleExpression()
Returns: Return type: NXOpen.Expression
New in version NX8.5.0.
License requirements: None.
FirstType¶
-
GeneralCouplerBuilder.
FirstType
¶ Returns or sets the first joint movement type
-------------------------------------
Getter Method
Signature
FirstType()
Returns: Return type: NXOpen.Motion.GcouplerMovementTypes
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FirstType(firstType)
Parameters: firstType ( NXOpen.Motion.GcouplerMovementTypes
) –New in version NX7.5.0.
License requirements: mechanisms (“MECHANISMS”)
Name¶
-
GeneralCouplerBuilder.
Name
¶ Returns or sets the 2-3 joint coupler name
-------------------------------------
Getter Method
Signature
Name()
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Name(name)
Parameters: name (str) – New in version NX7.5.0.
License requirements: mechanisms (“MECHANISMS”)
SecondJoint¶
-
GeneralCouplerBuilder.
SecondJoint
¶ Returns the selected second joint
-------------------------------------
Getter Method
Signature
SecondJoint()
Returns: Return type: NXOpen.Motion.SelectJoint
New in version NX7.5.0.
License requirements: None.
SecondScale¶
-
GeneralCouplerBuilder.
SecondScale
¶ Returns or sets the second joint scale
-------------------------------------
Getter Method
Signature
SecondScale()
Returns: Return type: float New in version NX7.5.0.
Deprecated since version NX8.5.0: Obtion the exression using
NXOpen.Motion.GeneralCouplerBuilder.SecondScaleExpression()
to query or edit it.License requirements: None.
-------------------------------------
Setter Method
Signature
SecondScale(secondScale)
Parameters: secondScale (float) – New in version NX7.5.0.
Deprecated since version NX8.5.0: Obtion the exression using
NXOpen.Motion.GeneralCouplerBuilder.SecondScaleExpression()
to query or edit it.License requirements: mechanisms (“MECHANISMS”)
SecondScaleExpression¶
-
GeneralCouplerBuilder.
SecondScaleExpression
¶ Returns the second scale expression
-------------------------------------
Getter Method
Signature
SecondScaleExpression()
Returns: Return type: NXOpen.Expression
New in version NX8.5.0.
License requirements: None.
SecondType¶
-
GeneralCouplerBuilder.
SecondType
¶ Returns or sets the second joint movement type
-------------------------------------
Getter Method
Signature
SecondType()
Returns: Return type: NXOpen.Motion.GcouplerMovementTypes
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SecondType(secondType)
Parameters: secondType ( NXOpen.Motion.GcouplerMovementTypes
) –New in version NX7.5.0.
License requirements: mechanisms (“MECHANISMS”)
ThirdJoint¶
-
GeneralCouplerBuilder.
ThirdJoint
¶ Returns the selected third joint
-------------------------------------
Getter Method
Signature
ThirdJoint()
Returns: Return type: NXOpen.Motion.SelectJoint
New in version NX7.5.0.
License requirements: None.
ThirdScale¶
-
GeneralCouplerBuilder.
ThirdScale
¶ Returns or sets the third joint scale
-------------------------------------
Getter Method
Signature
ThirdScale()
Returns: Return type: float New in version NX7.5.0.
Deprecated since version NX8.5.0: Obtion the exression using
NXOpen.Motion.GeneralCouplerBuilder.ThirdScaleExpression()
to query or edit it.License requirements: None.
-------------------------------------
Setter Method
Signature
ThirdScale(thirdScale)
Parameters: thirdScale (float) – New in version NX7.5.0.
Deprecated since version NX8.5.0: Obtion the exression using
NXOpen.Motion.GeneralCouplerBuilder.ThirdScaleExpression()
to query or edit it.License requirements: mechanisms (“MECHANISMS”)
ThirdScaleExpression¶
-
GeneralCouplerBuilder.
ThirdScaleExpression
¶ Returns the third scale expression
-------------------------------------
Getter Method
Signature
ThirdScaleExpression()
Returns: Return type: NXOpen.Expression
New in version NX8.5.0.
License requirements: None.
ThirdType¶
-
GeneralCouplerBuilder.
ThirdType
¶ Returns or sets the third joint movement type
-------------------------------------
Getter Method
Signature
ThirdType()
Returns: Return type: NXOpen.Motion.GcouplerMovementTypes
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ThirdType(thirdType)
Parameters: thirdType ( NXOpen.Motion.GcouplerMovementTypes
) –New in version NX7.5.0.
License requirements: mechanisms (“MECHANISMS”)
Method Detail¶
Validate¶
-
GeneralCouplerBuilder.
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.