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

Represents a Builder for Motion Ftire Tire Property
To create a new instance of this class, use NXOpen::Motion::TirePropertyFtCollection::CreateTirePropertyFtBuilder
Default values. More...

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

Public Member Functions

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...
 
NXString FtireFile ()
 Returns the FTire file. 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::ExpressionIdRoad ()
 Returns the IdRoad. More...
 
NXString Name ()
 Returns the name. More...
 
NXOpen::ExpressionRadius ()
 Returns the Radius. More...
 
bool RunInParallel ()
 Returns the "run in parallel" parameter. More...
 
virtual void SetExternalFileReferenceAdapter (int referenceObjectId, NXOpen::ExternalFileReferenceAdapter *adapter)
 Sets the external file reference object. More...
 
void SetFtireFile (const NXString &fileName)
 Sets the FTire file. More...
 
void SetFtireFile (const char *fileName)
 Sets the FTire file. More...
 
void SetName (const NXString &name)
 Sets the name. More...
 
void SetName (const char *name)
 Sets the name. More...
 
void SetRunInParallel (bool runInParallel)
 Sets the "run in parallel" parameter. More...
 
void SetStaticHold (bool staticHold)
 Sets the static hold. More...
 
bool StaticHold ()
 Returns the static hold. More...
 
NXOpen::ExpressionStaticVerticalStiffness ()
 Returns the static vertical stiffness. More...
 

Detailed Description

Represents a Builder for Motion Ftire Tire Property
To create a new instance of this class, use NXOpen::Motion::TirePropertyFtCollection::CreateTirePropertyFtBuilder
Default values.

Property Value

IdRoad.Value

0 (millimeters part), 0 (inches part)

Radius.Value

300.0 (millimeters part), 11.811 (inches part)

RunInParallel

0

StaticHold

1

StaticVerticalStiffness.Value

0.0 (millimeters part), 0.0 (inches part)


Created in NX11.0.0.

Member Function Documentation

virtual NXOpen::ExternalFileReferenceAdapter* NXOpen::Motion::TirePropertyFtBuilder::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::TirePropertyFtBuilder::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.

NXString NXOpen::Motion::TirePropertyFtBuilder::FtireFile ( )

Returns the FTire file.

This is a file containing information describing the FTire tire.

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


Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

virtual NXString NXOpen::Motion::TirePropertyFtBuilder::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::TirePropertyFtBuilder::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::TirePropertyFtBuilder::IdRoad ( )

Returns the IdRoad.

It is a Road type identification number.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXString NXOpen::Motion::TirePropertyFtBuilder::Name ( )

Returns the name.

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

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::TirePropertyFtBuilder::Radius ( )

Returns the Radius.

It represents the undeformed radius of the tire.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

bool NXOpen::Motion::TirePropertyFtBuilder::RunInParallel ( )

Returns the "run in parallel" parameter.

This specifies if the FTire will automatically launch itself in parallel.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

virtual void NXOpen::Motion::TirePropertyFtBuilder::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::TirePropertyFtBuilder::SetFtireFile ( const NXString fileName)

Sets the FTire file.

This is a file containing information describing the FTire tire.

Deprecated:
Deprecated in NX1847.0.0. Use NXOpen::ExternalFileReferenceAdapter::EstablishReference


Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
fileNamefilename
void NXOpen::Motion::TirePropertyFtBuilder::SetFtireFile ( const char *  fileName)

Sets the FTire file.

This is a file containing information describing the FTire tire.

Deprecated:
Deprecated in NX1847.0.0. Use NXOpen::ExternalFileReferenceAdapter::EstablishReference


Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
fileNamefilename
void NXOpen::Motion::TirePropertyFtBuilder::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::TirePropertyFtBuilder::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::TirePropertyFtBuilder::SetRunInParallel ( bool  runInParallel)

Sets the "run in parallel" parameter.

This specifies if the FTire will automatically launch itself in parallel.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
runInParallelruninparallel
void NXOpen::Motion::TirePropertyFtBuilder::SetStaticHold ( bool  staticHold)

Sets the static hold.

It controls holding forces during static analysis. These holding forces are applied to prevent tire spin and gross chassis motion (X and Y translation and yaw with respect to the road "up" vector).
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
staticHoldstatichold
bool NXOpen::Motion::TirePropertyFtBuilder::StaticHold ( )

Returns the static hold.

It controls holding forces during static analysis. These holding forces are applied to prevent tire spin and gross chassis motion (X and Y translation and yaw with respect to the road "up" vector).
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::TirePropertyFtBuilder::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")


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