Represents a Motion::ScalarForceBuilder
To create a new instance of this class, use Motion::ScalarForceCollection::CreateScalarForceBuilder

Created in NX6.0.0. More...

Inheritance diagram for NXOpen::Motion::ScalarForceBuilder:

Public Member Functions
NXOpen::Motion::SelectLink *	ActionLink ()
	Returns the action link Created in NX6.0.0.

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

double	ConstantValue ()
	Returns the constant value

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

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

NXOpen::Motion::SelectLink *	ReactionLink ()
	Returns the reaction link Created in NX6.0.0.

NXOpen::Point *	ReactionPoint ()
	Returns the reaction point Created in NX6.0.0.

void	SetActionPoint (NXOpen::Point *actionPoint)
	Sets the action point Created in NX6.0.0.

void	SetConstantValue (double constantValue)
	Sets the constant value

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

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

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

void	SetReactionPoint (NXOpen::Point *reactionPoint)
	Sets the reaction point Created in NX6.0.0.

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

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

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

Created in NX6.0.0.

Member Function Documentation

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

Returns the action link
Created in NX6.0.0.

License requirements : None

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

Returns the action point
Created in NX6.0.0.

License requirements : None

double NXOpen::Motion::ScalarForceBuilder::ConstantValue ( )

Returns the constant value

Deprecated:: Deprecated in NX8.0.0.

Obtain the expression using Motion::ScalarForceBuilder::ValueExpression to query or edit it.

Created in NX6.0.0.

License requirements : None

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

Returns the function
Created in NX6.0.0.

License requirements : None

NXString NXOpen::Motion::ScalarForceBuilder::Name ( )

Returns the name
Created in NX6.0.0.

License requirements : None

NXOpen::Motion::SelectLink* NXOpen::Motion::ScalarForceBuilder::ReactionLink ( )

Returns the reaction link
Created in NX6.0.0.

License requirements : None

NXOpen::Point* NXOpen::Motion::ScalarForceBuilder::ReactionPoint ( )

Returns the reaction point
Created in NX6.0.0.

License requirements : None

void NXOpen::Motion::ScalarForceBuilder::SetActionPoint ( NXOpen::Point * actionPoint )

Sets the action point
Created in NX6.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

actionPoint actionpoint

void NXOpen::Motion::ScalarForceBuilder::SetConstantValue ( double constantValue )

Sets the constant value

Deprecated:: Deprecated in NX8.0.0.

Obtain the expression using Motion::ScalarForceBuilder::ValueExpression to query or edit it.

Created in NX6.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

constantValue constantvalue

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

Sets the function
Created in NX6.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

function function

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

Sets the name
Created in NX6.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

name name

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

Sets the name
Created in NX6.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

name name

void NXOpen::Motion::ScalarForceBuilder::SetReactionPoint ( NXOpen::Point * reactionPoint )

Sets the reaction point
Created in NX6.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

reactionPoint reactionpoint

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

Sets the value type
Created in NX6.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

valueType valuetype

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

Returns the value expression
Created in NX8.0.0.

License requirements : None

NXOpen::Motion::ForceValueTypes NXOpen::Motion::ScalarForceBuilder::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_ScalarForceBuilder.hxx

Public Member Functions

Detailed Description

Member Function Documentation