NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | List of all members
NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder Class Reference

Represents a Builder for Motion MF-Tyre and MF-Swift Tire Property. More...

Inheritance diagram for NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder:
NXOpen::Motion::TirePropertyBuilder NXOpen::IExternalFileReferencer 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::TirePropertyMFTyreAndMFSwiftBuilder::ContactMethodType ContactMethod ()
 Returns. More...
 
NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::DynamicsType Dynamics ()
 Returns. More...
 
virtual
NXOpen::ExternalFileReferenceAdapter
EstablishReference (int referenceObjectId, NXOpen::ExternalFileReferenceAdapter::Type referenceType, const NXString &externalFileSpec)
 Establish the external reference to the given file specification. More...
 
virtual
NXOpen::ExternalFileReferenceAdapter
EstablishReference (int referenceObjectId, NXOpen::ExternalFileReferenceAdapter::Type referenceType, const char *externalFileSpec)
 Establish the external reference to the given file specification. More...
 
virtual NXString GetExternalFileDefinitionKey (NXOpen::ExternalFileReferenceAdapter *adapter)
 Gets the file definition to use for external file adapter. More...
 
virtual
NXOpen::ExternalFileReferenceAdapter
GetExternalFileReferenceAdapter (int referenceObjectId)
 Returns the external file reference object. More...
 
NXOpen::ExpressionIswitch ()
 Returns. More...
 
NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::IswitchDefinitionType IswitchDefinition ()
 Returns. More...
 
NXOpen::ExpressionLkx ()
 Returns. More...
 
NXOpen::ExpressionLky ()
 Returns. More...
 
NXOpen::ExpressionLkyc ()
 Returns. More...
 
NXOpen::ExpressionLkzc ()
 Returns. More...
 
NXOpen::ExpressionLmux ()
 Returns. More...
 
NXOpen::ExpressionLmuy ()
 Returns. More...
 
NXOpen::ExpressionLtr ()
 Returns. More...
 
NXString MFTyreAndMFSwiftFile ()
 Returns. More...
 
NXString Name ()
 Returns. More...
 
void SetContactMethod (NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::ContactMethodType contactMethod)
 Sets. More...
 
void SetDynamics (NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::DynamicsType dynamics)
 Sets. More...
 
virtual void SetExternalFileReferenceAdapter (int referenceObjectId, NXOpen::ExternalFileReferenceAdapter *adapter)
 Sets the external file reference object. More...
 
void SetIswitchDefinition (NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::IswitchDefinitionType iswitchDef)
 Sets. More...
 
void SetMFTyreAndMFSwiftFile (const NXString &fileName)
 Sets. More...
 
void SetMFTyreAndMFSwiftFile (const char *fileName)
 Sets. More...
 
void SetName (const NXString &name)
 Sets. More...
 
void SetName (const char *name)
 Sets. More...
 
void SetSlipForces (NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::SlipForcesType slipForces)
 Sets. More...
 
void SetStaticHold (bool staticHold)
 Sets. More...
 
void SetTireSide (NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::TireSideType tireSide)
 Sets. More...
 
void SetTrackSide (NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::TrackSideType trackSide)
 Sets. More...
 
NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::SlipForcesType SlipForces ()
 Returns. More...
 
bool StaticHold ()
 Returns. More...
 
NXOpen::ExpressionStaticRadius ()
 Returns. More...
 
NXOpen::ExpressionStaticVerticalStiffness ()
 Returns. More...
 
NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::TireSideType TireSide ()
 Returns. More...
 
NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::TrackSideType TrackSide ()
 Returns. More...
 
NXOpen::ExpressionVerticalDamping ()
 Returns. More...
 
NXOpen::ExpressionVerticalStiffness ()
 Returns. More...
 

Detailed Description

Represents a Builder for Motion MF-Tyre and MF-Swift Tire Property.


To create a new instance of this class, use NXOpen::Motion::TirePropertyMFTyreAndMFSwiftCollection::CreateTirePropertyMftyreAndMfswiftBuilder
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 NX1847.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::TirePropertyMFTyreAndMFSwiftBuilder::ContactMethodType NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::ContactMethod ( )

Returns.

the contact method.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::DynamicsType NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::Dynamics ( )

Returns.

the dynamics type.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

virtual NXOpen::ExternalFileReferenceAdapter* NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::EstablishReference ( int  referenceObjectId,
NXOpen::ExternalFileReferenceAdapter::Type  referenceType,
const NXString externalFileSpec 
)
virtual

Establish the external reference to the given file specification.

Returns
external file reference object
Created in NX1847.0.0.

License requirements : None
Parameters
referenceObjectIdthe unique identifier to use for this reference if referencer has multiple external references
referenceTypethe kind of reference to establish
externalFileSpecthe external file specification.

Implements NXOpen::IExternalFileReferencer.

virtual NXOpen::ExternalFileReferenceAdapter* NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::EstablishReference ( int  referenceObjectId,
NXOpen::ExternalFileReferenceAdapter::Type  referenceType,
const char *  externalFileSpec 
)
virtual

Establish the external reference to the given file specification.

Returns
external file reference object
Created in NX1847.0.0.

License requirements : None
Parameters
referenceObjectIdthe unique identifier to use for this reference if referencer has multiple external references
referenceTypethe kind of reference to establish
externalFileSpecthe external file specification.

Implements NXOpen::IExternalFileReferencer.

virtual NXString NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::GetExternalFileDefinitionKey ( NXOpen::ExternalFileReferenceAdapter adapter)
virtual

Gets the file definition to use for external file adapter.


Created in NX1847.0.0.

License requirements : None

Parameters
adapterexternal file reference object

Implements NXOpen::IExternalFileReferencer.

virtual NXOpen::ExternalFileReferenceAdapter* NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::GetExternalFileReferenceAdapter ( int  referenceObjectId)
virtual

Returns the external file reference object.

In case the referencer object has multiple external references, use referenceObjectId to return the correct external file adapter.

Returns
external file reference object
Created in NX1847.0.0.

License requirements : None
Parameters
referenceObjectIdthe unique identifier of the external reference required in case where referencer has multiple external references

Implements NXOpen::IExternalFileReferencer.

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

Returns.

the Iswitch.

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

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::IswitchDefinitionType NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::IswitchDefinition ( )
NXOpen::Expression* NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::Lkx ( )

Returns.

the LKX scaling coefficient.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

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

Returns.

the LKY scaling coefficient.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

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

Returns.

the LKYC scaling coefficient.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

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

Returns.

the LKZC scaling coefficient.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

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

Returns.

the LMUX scaling coefficient.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

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

Returns.

the LMUY scaling coefficient.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

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

Returns.

the LTR scaling coefficient.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

NXString NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::MFTyreAndMFSwiftFile ( )

Returns.

the MF-Tyre and MF-Swift file.

This is a file containing information describing the MF-Tyre and MF-Swift tire.


Deprecated:
Deprecated in NX1847.0.0. Use NXOpen::IExternalFileReferencer::GetExternalFileReferenceAdapter


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

NXString NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::Name ( )

Returns.

the name.

It is a unique name within tire properties.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

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

Sets.

the contact method.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

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

Sets.

the dynamics type.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
dynamicsdynamics
virtual void NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::SetExternalFileReferenceAdapter ( int  referenceObjectId,
NXOpen::ExternalFileReferenceAdapter adapter 
)
virtual

Sets the external file reference object.

In case the referencer object has multiple external references, use referenceObjectId to set the correct reference.
Created in NX1847.0.0.

License requirements : None

Parameters
referenceObjectIdthe unique identifier of the external reference required in case where referencer has multiple external references
adapterexternal file reference object

Implements NXOpen::IExternalFileReferencer.

void NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::SetIswitchDefinition ( NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::IswitchDefinitionType  iswitchDef)

Sets.

the iswitch definition.

If set to NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::IswitchDefinitionTypeDetailed , 4 parameters are used to specify iswitch:

Otherwise it is specified as an integer value.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
iswitchDefiswitchdef
void NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::SetMFTyreAndMFSwiftFile ( const NXString fileName)

Sets.

the MF-Tyre and MF-Swift file.

This is a file containing information describing the MF-Tyre and MF-Swift tire.


Deprecated:
Deprecated in NX1847.0.0. Use NXOpen::IExternalFileReferencer::GetExternalFileReferenceAdapter


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
fileNamefilename
void NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::SetMFTyreAndMFSwiftFile ( const char *  fileName)

Sets.

the MF-Tyre and MF-Swift file.

This is a file containing information describing the MF-Tyre and MF-Swift tire.


Deprecated:
Deprecated in NX1847.0.0. Use NXOpen::IExternalFileReferencer::GetExternalFileReferenceAdapter


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
fileNamefilename
void NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::SetName ( const NXString name)

Sets.

the name.

It is a unique name within tire properties.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

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

Sets.

the name.

It is a unique name within tire properties.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

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

Sets.

the slip forces type.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

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

Sets.

the static hold.

It is used for static analysis only. If set to true, it holds the tire in position.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

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

Sets.

the tire side.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
tireSidetireside
void NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::SetTrackSide ( NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::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 NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

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

Returns.

the slip forces type.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

bool NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::StaticHold ( )

Returns.

the static hold.

It is used for static analysis only. If set to true, it holds the tire in position.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::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 NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

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

Returns.

the static vertical stiffness.

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


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::TireSideType NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::TireSide ( )

Returns.

the tire side.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::TrackSideType NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder::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 NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

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

Returns.

the Vertical Damping scaling coefficient.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

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

Returns.

the Vertical Stiffness scaling coefficient.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")


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