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

Represents a Builder for Motion TNO Tire Property. More...

Inheritance diagram for NXOpen::Motion::TirePropertyTnoBuilder:
NXOpen::Motion::TirePropertyBuilder NXOpen::Motion::MotionBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  ContactMethodType {
  ContactMethodTypeSmoothRoad, ContactMethodTypeCircularCrossSection, ContactMethodTypeMovingRoad, ContactMethodTypeRoad2D,
  ContactMethodTypeRoad3D
}
 The Contact Method type. More...
 
enum  DynamicsType {
  DynamicsTypeSteadyState, DynamicsTypeRelaxationLinear, DynamicsTypeRelaxationNonLinear, DynamicsTypeRigidRing,
  DynamicsTypeRigidRingWithInitStatics
}
 The Dynamics type. More...
 
enum  IswitchDefinitionType { IswitchDefinitionTypeDetailed, IswitchDefinitionTypeInteger }
 The Iswitch Definition type. More...
 
enum  SlipForcesType {
  SlipForcesTypeNoMagicFormula, SlipForcesTypeLongitudinal, SlipForcesTypeLateral, SlipForcesTypeUncombined,
  SlipForcesTypeCombined, SlipForcesTypeTurnSlip
}
 The Slip Forces type. More...
 
enum  TireSideType { TireSideTypeLeft, TireSideTypeRight, TireSideTypeSymmetric, TireSideTypeMirrored }
 The Tire Side type. More...
 
enum  TrackSideType { TrackSideTypeLeft, TrackSideTypeRight }
 The Track Side type. More...
 

Public Member Functions

NXOpen::Motion::TirePropertyTnoBuilder::ContactMethodType ContactMethod ()
 Returns the contact method. More...
 
NXOpen::Motion::TirePropertyTnoBuilder::DynamicsType Dynamics ()
 Returns the dynamics type. More...
 
NXOpen::ExpressionIswitch ()
 Returns the Iswitch. More...
 
NXOpen::Motion::TirePropertyTnoBuilder::IswitchDefinitionType IswitchDefinition ()
 Returns the iswitch definition. More...
 
NXOpen::ExpressionLkx ()
 Returns the LKX scaling coefficient. More...
 
NXOpen::ExpressionLky ()
 Returns the LKY scaling coefficient. More...
 
NXOpen::ExpressionLkyc ()
 Returns the LKYC scaling coefficient. More...
 
NXOpen::ExpressionLkzc ()
 Returns the LKZC scaling coefficient. More...
 
NXOpen::ExpressionLmux ()
 Returns the LMUX scaling coefficient. More...
 
NXOpen::ExpressionLmuy ()
 Returns the LMUY scaling coefficient. More...
 
NXOpen::ExpressionLtr ()
 Returns the LTR scaling coefficient. More...
 
NXString Name ()
 Returns the name. More...
 
void SetContactMethod (NXOpen::Motion::TirePropertyTnoBuilder::ContactMethodType contactMethod)
 Sets the contact method. More...
 
void SetDynamics (NXOpen::Motion::TirePropertyTnoBuilder::DynamicsType dynamics)
 Sets the dynamics type. More...
 
void SetIswitchDefinition (NXOpen::Motion::TirePropertyTnoBuilder::IswitchDefinitionType iswitchDef)
 Sets the iswitch definition. More...
 
void SetName (const NXString &name)
 Sets the name. More...
 
void SetName (const char *name)
 Sets the name. More...
 
void SetSlipForces (NXOpen::Motion::TirePropertyTnoBuilder::SlipForcesType slipForces)
 Sets the slip forces type. More...
 
void SetStaticHold (bool staticHold)
 Sets the static hold. More...
 
void SetTireSide (NXOpen::Motion::TirePropertyTnoBuilder::TireSideType tireSide)
 Sets the tire side. More...
 
void SetTnoFile (const NXString &fileName)
 Sets the TNO file. More...
 
void SetTnoFile (const char *fileName)
 Sets the TNO file. More...
 
void SetTrackSide (NXOpen::Motion::TirePropertyTnoBuilder::TrackSideType trackSide)
 Sets the track side. More...
 
NXOpen::Motion::TirePropertyTnoBuilder::SlipForcesType SlipForces ()
 Returns the slip forces type. More...
 
bool StaticHold ()
 Returns the static hold. More...
 
NXOpen::ExpressionStaticRadius ()
 Returns the Static Radius. More...
 
NXOpen::ExpressionStaticVerticalStiffness ()
 Returns the static vertical stiffness. More...
 
NXOpen::Motion::TirePropertyTnoBuilder::TireSideType TireSide ()
 Returns the tire side. More...
 
NXString TnoFile ()
 Returns the TNO file. More...
 
NXOpen::Motion::TirePropertyTnoBuilder::TrackSideType TrackSide ()
 Returns the track side. More...
 
NXOpen::ExpressionVerticalDamping ()
 Returns the Vertical Damping scaling coefficient. More...
 
NXOpen::ExpressionVerticalStiffness ()
 Returns the Vertical Stiffness scaling coefficient. More...
 

Detailed Description

Represents a Builder for Motion TNO Tire Property.


To create a new instance of this class, use NXOpen::Motion::TirePropertyTnoCollection::CreateTirePropertyTnoBuilder
Default values.

Property Value

ContactMethod

SmoothRoad

Dynamics

SteadyState

Iswitch.Value

0 (millimeters part), 0 (inches part)

IswitchDefinition

Detailed

Lkx.Value

1.0 (millimeters part), 1.0 (inches part)

Lky.Value

1.0 (millimeters part), 1.0 (inches part)

Lkyc.Value

1.0 (millimeters part), 1.0 (inches part)

Lkzc.Value

1.0 (millimeters part), 1.0 (inches part)

Lmux.Value

1.0 (millimeters part), 1.0 (inches part)

Lmuy.Value

1.0 (millimeters part), 1.0 (inches part)

Ltr.Value

1.0 (millimeters part), 1.0 (inches part)

SlipForces

NoMagicFormula

StaticHold

1

StaticRadius.Value

0.0 (millimeters part), 0.0 (inches part)

StaticVerticalStiffness.Value

0.0 (millimeters part), 0.0 (inches part)

TireSide

Left

TrackSide

Left

VerticalDamping.Value

1.0 (millimeters part), 1.0 (inches part)

VerticalStiffness.Value

1.0 (millimeters part), 1.0 (inches part)


Created in NX11.0.0.

Member Enumeration Documentation

The Contact Method type.

Enumerator
ContactMethodTypeSmoothRoad 

smooth road

ContactMethodTypeCircularCrossSection 

circular cross section

ContactMethodTypeMovingRoad 

moving road

ContactMethodTypeRoad2D 

road2d

ContactMethodTypeRoad3D 

road3d

The Dynamics type.

Enumerator
DynamicsTypeSteadyState 

steady state

DynamicsTypeRelaxationLinear 

relaxation linear

DynamicsTypeRelaxationNonLinear 

relaxation non linear

DynamicsTypeRigidRing 

rigid ring

DynamicsTypeRigidRingWithInitStatics 

rigid ring with init statics

The Iswitch Definition type.

Enumerator
IswitchDefinitionTypeDetailed 

detailed

IswitchDefinitionTypeInteger 

integer

The Slip Forces type.

Enumerator
SlipForcesTypeNoMagicFormula 

no magic formula

SlipForcesTypeLongitudinal 

longitudinal

SlipForcesTypeLateral 

lateral

SlipForcesTypeUncombined 

uncombined

SlipForcesTypeCombined 

combined

SlipForcesTypeTurnSlip 

turn slip

The Tire Side type.

Enumerator
TireSideTypeLeft 

left

TireSideTypeRight 

right

TireSideTypeSymmetric 

symmetric

TireSideTypeMirrored 

mirrored

The Track Side type.

Enumerator
TrackSideTypeLeft 

left

TrackSideTypeRight 

right

Member Function Documentation

NXOpen::Motion::TirePropertyTnoBuilder::ContactMethodType NXOpen::Motion::TirePropertyTnoBuilder::ContactMethod ( )

Returns the contact method.


Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::TirePropertyTnoBuilder::DynamicsType NXOpen::Motion::TirePropertyTnoBuilder::Dynamics ( )

Returns the dynamics type.


Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::TirePropertyTnoBuilder::Iswitch ( )

Returns the Iswitch.

It is a Tire model usage flag.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::TirePropertyTnoBuilder::IswitchDefinitionType NXOpen::Motion::TirePropertyTnoBuilder::IswitchDefinition ( )

Returns the iswitch definition.

If set to Detailed, 4 parameters are used to specify iswitch: Tire Side, Slip Forces, Dynamics, and Contact Method. Otherwise it is specified as an integer value.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::TirePropertyTnoBuilder::Lkx ( )

Returns the LKX scaling coefficient.


Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::TirePropertyTnoBuilder::Lky ( )

Returns the LKY scaling coefficient.


Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::TirePropertyTnoBuilder::Lkyc ( )

Returns the LKYC scaling coefficient.


Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::TirePropertyTnoBuilder::Lkzc ( )

Returns the LKZC scaling coefficient.


Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::TirePropertyTnoBuilder::Lmux ( )

Returns the LMUX scaling coefficient.


Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::TirePropertyTnoBuilder::Lmuy ( )

Returns the LMUY scaling coefficient.


Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::TirePropertyTnoBuilder::Ltr ( )

Returns the LTR scaling coefficient.


Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXString NXOpen::Motion::TirePropertyTnoBuilder::Name ( )

Returns the name.

It is a uniqe name within tire properties.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::TirePropertyTnoBuilder::SetContactMethod ( NXOpen::Motion::TirePropertyTnoBuilder::ContactMethodType  contactMethod)

Sets the contact method.


Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
contactMethodcontactmethod
void NXOpen::Motion::TirePropertyTnoBuilder::SetDynamics ( NXOpen::Motion::TirePropertyTnoBuilder::DynamicsType  dynamics)

Sets the dynamics type.


Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
dynamicsdynamics
void NXOpen::Motion::TirePropertyTnoBuilder::SetIswitchDefinition ( NXOpen::Motion::TirePropertyTnoBuilder::IswitchDefinitionType  iswitchDef)

Sets the iswitch definition.

If set to Detailed, 4 parameters are used to specify iswitch: Tire Side, Slip Forces, Dynamics, and Contact Method. Otherwise it is specified as an integer value.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
iswitchDefiswitchdef
void NXOpen::Motion::TirePropertyTnoBuilder::SetName ( const NXString name)

Sets the name.

It is a uniqe name within tire properties.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

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

Sets the name.

It is a uniqe name within tire properties.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
namename
void NXOpen::Motion::TirePropertyTnoBuilder::SetSlipForces ( NXOpen::Motion::TirePropertyTnoBuilder::SlipForcesType  slipForces)

Sets the slip forces type.


Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
slipForcesslipforces
void NXOpen::Motion::TirePropertyTnoBuilder::SetStaticHold ( bool  staticHold)

Sets the static hold.

It is ussed for static analysis only. If set to true, holds the tire in position.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
staticHoldstatichold
void NXOpen::Motion::TirePropertyTnoBuilder::SetTireSide ( NXOpen::Motion::TirePropertyTnoBuilder::TireSideType  tireSide)

Sets the tire side.


Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
tireSidetireside
void NXOpen::Motion::TirePropertyTnoBuilder::SetTnoFile ( const NXString fileName)

Sets the TNO file.

This is a file containing information describing the TNO tire.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
fileNamefilename
void NXOpen::Motion::TirePropertyTnoBuilder::SetTnoFile ( const char *  fileName)

Sets the TNO file.

This is a file containing information describing the TNO tire.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
fileNamefilename
void NXOpen::Motion::TirePropertyTnoBuilder::SetTrackSide ( NXOpen::Motion::TirePropertyTnoBuilder::TrackSideType  trackSide)

Sets the track side.

Only used in combination with a 'Road Profile' Road Element that specifies road height vs. traveled distance. The *.rdf road profile file contains 2 tracks, a left track for left wheels and a right track for right wheels.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
trackSidetrackside
NXOpen::Motion::TirePropertyTnoBuilder::SlipForcesType NXOpen::Motion::TirePropertyTnoBuilder::SlipForces ( )

Returns the slip forces type.


Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

bool NXOpen::Motion::TirePropertyTnoBuilder::StaticHold ( )

Returns the static hold.

It is ussed for static analysis only. If set to true, holds the tire in position.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::TirePropertyTnoBuilder::StaticRadius ( )

Returns the Static Radius.

It is used for static analysis only. Specifies the tire radius only used in static equilibrating force calculations.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::TirePropertyTnoBuilder::StaticVerticalStiffness ( )

Returns the static vertical stiffness.

It specifies the vertical stiffness only used in static equilibrating force calculations.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::TirePropertyTnoBuilder::TireSideType NXOpen::Motion::TirePropertyTnoBuilder::TireSide ( )

Returns the tire side.


Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXString NXOpen::Motion::TirePropertyTnoBuilder::TnoFile ( )

Returns the TNO file.

This is a file containing information describing the TNO tire.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::TirePropertyTnoBuilder::TrackSideType NXOpen::Motion::TirePropertyTnoBuilder::TrackSide ( )

Returns the track side.

Only used in combination with a 'Road Profile' Road Element that specifies road height vs. traveled distance. The *.rdf road profile file contains 2 tracks, a left track for left wheels and a right track for right wheels.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::TirePropertyTnoBuilder::VerticalDamping ( )

Returns the Vertical Damping scaling coefficient.


Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::TirePropertyTnoBuilder::VerticalStiffness ( )

Returns the Vertical Stiffness scaling coefficient.


Created in NX11.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.