NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Motion::GeneralCouplerBuilder Class Reference

Represents a NXOpen::Motion::GeneralCouplerBuilder
To create a new instance of this class, use NXOpen::Motion::GeneralCouplerCollection::CreateGeneralCouplerBuilder
Default values. More...

Inheritance diagram for NXOpen::Motion::GeneralCouplerBuilder:
NXOpen::Motion::MotionBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

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. More...
 
NXOpen::Motion::SelectJointFirstJoint ()
 Returns the selected first joint
Created in NX7.5.0. More...
 
NXOpen::ExpressionFirstScaleExpression ()
 Returns the first scale expression
Created in NX8.5.0. More...
 
NXOpen::Motion::GcouplerMovementTypes FirstType ()
 Returns the first joint movement type
Created in NX7.5.0. More...
 
NXString Name ()
 Returns the 2-3 joint coupler name
Created in NX7.5.0. More...
 
NXOpen::Motion::SelectJointSecondJoint ()
 Returns the selected second joint
Created in NX7.5.0. More...
 
NXOpen::ExpressionSecondScaleExpression ()
 Returns the second scale expression
Created in NX8.5.0. More...
 
NXOpen::Motion::GcouplerMovementTypes SecondType ()
 Returns the second joint movement type
Created in NX7.5.0. More...
 
void SetAttachment (NXOpen::Motion::GeneralCouplerBuilder::AttachmentType attachment)
 Sets the attachment type
Created in NX7.5.0. More...
 
void SetFirstType (NXOpen::Motion::GcouplerMovementTypes firstType)
 Sets the first joint movement type
Created in NX7.5.0. More...
 
void SetName (const NXString &name)
 Sets the 2-3 joint coupler name
Created in NX7.5.0. More...
 
void SetName (const char *name)
 Sets the 2-3 joint coupler name
Created in NX7.5.0. More...
 
void SetSecondType (NXOpen::Motion::GcouplerMovementTypes secondType)
 Sets the second joint movement type
Created in NX7.5.0. More...
 
void SetThirdType (NXOpen::Motion::GcouplerMovementTypes thirdType)
 Sets the third joint movement type
Created in NX7.5.0. More...
 
NXOpen::Motion::SelectJointThirdJoint ()
 Returns the selected third joint
Created in NX7.5.0. More...
 
NXOpen::ExpressionThirdScaleExpression ()
 Returns the third scale expression
Created in NX8.5.0. More...
 
NXOpen::Motion::GcouplerMovementTypes ThirdType ()
 Returns the third joint movement type
Created in NX7.5.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::NXObjectCommit ()
 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::NXObjectGetObject ()
 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::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


Created in NX7.5.0.

Member Enumeration Documentation

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

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

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
attachmentattachment
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
firstTypefirsttype
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
namename
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
namename
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
secondTypesecondtype
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
thirdTypethirdtype
NXOpen::Motion::SelectJoint* NXOpen::Motion::GeneralCouplerBuilder::ThirdJoint ( )

Returns the selected third joint
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:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.