Represents a SpringBuilder
To create a new instance of this class, use NXOpen::Motion::SpringCollection::CreateSpringBuilder
Default values. More...

Inheritance diagram for NXOpen::Motion::SpringBuilder:

Public Member Functions
NXOpen::Motion::SelectFieldData *	ActuatorCurveProfile ()
	Returns the actuator profile. More...

NXOpen::Expression *	ActuatorForceExpression ()
	Returns the actuator force expression Created in NX12.0.0. More...

NXOpen::CAE::Function *	ActuatorFunction ()
	Returns the actuator function tag. More...

NXOpen::Expression *	ActuatorMomentExpression ()
	Returns the actuator moment expression Created in NX12.0.0. More...

NXOpen::Motion::ConnectorCoefficientTypes	ActuatorType ()
	Returns the actuator spline type Created in NX12.0.0. More...

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

NXOpen::Expression *	CoefficientExpression ()
	Returns the translational coefficient expression Created in NX8.5.0. More...

NXOpen::CAE::Function *	CoefficientFunction ()
	Returns the function tag. More...

NXOpen::Motion::ConnectorCoefficientTypes	CoefficientType ()
	Returns the coefficient type Created in NX8.5.0. More...

bool	CreateDamper ()
	Returns the create damper toggle Created in NX8.5.0. More...

NXOpen::Motion::ConnectorBuilder::ApplicationDirection	DamperAppDirection ()
	Returns the application direction of damper Created in NX12.0.0. More...

bool	DamperCustomizedSolver ()
	Returns the option of using Customized Solver for damper Created in NX12.0.0. More...

NXString	DamperName ()
	Returns the damper dname Created in NX8.5.0. More...

NXOpen::Expression *	FreeAngleExpression ()
	Returns the free angle expression More...

NXOpen::Expression *	FreeLengthExpression ()
	Returns the free length expression More...

NXOpen::Expression *	InitialLengthExpression ()
	Returns the initial length expression for spring which attachs to slide joint Created in NX8.0.0. More...

bool	LengthFlag ()
	Returns the length flag, if this flag is set to true, it will not update the preloaded length, if this flag is set to false, it will update the preloaded length according to the installed length Created in NX8.5.0. More...

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

NXOpen::Expression *	PreloadAngleExpression ()
	Returns the preload expression More...

NXOpen::Expression *	PreloadedAngleExpression ()
	Returns the preloaded angle expression Created in NX11.0.0. More...

NXOpen::Expression *	PreloadedLengthExpression ()
	Returns the preloaded length expression Created in NX11.0.0. More...

NXOpen::Expression *	PreloadExpression ()
	Returns the preload expression More...

NXOpen::Expression *	PreloadForceExpression ()
	Returns the preload force expression More...

NXOpen::Expression *	PreloadMomentExpression ()
	Returns the preload moment expression More...

void	SetActuatorFunction (NXOpen::CAE::Function *actuatorFunction)
	Sets the actuator function tag. More...

void	SetActuatorType (NXOpen::Motion::ConnectorCoefficientTypes actuatorType)
	Sets the actuator spline type Created in NX12.0.0. More...

void	SetCoefficientFunction (NXOpen::CAE::Function *function)
	Sets the function tag. More...

void	SetCoefficientType (NXOpen::Motion::ConnectorCoefficientTypes coefficientType)
	Sets the coefficient type Created in NX8.5.0. More...

void	SetCreateDamper (bool createDamper)
	Sets the create damper toggle Created in NX8.5.0. More...

void	SetDamperAppDirection (NXOpen::Motion::ConnectorBuilder::ApplicationDirection appDirection)
	Sets the application direction of damper Created in NX12.0.0. More...

void	SetDamperCustomizedSolver (bool customizedSolver)
	Sets the option of using Customized Solver for damper Created in NX12.0.0. More...

void	SetDamperName (const NXString &damperName)
	Sets the damper dname Created in NX8.5.0. More...

void	SetDamperName (const char *damperName)
	Sets the damper dname Created in NX8.5.0. More...

void	SetLengthFlag (bool lengthFlag)
	Sets the length flag, if this flag is set to true, it will not update the preloaded length, if this flag is set to false, it will update the preloaded length according to the installed length Created in NX8.5.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	SetSpringAppDirection (NXOpen::Motion::ConnectorBuilder::ApplicationDirection springAppDirection)
	Sets the application direction for damper Created in NX12.0.0. More...

void	SetSpringCustomizedSolver (bool springCustomizedSolver)
	Sets the option of using Customized Solver for damper Created in NX12.0.0. More...

void	SetStiffnessFunction (NXOpen::CAE::Function *function)
	Sets the function tag. More...

void	SetStiffnessType (NXOpen::Motion::ConnectorCoefficientTypes stiffnessType)
	Sets the stiffness type Created in NX6.0.0. More...

NXOpen::Motion::ConnectorBuilder::ApplicationDirection	SpringAppDirection ()
	Returns the application direction for damper Created in NX12.0.0. More...

bool	SpringCustomizedSolver ()
	Returns the option of using Customized Solver for damper Created in NX12.0.0. More...

NXOpen::Motion::SelectFieldData *	StiffnessCurveProfile ()
	Returns the stiffness 2D profile. More...

NXOpen::Expression *	StiffnessExpression ()
	Returns the stiffness expression Created in NX8.0.0. More...

NXOpen::CAE::Function *	StiffnessFunction ()
	Returns the function tag. More...

NXOpen::Motion::SelectFieldData *	StiffnessSurfaceProfile ()
	Returns the stiffness 3D profile. More...

NXOpen::Motion::ConnectorCoefficientTypes	StiffnessType ()
	Returns the stiffness type Created in NX6.0.0. More...

NXOpen::Expression *	TorsionalCoefficientExpression ()
	Returns the torsional coefficient expression Created in NX8.5.0. More...

NXOpen::Expression *	TorsionalStiffnessExpression ()
	Returns the torsional stiffness expression Created in NX8.0.0. More...

Public Member Functions inherited from NXOpen::Motion::ConnectorBuilder
NXOpen::Motion::SelectLink *	ActionLink ()
	Returns the action link. More...

NXOpen::Point *	ActionPoint ()
	Returns the action point. More...

NXOpen::Motion::ConnectorBuilder::AttachmentType	Attachment ()
	Returns the attachment type Created in NX6.0.0. More...

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

NXOpen::Motion::SelectLink *	ReactionLink ()
	Returns the reaction link. More...

NXOpen::Point *	ReactionPoint ()
	Returns the reaction point. More...

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

void	SetAttachment (NXOpen::Motion::ConnectorBuilder::AttachmentType attachment)
	Sets the attachment type Created in NX6.0.0. More...

void	SetReactionPoint (NXOpen::Point *reactionPoint)
	Sets the reaction point. 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...

Additional Inherited Members
Public Types inherited from NXOpen::Motion::ConnectorBuilder
enum	ApplicationDirection { ApplicationDirectionBidirectional, ApplicationDirectionTensionOnly, ApplicationDirectionCompressionOnly }
	Definitions of application direction. More...

enum	AttachmentType { AttachmentTypeLink, AttachmentTypeSliderJoint, AttachmentTypeRevoluteJoint }
	Definitions of connector attachment type. More...

Detailed Description

Represents a SpringBuilder
To create a new instance of this class, use NXOpen::Motion::SpringCollection::CreateSpringBuilder
Default values.

Property

Value

StiffnessType

Constant

Created in NX6.0.0.

Member Function Documentation

NXOpen::Motion::SelectFieldData* NXOpen::Motion::SpringBuilder::ActuatorCurveProfile ( )

Returns the actuator profile.

Only valid if Motion::ConnectorCoefficientTypesProfile2d or Motion::ConnectorCoefficientTypesExpressionAndProfile2d is set
Created in NX12.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Motion::SpringBuilder::ActuatorForceExpression ( )

Returns the actuator force expression
Created in NX12.0.0.

License requirements : None

NXOpen::CAE::Function* NXOpen::Motion::SpringBuilder::ActuatorFunction ( )

Returns the actuator function tag.

Created in NX12.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Motion::SpringBuilder::ActuatorMomentExpression ( )

Returns the actuator moment expression
Created in NX12.0.0.

License requirements : None

NXOpen::Motion::ConnectorCoefficientTypes NXOpen::Motion::SpringBuilder::ActuatorType ( )

Returns the actuator spline type
Created in NX12.0.0.

License requirements : None

NXOpen::Motion::SelectFieldData* NXOpen::Motion::SpringBuilder::CoefficientCurveProfile ( )

Returns the coefficient profile
Created in NX12.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Motion::SpringBuilder::CoefficientExpression ( )

Returns the translational coefficient expression
Created in NX8.5.0.

License requirements : None

NXOpen::CAE::Function* NXOpen::Motion::SpringBuilder::CoefficientFunction ( )

Returns the function tag.

Only valid if Motion::ConnectorCoefficientTypesSpline is set
Created in NX8.5.0.

License requirements : None

NXOpen::Motion::ConnectorCoefficientTypes NXOpen::Motion::SpringBuilder::CoefficientType ( )

Returns the coefficient type
Created in NX8.5.0.

License requirements : None

bool NXOpen::Motion::SpringBuilder::CreateDamper ( )

Returns the create damper toggle
Created in NX8.5.0.

License requirements : None

NXOpen::Motion::ConnectorBuilder::ApplicationDirection NXOpen::Motion::SpringBuilder::DamperAppDirection ( )

Returns the application direction of damper
Created in NX12.0.0.

License requirements : None

bool NXOpen::Motion::SpringBuilder::DamperCustomizedSolver ( )

Returns the option of using Customized Solver for damper
Created in NX12.0.0.

License requirements : None

NXString NXOpen::Motion::SpringBuilder::DamperName ( )

Returns the damper dname
Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Motion::SpringBuilder::FreeAngleExpression ( )

Returns the free angle expression

Deprecated:: Deprecated in NX11.0.0.

Obtain the expression using Motion::SpringBuilder::PreloadedAngleExpression to query or edit it.

Created in NX8.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Motion::SpringBuilder::FreeLengthExpression ( )

Returns the free length expression

Deprecated:: Deprecated in NX11.0.0.

Obtain the expression using Motion::SpringBuilder::PreloadedLengthExpression to query or edit it.

Created in NX8.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Motion::SpringBuilder::InitialLengthExpression ( )

Returns the initial length expression for spring which attachs to slide joint
Created in NX8.0.0.

License requirements : None

bool NXOpen::Motion::SpringBuilder::LengthFlag ( )

Returns the length flag, if this flag is set to true, it will not update the preloaded length, if this flag is set to false, it will update the preloaded length according to the installed length
Created in NX8.5.0.

License requirements : None

NXString NXOpen::Motion::SpringBuilder::Name ( )

Returns the name
Created in NX6.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Motion::SpringBuilder::PreloadAngleExpression ( )

Returns the preload expression

Deprecated:: Deprecated in NX11.0.0.

Obtain the expression using Motion::SpringBuilder::ActuatorMomentExpression to query or edit it.

Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Motion::SpringBuilder::PreloadedAngleExpression ( )

Returns the preloaded angle expression
Created in NX11.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Motion::SpringBuilder::PreloadedLengthExpression ( )

Returns the preloaded length expression
Created in NX11.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Motion::SpringBuilder::PreloadExpression ( )

Returns the preload expression

Deprecated:: Deprecated in NX11.0.0.

Obtain the expression using Motion::SpringBuilder::ActuatorForceExpression to query or edit it.

Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Motion::SpringBuilder::PreloadForceExpression ( )

Returns the preload force expression

Deprecated:: Deprecated in NX12.0.0.

Obtain the expression using Motion::SpringBuilder::ActuatorForceExpression to query or edit it.

Created in NX11.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Motion::SpringBuilder::PreloadMomentExpression ( )

Returns the preload moment expression

Deprecated:: Deprecated in NX12.0.0.

Obtain the expression using Motion::SpringBuilder::ActuatorMomentExpression to query or edit it.

Created in NX11.0.0.

License requirements : None

void NXOpen::Motion::SpringBuilder::SetActuatorFunction ( NXOpen::CAE::Function * actuatorFunction )

Sets the actuator function tag.

Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

actuatorFunction actuatorfunction

void NXOpen::Motion::SpringBuilder::SetActuatorType ( NXOpen::Motion::ConnectorCoefficientTypes actuatorType )

Sets the actuator spline type
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

actuatorType actuatortype

void NXOpen::Motion::SpringBuilder::SetCoefficientFunction ( NXOpen::CAE::Function * function )

Sets the function tag.

Only valid if Motion::ConnectorCoefficientTypesSpline is set
Created in NX8.5.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

function function

void NXOpen::Motion::SpringBuilder::SetCoefficientType ( NXOpen::Motion::ConnectorCoefficientTypes coefficientType )

Sets the coefficient type
Created in NX8.5.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

coefficientType coefficienttype

void NXOpen::Motion::SpringBuilder::SetCreateDamper ( bool createDamper )

Sets the create damper toggle
Created in NX8.5.0.

License requirements : None

Parameters

createDamper createdamper

void NXOpen::Motion::SpringBuilder::SetDamperAppDirection ( NXOpen::Motion::ConnectorBuilder::ApplicationDirection appDirection )

Sets the application direction of damper
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

appDirection appdirection

void NXOpen::Motion::SpringBuilder::SetDamperCustomizedSolver ( bool customizedSolver )

Sets the option of using Customized Solver for damper
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

customizedSolver customizedsolver

void NXOpen::Motion::SpringBuilder::SetDamperName ( const NXString & damperName )

Sets the damper dname
Created in NX8.5.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

damperName dampername

void NXOpen::Motion::SpringBuilder::SetDamperName ( const char * damperName )

Sets the damper dname
Created in NX8.5.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

damperName dampername

void NXOpen::Motion::SpringBuilder::SetLengthFlag ( bool lengthFlag )

Sets the length flag, if this flag is set to true, it will not update the preloaded length, if this flag is set to false, it will update the preloaded length according to the installed length
Created in NX8.5.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

lengthFlag lengthflag

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

Sets the name
Created in NX6.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

name name

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

Sets the name
Created in NX6.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

name name

void NXOpen::Motion::SpringBuilder::SetSpringAppDirection ( NXOpen::Motion::ConnectorBuilder::ApplicationDirection springAppDirection )

Sets the application direction for damper
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

springAppDirection springappdirection

void NXOpen::Motion::SpringBuilder::SetSpringCustomizedSolver ( bool springCustomizedSolver )

Sets the option of using Customized Solver for damper
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

springCustomizedSolver springcustomizedsolver

void NXOpen::Motion::SpringBuilder::SetStiffnessFunction ( NXOpen::CAE::Function * function )

Sets the function tag.

On Adams and Recurdyn, only valid if Motion::ConnectorCoefficientTypesSpline is set
Created in NX6.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

function function

void NXOpen::Motion::SpringBuilder::SetStiffnessType ( NXOpen::Motion::ConnectorCoefficientTypes stiffnessType )

Sets the stiffness type
Created in NX6.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

stiffnessType stiffnesstype

NXOpen::Motion::ConnectorBuilder::ApplicationDirection NXOpen::Motion::SpringBuilder::SpringAppDirection ( )

Returns the application direction for damper
Created in NX12.0.0.

License requirements : None

bool NXOpen::Motion::SpringBuilder::SpringCustomizedSolver ( )

Returns the option of using Customized Solver for damper
Created in NX12.0.0.

License requirements : None

NXOpen::Motion::SelectFieldData* NXOpen::Motion::SpringBuilder::StiffnessCurveProfile ( )

Returns the stiffness 2D profile.

Only valid if Motion::ConnectorCoefficientTypesProfile2d or Motion::ConnectorCoefficientTypesExpressionAndProfile2d is set.
Created in NX12.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Motion::SpringBuilder::StiffnessExpression ( )

Returns the stiffness expression
Created in NX8.0.0.

License requirements : None

NXOpen::CAE::Function* NXOpen::Motion::SpringBuilder::StiffnessFunction ( )

Returns the function tag.

On Adams and Recurdyn, only valid if Motion::ConnectorCoefficientTypesSpline is set
Created in NX6.0.0.

License requirements : None

NXOpen::Motion::SelectFieldData* NXOpen::Motion::SpringBuilder::StiffnessSurfaceProfile ( )

Returns the stiffness 3D profile.

Only valid if Motion::ConnectorCoefficientTypesProfile3d or Motion::ConnectorCoefficientTypesExpressionAndProfile3d is set.
Created in NX12.0.0.

License requirements : None

NXOpen::Motion::ConnectorCoefficientTypes NXOpen::Motion::SpringBuilder::StiffnessType ( )

Returns the stiffness type
Created in NX6.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Motion::SpringBuilder::TorsionalCoefficientExpression ( )

Returns the torsional coefficient expression
Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Motion::SpringBuilder::TorsionalStiffnessExpression ( )

Returns the torsional stiffness expression
Created in NX8.0.0.

License requirements : None

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

Motion_SpringBuilder.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation