Represents a builder class for creating and editing an NXOpen::Motion::ScalarForce . More...

Inheritance diagram for NXOpen::Motion::ScalarForceBuilder:

Public Types
enum	ApplicationType { ApplicationTypeActionReaction, ApplicationTypeActionOnly }
	the application type. More...

enum	ApplyType { ApplyTypeActionReaction, ApplyTypeActionOnly }
	the apply type. More...

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

Public Member Functions
NXOpen::CoordinateSystem *	ActionCsys ()
	Returns. More...

NXOpen::Motion::ParamOverrideState	ActionCsysOvrCtrl ()
	Returns. More...

NXOpen::Motion::SelectLink *	ActionLink ()
	Returns. More...

NXOpen::Motion::ParamOverrideState	ActionLinkOvrCtrl ()
	Returns. More...

NXOpen::Point *	ActionPoint ()
	Returns. More...

NXOpen::Motion::ParamOverrideState	ActionPointOvrCtrl ()
	Returns. More...

NXOpen::Motion::ScalarForceBuilder::ApplicationType	Applicationtype ()
	Returns. More...

NXOpen::Motion::ScalarForceBuilder::ApplyType	Apptype ()
	Returns the apptype Created in NX12.0.2. More...

NXOpen::Motion::ScalarForceBuilder::DirectionType	Direction ()
	Returns. More...

NXOpen::CAE::Function *	Function ()
	Returns. More...

NXString	Name ()
	Returns. More...

NXOpen::Motion::SelectFieldData *	Profile ()
	Returns. More...

NXOpen::CoordinateSystem *	ReactionCsys ()
	Returns. More...

NXOpen::Motion::ParamOverrideState	ReactionCsysOvrCtrl ()
	Returns. More...

NXOpen::Motion::SelectLink *	ReactionLink ()
	Returns. More...

NXOpen::Motion::ParamOverrideState	ReactionLinkOvrCtrl ()
	Returns. More...

NXOpen::Point *	ReactionPoint ()
	Returns. More...

NXOpen::Motion::ParamOverrideState	ReactionPointOvrCtrl ()
	Returns. More...

void	SetActionCsys (NXOpen::CoordinateSystem *actionCsys)
	Sets. More...

void	SetActionCsysOvrCtrl (NXOpen::Motion::ParamOverrideState overrideState)
	Sets. More...

void	SetActionLinkOvrCtrl (NXOpen::Motion::ParamOverrideState overrideState)
	Sets. More...

void	SetActionPoint (NXOpen::Point *actionPoint)
	Sets. More...

void	SetActionPointOvrCtrl (NXOpen::Motion::ParamOverrideState overrideState)
	Sets. More...

void	SetApplicationtype (NXOpen::Motion::ScalarForceBuilder::ApplicationType type)
	Sets. More...

void	SetApptype (NXOpen::Motion::ScalarForceBuilder::ApplyType type)
	Sets the apptype Created in NX12.0.2. More...

void	SetDirection (NXOpen::Motion::ScalarForceBuilder::DirectionType type)
	Sets. More...

void	SetFunction (NXOpen::CAE::Function *function)
	Sets. More...

void	SetName (const NXString &name)
	Sets. More...

void	SetName (const char *name)
	Sets. More...

void	SetReactionCsys (NXOpen::CoordinateSystem *reactionCsys)
	Sets. More...

void	SetReactionCsysOvrCtrl (NXOpen::Motion::ParamOverrideState overrideState)
	Sets. More...

void	SetReactionLinkOvrCtrl (NXOpen::Motion::ParamOverrideState overrideState)
	Sets. More...

void	SetReactionPoint (NXOpen::Point *reactionPoint)
	Sets. More...

void	SetReactionPointOvrCtrl (NXOpen::Motion::ParamOverrideState overrideState)
	Sets. More...

void	SetValueType (NXOpen::Motion::ForceValueTypes valueType)
	Sets. More...

NXOpen::Expression *	ValueExpression ()
	Returns. More...

NXOpen::Motion::ForceValueTypes	ValueType ()
	Returns. 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 builder class for creating and editing an NXOpen::Motion::ScalarForce .

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

Created in NX6.0.0.

Member Enumeration Documentation

enum NXOpen::Motion::ScalarForceBuilder::ApplicationType

the application type.

Each application type has a specific application associated. A Scalar Force is invalid without the type of application. Warning: This enum creates ambiguity in NXOpen VB API so we use apply_type instead

Deprecated:: Deprecated in NX12.0.2. Does not work with NXOpen VB Language Bindings. Use NXOpen::Motion::ScalarForceBuilder::ApplyType instead.

Enumerator
ApplicationTypeActionReaction	for Action-Reaction application type
ApplicationTypeActionOnly	for Action Only application type

enum NXOpen::Motion::ScalarForceBuilder::ApplyType

the apply type.

Each application type has a specific application associated. A Scalar Force is invalid without the type of application.

Enumerator
ApplyTypeActionReaction	for Action-Reaction Apply type
ApplyTypeActionOnly	for Action Only Apply type

enum NXOpen::Motion::ScalarForceBuilder::DirectionType

the direction type.

Each direction type has a specific direction associated. A Scalar Force is invalid without a direction associated.

Enumerator
DirectionTypeTranslational	for translational direction
DirectionTypeX	for X direction
DirectionTypeY	for Y direction
DirectionTypeZ	for Z direction

Member Function Documentation

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

Returns.

the action csys.

Created in NX12.0.0.

License requirements : None

NXOpen::Motion::ParamOverrideState NXOpen::Motion::ScalarForceBuilder::ActionCsysOvrCtrl ( )

Returns.

the override state of the action coordinate system

It should only be used for occurrences
Created in NX1847.0.0.

License requirements : None

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

Returns.

the action motion body.

Created in NX6.0.0.

License requirements : None

NXOpen::Motion::ParamOverrideState NXOpen::Motion::ScalarForceBuilder::ActionLinkOvrCtrl ( )

Returns.

the override state of the action motion body

It should only be used for occurrences
Created in NX1847.0.0.

License requirements : None

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

Returns.

the action point.

Created in NX6.0.0.

License requirements : None

NXOpen::Motion::ParamOverrideState NXOpen::Motion::ScalarForceBuilder::ActionPointOvrCtrl ( )

Returns.

the override state of the action point

It should only be used for occurrences
Created in NX1847.0.0.

License requirements : None

NXOpen::Motion::ScalarForceBuilder::ApplicationType NXOpen::Motion::ScalarForceBuilder::Applicationtype ( )

Returns.

the application type.

Deprecated:: Deprecated in NX12.0.2. Does not work with NXOpen VB Language Bindings. Use NXOpen::Motion::ScalarForceBuilder::Apptype instead.

Created in NX12.0.0.

License requirements : None

NXOpen::Motion::ScalarForceBuilder::ApplyType NXOpen::Motion::ScalarForceBuilder::Apptype ( )

Returns the apptype
Created in NX12.0.2.

License requirements : None

NXOpen::Motion::ScalarForceBuilder::DirectionType NXOpen::Motion::ScalarForceBuilder::Direction ( )

Returns.

the direction.

Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

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::SelectFieldData* NXOpen::Motion::ScalarForceBuilder::Profile ( )

Returns.

the profile.

Created in NX12.0.0.

License requirements : None

NXOpen::CoordinateSystem* NXOpen::Motion::ScalarForceBuilder::ReactionCsys ( )

Returns.

the reaction csys.

Created in NX12.0.0.

License requirements : None

NXOpen::Motion::ParamOverrideState NXOpen::Motion::ScalarForceBuilder::ReactionCsysOvrCtrl ( )

Returns.

the override state of the reaction coordinate system

It should only be used for occurrences
Created in NX1847.0.0.

License requirements : None

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

Returns.

the reaction motion body.

Created in NX6.0.0.

License requirements : None

NXOpen::Motion::ParamOverrideState NXOpen::Motion::ScalarForceBuilder::ReactionLinkOvrCtrl ( )

Returns.

the override state of the reaction motion body

It should only be used for occurrences
Created in NX1847.0.0.

License requirements : None

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

Returns.

the reaction point.

Created in NX6.0.0.

License requirements : None

NXOpen::Motion::ParamOverrideState NXOpen::Motion::ScalarForceBuilder::ReactionPointOvrCtrl ( )

Returns.

the override state of the reaction point

It should only be used for occurrences
Created in NX1847.0.0.

License requirements : None

void NXOpen::Motion::ScalarForceBuilder::SetActionCsys ( NXOpen::CoordinateSystem * actionCsys )

Sets.

the action csys.

Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

actionCsys actioncsys

void NXOpen::Motion::ScalarForceBuilder::SetActionCsysOvrCtrl ( NXOpen::Motion::ParamOverrideState overrideState )

Sets.

the override state of the action coordinate system

It should only be used for occurrences
Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

overrideState overridestate

void NXOpen::Motion::ScalarForceBuilder::SetActionLinkOvrCtrl ( NXOpen::Motion::ParamOverrideState overrideState )

Sets.

the override state of the action motion body

It should only be used for occurrences
Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

overrideState overridestate

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::SetActionPointOvrCtrl ( NXOpen::Motion::ParamOverrideState overrideState )

Sets.

the override state of the action point

It should only be used for occurrences
Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

overrideState overridestate

void NXOpen::Motion::ScalarForceBuilder::SetApplicationtype ( NXOpen::Motion::ScalarForceBuilder::ApplicationType type )

Sets.

the application type.

Deprecated:: Deprecated in NX12.0.2. Does not work with NXOpen VB Language Bindings. Use NXOpen::Motion::ScalarForceBuilder::Apptype instead.

Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

type type

void NXOpen::Motion::ScalarForceBuilder::SetApptype ( NXOpen::Motion::ScalarForceBuilder::ApplyType type )

Sets the apptype
Created in NX12.0.2.

License requirements : mechanisms ("MECHANISMS")

Parameters

type type

void NXOpen::Motion::ScalarForceBuilder::SetDirection ( NXOpen::Motion::ScalarForceBuilder::DirectionType type )

Sets.

the direction.

Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

type type

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::SetReactionCsys ( NXOpen::CoordinateSystem * reactionCsys )

Sets.

the reaction csys.

Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

reactionCsys reactioncsys

void NXOpen::Motion::ScalarForceBuilder::SetReactionCsysOvrCtrl ( NXOpen::Motion::ParamOverrideState overrideState )

Sets.

the override state of the reaction coordinate system

It should only be used for occurrences
Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

overrideState overridestate

void NXOpen::Motion::ScalarForceBuilder::SetReactionLinkOvrCtrl ( NXOpen::Motion::ParamOverrideState overrideState )

Sets.

the override state of the reaction motion body

It should only be used for occurrences
Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

overrideState overridestate

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::SetReactionPointOvrCtrl ( NXOpen::Motion::ParamOverrideState overrideState )

Sets.

the override state of the reaction point

It should only be used for occurrences
Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

overrideState overridestate

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 Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation