LinkCouplerBuilder Class

class NXOpen.Motion.LinkCouplerBuilder

Bases: NXOpen.Motion.MotionBuilder

Represents a NXOpen.Motion.LinkCouplerBuilder

To create a new instance of this class, use NXOpen.Motion.LinkCouplerCollection.CreateLinkCouplerBuilder()

Default values.

Property Value
DisplayScale 1.0

New in version NX12.0.0.

Properties

Property Description
Curve Returns or sets the coupling curve function
CurveProfile Returns the profile
CurveType Returns or sets the coupling curve type
DisplayScale Returns or sets the icon display scale
FirstCouple Returns the first couple
GroupName Returns or sets the group name
GroupType Returns or sets the group type
Method Returns or sets the method
Name Returns or sets the unique name assigned to the Link Coupler component
SecondCouple Returns the second couple
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

LinkCouplerBuilderCurveChoices Enumeration the LinkCoupler Curve type.
LinkCouplerBuilderMethodChoices Enumeration the LinkCoupler method.
LinkCouplerBuilderTypeChoices Enumeration the LinkCoupler type.

Property Detail

Curve

LinkCouplerBuilder.Curve

Returns or sets the coupling curve function

-------------------------------------

Getter Method

Signature Curve

Returns:
Return type:NXOpen.Motion.MotionFunction

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature Curve

Parameters:spline (NXOpen.Motion.MotionFunction) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

CurveProfile

LinkCouplerBuilder.CurveProfile

Returns the profile

-------------------------------------

Getter Method

Signature CurveProfile

Returns:
Return type:NXOpen.Motion.SelectFieldData

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

CurveType

LinkCouplerBuilder.CurveType

Returns or sets the coupling curve type

-------------------------------------

Getter Method

Signature CurveType

Returns:
Return type:NXOpen.Motion.LinkCouplerBuilderCurveChoices

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature CurveType

Parameters:type (NXOpen.Motion.LinkCouplerBuilderCurveChoices) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

FirstCouple

LinkCouplerBuilder.FirstCouple

Returns the first couple

-------------------------------------

Getter Method

Signature FirstCouple

Returns:
Return type:NXOpen.Motion.LinkCouplerCoupleBuilder

New in version NX12.0.0.

License requirements: None.

Method

LinkCouplerBuilder.Method

Returns or sets the method

-------------------------------------

Getter Method

Signature Method

Returns:
Return type:NXOpen.Motion.LinkCouplerBuilderMethodChoices

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature Method

Parameters:method (NXOpen.Motion.LinkCouplerBuilderMethodChoices) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

Name

LinkCouplerBuilder.Name

Returns or sets the unique name assigned to the Link Coupler component

-------------------------------------

Getter Method

Signature Name

Returns:
Return type:str

New in version NX12.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Name

Parameters:name (str) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

SecondCouple

LinkCouplerBuilder.SecondCouple

Returns the second couple

-------------------------------------

Getter Method

Signature SecondCouple

Returns:
Return type:NXOpen.Motion.LinkCouplerCoupleBuilder

New in version NX12.0.0.

License requirements: None.

Type

LinkCouplerBuilder.Type

Returns or sets the type

-------------------------------------

Getter Method

Signature Type

Returns:
Return type:NXOpen.Motion.LinkCouplerBuilderTypeChoices

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature Type

Parameters:type (NXOpen.Motion.LinkCouplerBuilderTypeChoices) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

Method Detail

Validate

LinkCouplerBuilder.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.