Represents a NXOpen::Motion::LinkCouplerBuilder
To create a new instance of this class, use NXOpen::Motion::LinkCouplerCollection::CreateLinkCouplerBuilder
Default values. More...

Inheritance diagram for NXOpen::Motion::LinkCouplerBuilder:

Public Types
enum	CurveChoices { CurveChoicesFunction, CurveChoicesProfile }
	the LinkCoupler Curve type. More...

enum	MethodChoices { MethodChoicesScales, MethodChoicesCouplingCurve }
	the LinkCoupler method. More...

enum	TypeChoices { TypeChoicesTwoLink, TypeChoicesThreeLink, TypeChoicesFourLink }
	the LinkCoupler type. More...

Public Member Functions
NXOpen::Motion::MotionFunction *	Curve ()
	Returns the coupling curve function Created in NX12.0.0. More...

NXOpen::Motion::SelectFieldData *	CurveProfile ()
	Returns the profile Created in NX12.0.0. More...

NXOpen::Motion::LinkCouplerBuilder::CurveChoices	CurveType ()
	Returns the coupling curve type Created in NX12.0.0. More...

NXOpen::Motion::LinkCouplerCoupleBuilder *	FirstCouple ()
	Returns the first couple Created in NX12.0.0. More...

NXOpen::Motion::LinkCouplerBuilder::MethodChoices	Method ()
	Returns the method Created in NX12.0.0. More...

NXString	Name ()
	Returns the unique name assigned to the Link Coupler component Created in NX12.0.0. More...

NXOpen::Motion::LinkCouplerCoupleBuilder *	SecondCouple ()
	Returns the second couple Created in NX12.0.0. More...

void	SetCurve (NXOpen::Motion::MotionFunction *spline)
	Sets the coupling curve function Created in NX12.0.0. More...

void	SetCurveType (NXOpen::Motion::LinkCouplerBuilder::CurveChoices type)
	Sets the coupling curve type Created in NX12.0.0. More...

void	SetMethod (NXOpen::Motion::LinkCouplerBuilder::MethodChoices method)
	Sets the method Created in NX12.0.0. More...

void	SetName (const NXString &name)
	Sets the unique name assigned to the Link Coupler component Created in NX12.0.0. More...

void	SetName (const char *name)
	Sets the unique name assigned to the Link Coupler component Created in NX12.0.0. More...

void	SetType (NXOpen::Motion::LinkCouplerBuilder::TypeChoices type)
	Sets the type Created in NX12.0.0. More...

NXOpen::Motion::LinkCouplerBuilder::TypeChoices	Type ()
	Returns the type Created in NX12.0.0. More...

Public Member Functions inherited from NXOpen::Motion::MotionBuilder
double	DisplayScale ()
	Returns the icon display scale Created in NX5.0.0. More...

NXString	GroupName ()
	Returns the group name Created in NX5.0.0. More...

NXOpen::Motion::MotionObject::GroupType	GroupType ()
	Returns the group type Created in NX5.0.0. More...

void	SetDisplayScale (double displayScale)
	Sets the icon display scale Created in NX5.0.0. More...

void	SetGroupName (const NXString &groupName)
	Sets the group name Created in NX5.0.0. More...

void	SetGroupName (const char *groupName)
	Sets the group name Created in NX5.0.0. More...

void	SetGroupType (NXOpen::Motion::MotionObject::GroupType groupType)
	Sets the group type Created in NX5.0.0. More...

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder. More...

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder. More...

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

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

Created in NX12.0.0.

Member Enumeration Documentation

enum NXOpen::Motion::LinkCouplerBuilder::CurveChoices

the LinkCoupler Curve type.

Enumerator
CurveChoicesFunction	Function.
CurveChoicesProfile	Profile.

enum NXOpen::Motion::LinkCouplerBuilder::MethodChoices

the LinkCoupler method.

Enumerator
MethodChoicesScales	Scales.
MethodChoicesCouplingCurve	Coupling Curve.

enum NXOpen::Motion::LinkCouplerBuilder::TypeChoices

the LinkCoupler type.

Enumerator
TypeChoicesTwoLink	2-Link
TypeChoicesThreeLink	3-Link
TypeChoicesFourLink	4-Link

Member Function Documentation

NXOpen::Motion::MotionFunction* NXOpen::Motion::LinkCouplerBuilder::Curve ( )

Returns the coupling curve function
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::SelectFieldData* NXOpen::Motion::LinkCouplerBuilder::CurveProfile ( )

Returns the profile
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::LinkCouplerBuilder::CurveChoices NXOpen::Motion::LinkCouplerBuilder::CurveType ( )

Returns the coupling curve type
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::LinkCouplerCoupleBuilder* NXOpen::Motion::LinkCouplerBuilder::FirstCouple ( )

Returns the first couple
Created in NX12.0.0.

License requirements : None

NXOpen::Motion::LinkCouplerBuilder::MethodChoices NXOpen::Motion::LinkCouplerBuilder::Method ( )

Returns the method
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

NXString NXOpen::Motion::LinkCouplerBuilder::Name ( )

Returns the unique name assigned to the Link Coupler component
Created in NX12.0.0.

License requirements : None

NXOpen::Motion::LinkCouplerCoupleBuilder* NXOpen::Motion::LinkCouplerBuilder::SecondCouple ( )

Returns the second couple
Created in NX12.0.0.

License requirements : None

void NXOpen::Motion::LinkCouplerBuilder::SetCurve ( NXOpen::Motion::MotionFunction * spline )

Sets the coupling curve function
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

spline spline

void NXOpen::Motion::LinkCouplerBuilder::SetCurveType ( NXOpen::Motion::LinkCouplerBuilder::CurveChoices type )

Sets the coupling curve type
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

type type

void NXOpen::Motion::LinkCouplerBuilder::SetMethod ( NXOpen::Motion::LinkCouplerBuilder::MethodChoices method )

Sets the method
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

method method

void NXOpen::Motion::LinkCouplerBuilder::SetName ( const NXString & name )

Sets the unique name assigned to the Link Coupler component
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

name name

void NXOpen::Motion::LinkCouplerBuilder::SetName ( const char * name )

Sets the unique name assigned to the Link Coupler component
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

name name

void NXOpen::Motion::LinkCouplerBuilder::SetType ( NXOpen::Motion::LinkCouplerBuilder::TypeChoices type )

Sets the type
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

type type

NXOpen::Motion::LinkCouplerBuilder::TypeChoices NXOpen::Motion::LinkCouplerBuilder::Type ( )

Returns the type
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

The documentation for this class was generated from the following file:

Motion_LinkCouplerBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation