Represents a NXOpen::Motion::ScalarTorqueBuilder
To create a new instance of this class, use NXOpen::Motion::ScalarTorqueCollection::CreateScalarTorqueBuilder

Created in NX6.0.0. More...

Inheritance diagram for NXOpen::Motion::ScalarTorqueBuilder:

Public Types
enum	AppType { AppTypeActionReaction, AppTypeActionOnly }
	the application type More...

enum	DirectionType { DirectionTypeX, DirectionTypeY, DirectionTypeZ }
	the direction More...

enum	ScalarTorqueType { ScalarTorqueTypeJoint, ScalarTorqueTypeLink }
	the torque type More...

Public Member Functions
NXOpen::CoordinateSystem *	ActionCsys ()
	Returns the action csys Created in NX12.0.0. More...

NXOpen::Motion::SelectLink *	ActionLink ()
	Returns the action link attachment. More...

NXOpen::Point *	ActionPoint ()
	Returns the action point Created in NX12.0.0. More...

NXOpen::Motion::ScalarTorqueBuilder::AppType	ApplicationType ()
	Returns the scalar torque application type. More...

NXOpen::CoordinateSystem *	BaseCsys ()
	Returns the base csys Created in NX12.0.0. More...

NXOpen::Motion::SelectLink *	BaseLink ()
	Returns the base link attachment. More...

NXOpen::Point *	BasePoint ()
	Returns the base point Created in NX12.0.0. More...

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

NXOpen::CAE::Function *	Function ()
	Returns the function Created in NX6.0.0. More...

NXOpen::Motion::SelectJoint *	Joint ()
	Returns the joint Created in NX6.0.0. More...

NXString	Name ()
	Returns the name Created in NX6.0.0. More...

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

void	SetActionCsys (NXOpen::CoordinateSystem *actionCsysTag)
	Sets the action csys Created in NX12.0.0. More...

void	SetActionPoint (NXOpen::Point *actionPointTag)
	Sets the action point Created in NX12.0.0. More...

void	SetApplicationType (NXOpen::Motion::ScalarTorqueBuilder::AppType appType)
	Sets the scalar torque application type. More...

void	SetBaseCsys (NXOpen::CoordinateSystem *baseCsysTag)
	Sets the base csys Created in NX12.0.0. More...

void	SetBasePoint (NXOpen::Point *basePointTag)
	Sets the base point Created in NX12.0.0. More...

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

void	SetFunction (NXOpen::CAE::Function *function)
	Sets the function Created in NX6.0.0. More...

void	SetName (const NXString &name)
	Sets the name Created in NX6.0.0. More...

void	SetName (const char *name)
	Sets the name Created in NX6.0.0. More...

void	SetTorqueType (NXOpen::Motion::ScalarTorqueBuilder::ScalarTorqueType torqueType)
	Sets the type. More...

void	SetValueType (NXOpen::Motion::ForceValueTypes valueType)
	Sets the value type Created in NX6.0.0. More...

NXOpen::Motion::ScalarTorqueBuilder::ScalarTorqueType	TorqueType ()
	Returns the type. More...

NXOpen::Expression *	ValueExpression ()
	Returns the value expression Created in NX8.0.0. More...

NXOpen::Motion::ForceValueTypes	ValueType ()
	Returns the value type Created in NX6.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::ScalarTorqueBuilder
To create a new instance of this class, use NXOpen::Motion::ScalarTorqueCollection::CreateScalarTorqueBuilder

Created in NX6.0.0.

Member Enumeration Documentation

enum NXOpen::Motion::ScalarTorqueBuilder::AppType

the application type

Enumerator
AppTypeActionReaction	Action-Reaction.
AppTypeActionOnly	ActionOnly.

enum NXOpen::Motion::ScalarTorqueBuilder::DirectionType

the direction

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

enum NXOpen::Motion::ScalarTorqueBuilder::ScalarTorqueType

the torque type

Enumerator

ScalarTorqueTypeJoint

Scalar Torque Type Joint.

Requires a Joint as input.

ScalarTorqueTypeLink

Scalar Torque Type Link.

Requires an action and base link attachment.

Member Function Documentation

NXOpen::CoordinateSystem* NXOpen::Motion::ScalarTorqueBuilder::ActionCsys ( )

Returns the action csys
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::SelectLink* NXOpen::Motion::ScalarTorqueBuilder::ActionLink ( )

Returns the action link attachment.

Required in type if Torque is Link.
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Point* NXOpen::Motion::ScalarTorqueBuilder::ActionPoint ( )

Returns the action point
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::ScalarTorqueBuilder::AppType NXOpen::Motion::ScalarTorqueBuilder::ApplicationType ( )

Returns the scalar torque application type.

Default Type is Action-Reaction.
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::CoordinateSystem* NXOpen::Motion::ScalarTorqueBuilder::BaseCsys ( )

Returns the base csys
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::SelectLink* NXOpen::Motion::ScalarTorqueBuilder::BaseLink ( )

Returns the base link attachment.

Optional in type if Torque is Link.
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Point* NXOpen::Motion::ScalarTorqueBuilder::BasePoint ( )

Returns the base point
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::ScalarTorqueBuilder::DirectionType NXOpen::Motion::ScalarTorqueBuilder::Direction ( )

Returns the control Output Variable direction.

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

License requirements : mechanisms ("MECHANISMS")

NXOpen::CAE::Function* NXOpen::Motion::ScalarTorqueBuilder::Function ( )

Returns the function
Created in NX6.0.0.

License requirements : None

NXOpen::Motion::SelectJoint* NXOpen::Motion::ScalarTorqueBuilder::Joint ( )

Returns the joint
Created in NX6.0.0.

License requirements : None

NXString NXOpen::Motion::ScalarTorqueBuilder::Name ( )

Returns the name
Created in NX6.0.0.

License requirements : None

NXOpen::Motion::SelectFieldData* NXOpen::Motion::ScalarTorqueBuilder::Profile ( )

Returns the profile
Created in NX12.0.0.

License requirements : None

void NXOpen::Motion::ScalarTorqueBuilder::SetActionCsys ( NXOpen::CoordinateSystem * actionCsysTag )

Sets the action csys
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

actionCsysTag actioncsystag

void NXOpen::Motion::ScalarTorqueBuilder::SetActionPoint ( NXOpen::Point * actionPointTag )

Sets the action point
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

actionPointTag actionpointtag

void NXOpen::Motion::ScalarTorqueBuilder::SetApplicationType ( NXOpen::Motion::ScalarTorqueBuilder::AppType appType )

Sets the scalar torque application type.

Default Type is Action-Reaction.
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

appType apptype

void NXOpen::Motion::ScalarTorqueBuilder::SetBaseCsys ( NXOpen::CoordinateSystem * baseCsysTag )

Sets the base csys
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

baseCsysTag basecsystag

void NXOpen::Motion::ScalarTorqueBuilder::SetBasePoint ( NXOpen::Point * basePointTag )

Sets the base point
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

basePointTag basepointtag

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

Sets the control Output Variable direction.

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

License requirements : mechanisms ("MECHANISMS")

Parameters

direction direction

void NXOpen::Motion::ScalarTorqueBuilder::SetFunction ( NXOpen::CAE::Function * function )

Sets the function
Created in NX6.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

function function

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

Sets the name
Created in NX6.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

name name

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

Sets the name
Created in NX6.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

name name

void NXOpen::Motion::ScalarTorqueBuilder::SetTorqueType ( NXOpen::Motion::ScalarTorqueBuilder::ScalarTorqueType torqueType )

Sets the type.

Default type is Link.
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

torqueType torquetype

void NXOpen::Motion::ScalarTorqueBuilder::SetValueType ( NXOpen::Motion::ForceValueTypes valueType )

Sets the value type
Created in NX6.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

valueType valuetype

NXOpen::Motion::ScalarTorqueBuilder::ScalarTorqueType NXOpen::Motion::ScalarTorqueBuilder::TorqueType ( )

Returns the type.

Default type is Link.
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::ScalarTorqueBuilder::ValueExpression ( )

Returns the value expression
Created in NX8.0.0.

License requirements : None

NXOpen::Motion::ForceValueTypes NXOpen::Motion::ScalarTorqueBuilder::ValueType ( )

Returns the value type
Created in NX6.0.0.

License requirements : None

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

Motion_ScalarTorqueBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation