Represents a Motion::ControlOutput builder
To create a new instance of this class, use NXOpen::Motion::ControlOutputCollection::CreateControlOutputBuilder
Default values. More...

Inheritance diagram for NXOpen::Motion::ControlOutputBuilder:

Public Types
enum	ControlOutputType { ControlOutputTypeLink, ControlOutputTypeJointOrConstraint }
	Control Output type. More...

enum	DirectionType { DirectionTypeX, DirectionTypeY, DirectionTypeZ }
	Output Variable Direction. More...

enum	VariableType { VariableTypeForce, VariableTypeTorque, VariableTypeActionTorque, VariableTypeBaseTorque }
	Output Variable type. More...

Public Member Functions
NXOpen::Motion::LinkAttachmentData *	ActionLinkAttachment ()
	Returns the action link attachment. More...

NXOpen::Motion::LinkAttachmentData *	BaseLinkAttachment ()
	Returns the base link attachment. More...

NXOpen::Motion::ControlOutputBuilder::DirectionType	Direction ()
	Returns the control Output Variable direction. More...

NXOpen::Motion::SelectJoint *	JointSelection ()
	Returns the joint selection. More...

NXString	Name ()
	Returns the name of the control output element. More...

NXOpen::Motion::ControlOutputBuilder::ControlOutputType	OutputType ()
	Returns the Control Output type. More...

NXOpen::Motion::SelectControlPort *	PortSelection ()
	Returns the control output port Created in NX11.0.0. More...

void	SetDirection (NXOpen::Motion::ControlOutputBuilder::DirectionType direction)
	Sets the control Output Variable direction. More...

void	SetName (const NXString &name)
	Sets the name of the control output element. More...

void	SetName (const char *name)
	Sets the name of the control output element. More...

void	SetOutputType (NXOpen::Motion::ControlOutputBuilder::ControlOutputType outputType)
	Sets the Control Output type. More...

void	SetVariable (NXOpen::Motion::ControlOutputBuilder::VariableType variable)
	Sets the control Output Variable type. More...

NXOpen::Motion::ControlOutputBuilder::VariableType	Variable ()
	Returns the control Output Variable type. 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 Motion::ControlOutput builder
To create a new instance of this class, use NXOpen::Motion::ControlOutputCollection::CreateControlOutputBuilder
Default values.

Property

Value

Direction

Z

OutputType

Link

Variable

Force

Created in NX11.0.0.

Member Enumeration Documentation

enum NXOpen::Motion::ControlOutputBuilder::ControlOutputType

Control Output type.

Enumerator

ControlOutputTypeLink

Control Output Type Link.

Requires an action link attachment. Can have a base link attachment.

ControlOutputTypeJointOrConstraint

Control Output Type Joint or Constraint.

Requires a Joint or Point on Curve Constraint as input.

enum NXOpen::Motion::ControlOutputBuilder::DirectionType

Output Variable Direction.

Enumerator
DirectionTypeX	Output Variable Direction X.
DirectionTypeY	Output Variable Direction Y.
DirectionTypeZ	Output Variable Direction Z.

enum NXOpen::Motion::ControlOutputBuilder::VariableType

Output Variable type.

Enumerator
VariableTypeForce	Output Variable type Force.
VariableTypeTorque	Output Variable type Torque.
VariableTypeActionTorque	Output Variable type Action Torque. Valid only in control output has universal joint as input.
VariableTypeBaseTorque	Output Variable type Base Torque. Valid only in control output has universal joint as input.

Member Function Documentation

NXOpen::Motion::LinkAttachmentData* NXOpen::Motion::ControlOutputBuilder::ActionLinkAttachment ( )

Returns the action link attachment.

Required in type of Control Output is Link.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::LinkAttachmentData* NXOpen::Motion::ControlOutputBuilder::BaseLinkAttachment ( )

Returns the base link attachment.

Used if the type of Control Output is Link.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::ControlOutputBuilder::DirectionType NXOpen::Motion::ControlOutputBuilder::Direction ( )

Returns the control Output Variable direction.

Default Control Output Variable Direction is Z direction.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::SelectJoint* NXOpen::Motion::ControlOutputBuilder::JointSelection ( )

Returns the joint selection.

Required if the type of Control Output is Joint/Constraint.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXString NXOpen::Motion::ControlOutputBuilder::Name ( )

Returns the name of the control output element.

Must be unique across all motion elements. An unique name is set by default.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::ControlOutputBuilder::ControlOutputType NXOpen::Motion::ControlOutputBuilder::OutputType ( )

Returns the Control Output type.

Default Control Output Type is Link.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::SelectControlPort* NXOpen::Motion::ControlOutputBuilder::PortSelection ( )

Returns the control output port
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::ControlOutputBuilder::SetDirection ( NXOpen::Motion::ControlOutputBuilder::DirectionType direction )

Sets the control Output Variable direction.

Default Control Output Variable Direction is Z direction.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

direction direction

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

Sets the name of the control output element.

Must be unique across all motion elements. An unique name is set by default.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

name name

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

Sets the name of the control output element.

Must be unique across all motion elements. An unique name is set by default.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

name name

void NXOpen::Motion::ControlOutputBuilder::SetOutputType ( NXOpen::Motion::ControlOutputBuilder::ControlOutputType outputType )

Sets the Control Output type.

Default Control Output Type is Link.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

outputType outputtype

void NXOpen::Motion::ControlOutputBuilder::SetVariable ( NXOpen::Motion::ControlOutputBuilder::VariableType variable )

Sets the control Output Variable type.

Default Control Output Variable Type is Force.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

variable variable

NXOpen::Motion::ControlOutputBuilder::VariableType NXOpen::Motion::ControlOutputBuilder::Variable ( )

Returns the control Output Variable type.

Default Control Output Variable Type is Force.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

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

Motion_ControlOutputBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation