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

Represents a NXOpen::Motion::TextBasedElementBuilder builder
To create a new instance of this class, use NXOpen::Motion::TextBasedElementCollection::CreateTextBasedElementBuilder

Created in NX12.0.0. More...

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

Public Types

enum  TypeChoices {
  TypeChoicesThreePointForce, TypeChoicesThreePointTorque, TypeChoicesAllKinematicDirectionSensor, TypeChoicesAllForceDirectionSensor,
  TypeChoicesAeroAeroForce, TypeChoicesAeroHydroForce, TypeChoicesAeroVehicleForce, TypeChoicesCustomizedSolver,
  TypeChoicesStiTire, TypeChoicesStiTireProperty, TypeChoicesBumpStopContact, TypeChoicesSphereToGroundContact,
  TypeChoicesGearContact, TypeChoicesThreeLinkSuspension, TypeChoicesFourLinkSuspension, TypeChoicesFiveLinkSuspension,
  TypeChoicesRollIaxSuspension, TypeChoicesSteerIaxSuspension, TypeChoicesHotchKissSuspension, TypeChoicesMcPhersonSuspension,
  TypeChoicesDoubleAArmSuspension, TypeChoicesPivotBeamSuspension, TypeChoicesVehicle, TypeChoicesSpeedSweep,
  TypeChoicesSystemProperty, TypeChoicesDynamicProperty, TypeChoicesKinematicProperty, TypeChoicesStaticProperty,
  TypeChoicesPreloadProperty, TypeChoicesInverseProperty, TypeChoicesLinearizationProperty, TypeChoicesRestartProperty,
  TypeChoicesAdvancedSolution, TypeChoicesGear, TypeChoicesGeneric, TypeChoicesFmi,
  TypeChoicesPointToPointConstraint, TypeChoicesOrientationConstraint, TypeChoicesFunctioncurveControlInput, TypeChoicesPathFollowerControlInput,
  TypeChoicesUserDefinedControlInput, TypeChoicesSpecialControlInput, TypeChoicesLinearControlOutput, TypeChoicesMassPropertyControlOutput,
  TypeChoicesLinkInitialCondition, TypeChoicesScrewJointOrSpringInitialCondition, TypeChoicesFlexibleLinkInitialCondition, TypeChoicesTireInitialCondition,
  TypeChoicesStaticVehicleAlignment, TypeChoicesSprungMass, TypeChoicesUserDefinedForce, TypeChoicesGlobalDirectionsLinkDriver,
  TypeChoicesDotOneLinkDriver, TypeChoicesDotTwoLinkDriver, TypeChoicesCurveOnCurveConstraintDriver, TypeChoicesFixedJointDriver,
  TypeChoicesLinkCouplerDriver
}
 the text based element type - multiple values More...
 

Public Member Functions

NXString Definition ()
 Returns the definition of text based element - MDF definition
Created in NX12.0.0. More...
 
void SetDefinition (const NXString &definition)
 Sets the definition of text based element - MDF definition
Created in NX12.0.0. More...
 
void SetDefinition (const char *definition)
 Sets the definition of text based element - MDF definition
Created in NX12.0.0. More...
 
void SetType (NXOpen::Motion::TextBasedElementBuilder::TypeChoices elementType)
 Sets the text based element type - multiple possible values
Created in NX12.0.0. More...
 
NXOpen::Motion::TextBasedElementBuilder::TypeChoices Type ()
 Returns the text based element type - multiple possible values
Created in NX12.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::TextBasedElementBuilder builder
To create a new instance of this class, use NXOpen::Motion::TextBasedElementCollection::CreateTextBasedElementBuilder

Created in NX12.0.0.


Member Enumeration Documentation

the text based element type - multiple values

Enumerator
TypeChoicesThreePointForce 

three point force

TypeChoicesThreePointTorque 

three point torque

TypeChoicesAllKinematicDirectionSensor 

all kinematic direction sensor

TypeChoicesAllForceDirectionSensor 

all force direction sensor

TypeChoicesAeroAeroForce 

aero aero force

TypeChoicesAeroHydroForce 

aero hydro force

TypeChoicesAeroVehicleForce 

aero vehicle force

TypeChoicesCustomizedSolver 

customized solver

TypeChoicesStiTire 

sti tire

TypeChoicesStiTireProperty 

sti tire property

TypeChoicesBumpStopContact 

bump stop contact

TypeChoicesSphereToGroundContact 

sphere to ground contact

TypeChoicesGearContact 

gear contact

TypeChoicesThreeLinkSuspension 

three link suspension

TypeChoicesFourLinkSuspension 

four link suspension

TypeChoicesFiveLinkSuspension 

five link suspension

TypeChoicesRollIaxSuspension 

roll iax suspension

TypeChoicesSteerIaxSuspension 

steer iax suspension

TypeChoicesHotchKissSuspension 

hotch kiss suspension

TypeChoicesMcPhersonSuspension 

mc pherson suspension

TypeChoicesDoubleAArmSuspension 

double aarm suspension

TypeChoicesPivotBeamSuspension 

pivot beam suspension

TypeChoicesVehicle 

vehicle

TypeChoicesSpeedSweep 

speed sweep

TypeChoicesSystemProperty 

system property

TypeChoicesDynamicProperty 

dynamic property

TypeChoicesKinematicProperty 

kinematic property

TypeChoicesStaticProperty 

static property

TypeChoicesPreloadProperty 

preload property

TypeChoicesInverseProperty 

inverse property

TypeChoicesLinearizationProperty 

linearization property

TypeChoicesRestartProperty 

restart property

TypeChoicesAdvancedSolution 

advanced solution

TypeChoicesGear 

gear

TypeChoicesGeneric 

generic

TypeChoicesFmi 

fmi

TypeChoicesPointToPointConstraint 

point to point constraint

TypeChoicesOrientationConstraint 

orientation constraint

TypeChoicesFunctioncurveControlInput 

functioncurve control input

TypeChoicesPathFollowerControlInput 

path follower control input

TypeChoicesUserDefinedControlInput 

user defined control input

TypeChoicesSpecialControlInput 

special control input

TypeChoicesLinearControlOutput 

linear control output

TypeChoicesMassPropertyControlOutput 

mass property control output

TypeChoicesLinkInitialCondition 

link initial condition

TypeChoicesScrewJointOrSpringInitialCondition 

screw joint or spring initial condition

TypeChoicesFlexibleLinkInitialCondition 

flexible link initial condition

TypeChoicesTireInitialCondition 

tire initial condition

TypeChoicesStaticVehicleAlignment 

static vehicle alignment

TypeChoicesSprungMass 

sprung mass

TypeChoicesUserDefinedForce 

user defined force

TypeChoicesGlobalDirectionsLinkDriver 

global directions link driver

TypeChoicesDotOneLinkDriver 

dot one link driver

TypeChoicesDotTwoLinkDriver 

dot two link driver

TypeChoicesCurveOnCurveConstraintDriver 

curve on curve constraint driver

TypeChoicesFixedJointDriver 

fixed joint driver

TypeChoicesLinkCouplerDriver 

link coupler driver

Member Function Documentation

NXString NXOpen::Motion::TextBasedElementBuilder::Definition ( )

Returns the definition of text based element - MDF definition
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::TextBasedElementBuilder::SetDefinition ( const NXString definition)

Sets the definition of text based element - MDF definition
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
definitiondefinition
void NXOpen::Motion::TextBasedElementBuilder::SetDefinition ( const char *  definition)

Sets the definition of text based element - MDF definition
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
definitiondefinition
void NXOpen::Motion::TextBasedElementBuilder::SetType ( NXOpen::Motion::TextBasedElementBuilder::TypeChoices  elementType)

Sets the text based element type - multiple possible values
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
elementTypeelementtype
NXOpen::Motion::TextBasedElementBuilder::TypeChoices NXOpen::Motion::TextBasedElementBuilder::Type ( )

Returns the text based element type - multiple possible values
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.