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

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

Created in NX6.0.0. More...

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

Public Member Functions

NXOpen::Motion::SelectLinkActionLink ()
 Returns the action link
Created in NX6.0.0. More...
 
NXOpen::PointActionPoint ()
 Returns the action point
Created in NX6.0.0. More...
 
double ConstantValue ()
 Returns the constant value
More...
 
NXOpen::CAE::FunctionFunction ()
 Returns the function
Created in NX6.0.0. More...
 
NXString Name ()
 Returns the name
Created in NX6.0.0. More...
 
NXOpen::Motion::SelectLinkReactionLink ()
 Returns the reaction link
Created in NX6.0.0. More...
 
NXOpen::PointReactionPoint ()
 Returns the reaction point
Created in NX6.0.0. More...
 
void SetActionPoint (NXOpen::Point *actionPoint)
 Sets the action point
Created in NX6.0.0. More...
 
void SetConstantValue (double constantValue)
 Sets the constant value
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 SetReactionPoint (NXOpen::Point *reactionPoint)
 Sets the reaction point
Created in NX6.0.0. More...
 
void SetValueType (NXOpen::Motion::ForceValueTypes valueType)
 Sets the value type
Created in NX6.0.0. More...
 
NXOpen::ExpressionValueExpression ()
 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::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::ScalarForceBuilder
To create a new instance of this class, use NXOpen::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 NXOpen::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
actionPointactionpoint
void NXOpen::Motion::ScalarForceBuilder::SetConstantValue ( double  constantValue)

Sets the constant value

Deprecated:
Deprecated in NX8.0.0.

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


Created in NX6.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
constantValueconstantvalue
void NXOpen::Motion::ScalarForceBuilder::SetFunction ( NXOpen::CAE::Function function)

Sets the function
Created in NX6.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
functionfunction
void NXOpen::Motion::ScalarForceBuilder::SetName ( const NXString name)

Sets the name
Created in NX6.0.0.



License requirements : mechanisms ("MECHANISMS")

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

Sets the name
Created in NX6.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
namename
void NXOpen::Motion::ScalarForceBuilder::SetReactionPoint ( NXOpen::Point reactionPoint)

Sets the reaction point
Created in NX6.0.0.



License requirements : mechanisms ("MECHANISMS")

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

Sets the value type
Created in NX6.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
valueTypevaluetype
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:
Copyright 2012 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.