Represents a @link Motion::GeneralCouplerBuilder Motion::GeneralCouplerBuilder@endlink   <br> To create a new instance of this class, use @link Motion::GeneralCouplerCollection::CreateGeneralCouplerBuilder  Motion::GeneralCouplerCollection::CreateGeneralCouplerBuilder @endlink  <br>

Default values. More...

Inheritance diagram for NXOpen::Motion::GeneralCouplerBuilder:

Public Types
enum	AttachmentType { AttachmentTypeTwo, AttachmentTypeThree }
	Definitions of joint coupler attachment type. More...

Public Member Functions
NXOpen::Motion::GeneralCouplerBuilder::AttachmentType	Attachment ()
	Returns the attachment type Created in NX7.5.0.

NXOpen::Motion::SelectJoint *	FirstJoint ()
	Returns the selected first joint Created in NX7.5.0.

double	FirstScale ()
	Returns the first joint scale

NXOpen::Expression *	FirstScaleExpression ()
	Returns the first scale expression Created in NX8.5.0.

NXOpen::Motion::GcouplerMovementTypes	FirstType ()
	Returns the first joint movement type Created in NX7.5.0.

NXString	Name ()
	Returns the 2-3 joint coupler name Created in NX7.5.0.

NXOpen::Motion::SelectJoint *	SecondJoint ()
	Returns the selected second joint Created in NX7.5.0.

double	SecondScale ()
	Returns the second joint scale

NXOpen::Expression *	SecondScaleExpression ()
	Returns the second scale expression Created in NX8.5.0.

NXOpen::Motion::GcouplerMovementTypes	SecondType ()
	Returns the second joint movement type Created in NX7.5.0.

void	SetAttachment (NXOpen::Motion::GeneralCouplerBuilder::AttachmentType attachment)
	Sets the attachment type Created in NX7.5.0.

void	SetFirstScale (double firstScale)
	Sets the first joint scale

void	SetFirstType (NXOpen::Motion::GcouplerMovementTypes firstType)
	Sets the first joint movement type Created in NX7.5.0.

void	SetName (const NXString &name)
	Sets the 2-3 joint coupler name Created in NX7.5.0.

void	SetName (const char *name)
	Sets the 2-3 joint coupler name Created in NX7.5.0.

void	SetSecondScale (double secondScale)
	Sets the second joint scale

void	SetSecondType (NXOpen::Motion::GcouplerMovementTypes secondType)
	Sets the second joint movement type Created in NX7.5.0.

void	SetThirdScale (double thirdScale)
	Sets the third joint scale

void	SetThirdType (NXOpen::Motion::GcouplerMovementTypes thirdType)
	Sets the third joint movement type Created in NX7.5.0.

NXOpen::Motion::SelectJoint *	ThirdJoint ()
	Returns the selected third joint Created in NX7.5.0.

double	ThirdScale ()
	Returns the third joint scale

NXOpen::Expression *	ThirdScaleExpression ()
	Returns the third scale expression Created in NX8.5.0.

NXOpen::Motion::GcouplerMovementTypes	ThirdType ()
	Returns the third joint movement type Created in NX7.5.0.

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

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

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

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

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

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

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

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

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

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

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

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

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

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a @link Motion::GeneralCouplerBuilder Motion::GeneralCouplerBuilder@endlink   <br> To create a new instance of this class, use @link Motion::GeneralCouplerCollection::CreateGeneralCouplerBuilder  Motion::GeneralCouplerCollection::CreateGeneralCouplerBuilder @endlink  <br>

Default values.

Property

Value

DisplayScale

1.0

FirstScaleExpression.Value

1.0

SecondScaleExpression.Value

1.0

ThirdScaleExpression.Value

1.0

Created in NX7.5.0.

Member Enumeration Documentation

enum NXOpen::Motion::GeneralCouplerBuilder::AttachmentType

Definitions of joint coupler attachment type.

Enumerator:

AttachmentTypeTwo	two-joint coupler type
AttachmentTypeThree	three-joint coupler type

Member Function Documentation

NXOpen::Motion::GeneralCouplerBuilder::AttachmentType NXOpen::Motion::GeneralCouplerBuilder::Attachment ( )

Returns the attachment type
Created in NX7.5.0.

License requirements : None

NXOpen::Motion::SelectJoint* NXOpen::Motion::GeneralCouplerBuilder::FirstJoint ( )

Returns the selected first joint
Created in NX7.5.0.

License requirements : None

double NXOpen::Motion::GeneralCouplerBuilder::FirstScale ( )

Returns the first joint scale

Deprecated:: Deprecated in NX8.5.0.

Obtion the exression using Motion::GeneralCouplerBuilder::FirstScaleExpression to query or edit it.

Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Motion::GeneralCouplerBuilder::FirstScaleExpression ( )

Returns the first scale expression
Created in NX8.5.0.

License requirements : None

NXOpen::Motion::GcouplerMovementTypes NXOpen::Motion::GeneralCouplerBuilder::FirstType ( )

Returns the first joint movement type
Created in NX7.5.0.

License requirements : None

NXString NXOpen::Motion::GeneralCouplerBuilder::Name ( )

Returns the 2-3 joint coupler name
Created in NX7.5.0.

License requirements : None

NXOpen::Motion::SelectJoint* NXOpen::Motion::GeneralCouplerBuilder::SecondJoint ( )

Returns the selected second joint
Created in NX7.5.0.

License requirements : None

double NXOpen::Motion::GeneralCouplerBuilder::SecondScale ( )

Returns the second joint scale

Deprecated:: Deprecated in NX8.5.0.

Obtion the exression using Motion::GeneralCouplerBuilder::SecondScaleExpression to query or edit it.

Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Motion::GeneralCouplerBuilder::SecondScaleExpression ( )

Returns the second scale expression
Created in NX8.5.0.

License requirements : None

NXOpen::Motion::GcouplerMovementTypes NXOpen::Motion::GeneralCouplerBuilder::SecondType ( )

Returns the second joint movement type
Created in NX7.5.0.

License requirements : None

void NXOpen::Motion::GeneralCouplerBuilder::SetAttachment ( NXOpen::Motion::GeneralCouplerBuilder::AttachmentType attachment )

Sets the attachment type
Created in NX7.5.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

attachment attachment

void NXOpen::Motion::GeneralCouplerBuilder::SetFirstScale ( double firstScale )

Sets the first joint scale

Deprecated:: Deprecated in NX8.5.0.

Obtion the exression using Motion::GeneralCouplerBuilder::FirstScaleExpression to query or edit it.

Created in NX7.5.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

firstScale firstscale

void NXOpen::Motion::GeneralCouplerBuilder::SetFirstType ( NXOpen::Motion::GcouplerMovementTypes firstType )

Sets the first joint movement type
Created in NX7.5.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

firstType firsttype

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

Sets the 2-3 joint coupler name
Created in NX7.5.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

name name

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

Sets the 2-3 joint coupler name
Created in NX7.5.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

name name

void NXOpen::Motion::GeneralCouplerBuilder::SetSecondScale ( double secondScale )

Sets the second joint scale

Deprecated:: Deprecated in NX8.5.0.

Obtion the exression using Motion::GeneralCouplerBuilder::SecondScaleExpression to query or edit it.

Created in NX7.5.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

secondScale secondscale

void NXOpen::Motion::GeneralCouplerBuilder::SetSecondType ( NXOpen::Motion::GcouplerMovementTypes secondType )

Sets the second joint movement type
Created in NX7.5.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

secondType secondtype

void NXOpen::Motion::GeneralCouplerBuilder::SetThirdScale ( double thirdScale )

Sets the third joint scale

Deprecated:: Deprecated in NX8.5.0.

Obtion the exression using Motion::GeneralCouplerBuilder::ThirdScaleExpression to query or edit it.

Created in NX7.5.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

thirdScale thirdscale

void NXOpen::Motion::GeneralCouplerBuilder::SetThirdType ( NXOpen::Motion::GcouplerMovementTypes thirdType )

Sets the third joint movement type
Created in NX7.5.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

thirdType thirdtype

NXOpen::Motion::SelectJoint* NXOpen::Motion::GeneralCouplerBuilder::ThirdJoint ( )

Returns the selected third joint
Created in NX7.5.0.

License requirements : None

double NXOpen::Motion::GeneralCouplerBuilder::ThirdScale ( )

Returns the third joint scale

Deprecated:: Deprecated in NX8.5.0.

Obtion the exression using Motion::GeneralCouplerBuilder::ThirdScaleExpression to query or edit it.

Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Motion::GeneralCouplerBuilder::ThirdScaleExpression ( )

Returns the third scale expression
Created in NX8.5.0.

License requirements : None

NXOpen::Motion::GcouplerMovementTypes NXOpen::Motion::GeneralCouplerBuilder::ThirdType ( )

Returns the third joint movement type
Created in NX7.5.0.

License requirements : None

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

Motion_GeneralCouplerBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation