Represents a Motion::Tire builder
To create a new instance of this class, use NXOpen::Motion::TireCollection::CreateTireBuilder
Default values. More...

Inheritance diagram for NXOpen::Motion::TireBuilder:

Public Types
enum	Type { TypeBasic, TypeMFTyreAndMFSwift, TypeCDTire, TypeFTire, TypeMotorcycle, TypeNonInertial }
	the Tire type. More...

Public Member Functions
NXOpen::Motion::SelectLink *	BodyLink ()
	Returns the motion body. More...

NXOpen::Motion::ParamOverrideState	BodyLinkOvrCtrl ()
	Returns the override state of the body link Created in NX1847.0.0. More...

NXOpen::Point *	BodyPoint ()
	Returns the body point. More...

NXOpen::Motion::ParamOverrideState	BodyPointOvrCtrl ()
	Returns the override state of the body point Created in NX1847.0.0. More...

NXOpen::Direction *	BodyVector ()
	Returns the body vector. More...

NXOpen::Motion::ParamOverrideState	BodyVectorOvrCtrl ()
	Returns the override state of the body vector Created in NX1847.0.0. More...

NXOpen::CoordinateSystem *	CarrierCsys ()
	Returns the carrier coordinate system. More...

NXOpen::Motion::ParamOverrideState	CarrierCsysOvrCtrl ()
	Returns the override state of the Carrier Csys Created in NX1847.0.0. More...

NXOpen::Motion::SelectLink *	CarrierLink ()
	Returns the carrier motion body. More...

NXOpen::Motion::ParamOverrideState	CarrierLinkOvrCtrl ()
	Returns the override state of the Carrier Link Created in NX1847.0.0. More...

NXOpen::Point *	CarrierPoint ()
	Returns the carrier point. More...

NXOpen::Motion::ParamOverrideState	CarrierPointOvrCtrl ()
	Returns the override state of the Carrier Point Created in NX1847.0.0. More...

NXOpen::CoordinateSystem *	ChassisCsys ()
	Returns the chassis coordinate system. More...

NXOpen::Motion::ParamOverrideState	ChassisCsysOvrCtrl ()
	Returns the override state of the Chassis Csys Created in NX1847.0.0. More...

NXOpen::Motion::SelectLink *	ChassisLink ()
	Returns the chassis motion body. More...

NXOpen::Motion::ParamOverrideState	ChassisLinkOvrCtrl ()
	Returns the override state of the Chassis Link Created in NX1847.0.0. More...

NXOpen::Point *	ChassisPoint ()
	Returns the chassis point. More...

NXOpen::Motion::ParamOverrideState	ChassisPointOvrCtrl ()
	Returns the override state of the Chassis Point Created in NX1847.0.0. More...

NXString	Name ()
	Returns the unique name assigned to the tire component Created in NX11.0.0. More...

NXOpen::Motion::SelectTirePropertyBasic *	PropertyBasic ()
	Returns the basic tire property. More...

NXOpen::Motion::SelectTirePropertyCd *	PropertyCd ()
	Returns the CD tire property. More...

NXOpen::Motion::SelectTirePropertyFt *	PropertyFTire ()
	Returns the FT tire property. More...

NXOpen::Motion::SelectTirePropertyMFTyreAndMFSwift *	PropertyMFTyreAndMFSwift ()
	Returns. More...

NXOpen::Motion::SelectTirePropertyMotorcycle *	PropertyMotorcycle ()
	Returns the motorcycle tire property. More...

NXOpen::Motion::SelectTirePropertyNonInertial *	PropertyNonInertial ()
	Returns the non-inertial tire property. More...

NXOpen::Motion::SelectRoad *	Road ()
	Returns the road. More...

void	SetBodyLinkOvrCtrl (NXOpen::Motion::ParamOverrideState overrideState)
	Sets the override state of the body link Created in NX1847.0.0. More...

void	SetBodyPoint (NXOpen::Point *bodyPoint)
	Sets the body point. More...

void	SetBodyPointOvrCtrl (NXOpen::Motion::ParamOverrideState overrideState)
	Sets the override state of the body point Created in NX1847.0.0. More...

void	SetBodyVector (NXOpen::Direction *bodyVector)
	Sets the body vector. More...

void	SetBodyVectorOvrCtrl (NXOpen::Motion::ParamOverrideState overrideState)
	Sets the override state of the body vector Created in NX1847.0.0. More...

void	SetCarrierCsys (NXOpen::CoordinateSystem *csys)
	Sets the carrier coordinate system. More...

void	SetCarrierCsysOvrCtrl (NXOpen::Motion::ParamOverrideState overrideState)
	Sets the override state of the Carrier Csys Created in NX1847.0.0. More...

void	SetCarrierLinkOvrCtrl (NXOpen::Motion::ParamOverrideState overrideState)
	Sets the override state of the Carrier Link Created in NX1847.0.0. More...

void	SetCarrierPoint (NXOpen::Point *point)
	Sets the carrier point. More...

void	SetCarrierPointOvrCtrl (NXOpen::Motion::ParamOverrideState overrideState)
	Sets the override state of the Carrier Point Created in NX1847.0.0. More...

void	SetChassisCsys (NXOpen::CoordinateSystem *chassisCsys)
	Sets the chassis coordinate system. More...

void	SetChassisCsysOvrCtrl (NXOpen::Motion::ParamOverrideState overrideState)
	Sets the override state of the Chassis Csys Created in NX1847.0.0. More...

void	SetChassisLinkOvrCtrl (NXOpen::Motion::ParamOverrideState overrideState)
	Sets the override state of the Chassis Link Created in NX1847.0.0. More...

void	SetChassisPoint (NXOpen::Point *chassisPoint)
	Sets the chassis point. More...

void	SetChassisPointOvrCtrl (NXOpen::Motion::ParamOverrideState overrideState)
	Sets the override state of the Chassis Point Created in NX1847.0.0. More...

void	SetName (const NXString &name)
	Sets the unique name assigned to the tire component Created in NX11.0.0. More...

void	SetName (const char *name)
	Sets the unique name assigned to the tire component Created in NX11.0.0. More...

void	SetTireType (NXOpen::Motion::TireBuilder::Type typeSelection)
	Sets the tire type. More...

NXOpen::Motion::TireBuilder::Type	TireType ()
	Returns the tire type. 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...

Detailed Description

Represents a Motion::Tire builder
To create a new instance of this class, use NXOpen::Motion::TireCollection::CreateTireBuilder
Default values.

Property

Value

DisplayScale

1.0

TireType

Basic

Created in NX11.0.0.

Member Enumeration Documentation

enum NXOpen::Motion::TireBuilder::Type

the Tire type.

Each tire type has a specific tire property associated. A tire is invalid without a tire property associated.

Enumerator
TypeBasic	for Basic Tire Model
TypeMFTyreAndMFSwift	for MF-Tyre and MF-Swift Model
TypeCDTire	for CDTire Tire Model
TypeFTire	for FTire Tire Model
TypeMotorcycle	for Motorcycle Tire Model
TypeNonInertial	for Non-Inertial Tire Model

Member Function Documentation

NXOpen::Motion::SelectLink* NXOpen::Motion::TireBuilder::BodyLink ( )

Returns the motion body.

This is a motion body defining the Tire body.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::ParamOverrideState NXOpen::Motion::TireBuilder::BodyLinkOvrCtrl ( )

Returns the override state of the body link
Created in NX1847.0.0.

License requirements : None

NXOpen::Point* NXOpen::Motion::TireBuilder::BodyPoint ( )

Returns the body point.

This represents the center of the wheel.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::ParamOverrideState NXOpen::Motion::TireBuilder::BodyPointOvrCtrl ( )

Returns the override state of the body point
Created in NX1847.0.0.

License requirements : None

NXOpen::Direction* NXOpen::Motion::TireBuilder::BodyVector ( )

Returns the body vector.

This defines the spinning direction.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::ParamOverrideState NXOpen::Motion::TireBuilder::BodyVectorOvrCtrl ( )

Returns the override state of the body vector
Created in NX1847.0.0.

License requirements : None

NXOpen::CoordinateSystem* NXOpen::Motion::TireBuilder::CarrierCsys ( )

Returns the carrier coordinate system.

This represents a coordinate systeme attached to the chassis for which: z axis defines the up direction and the x axis defines the forward direction of the chassis. It is only used by external tires.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::ParamOverrideState NXOpen::Motion::TireBuilder::CarrierCsysOvrCtrl ( )

Returns the override state of the Carrier Csys
Created in NX1847.0.0.

License requirements : None

NXOpen::Motion::SelectLink* NXOpen::Motion::TireBuilder::CarrierLink ( )

Returns the carrier motion body.

This represents the motion body where the tire will be attached. It is only used by external tires.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::ParamOverrideState NXOpen::Motion::TireBuilder::CarrierLinkOvrCtrl ( )

Returns the override state of the Carrier Link
Created in NX1847.0.0.

License requirements : None

NXOpen::Point* NXOpen::Motion::TireBuilder::CarrierPoint ( )

Returns the carrier point.

This represents the attachment point of the tire motion body on the chassis motion body. It is only used by external tires.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::ParamOverrideState NXOpen::Motion::TireBuilder::CarrierPointOvrCtrl ( )

Returns the override state of the Carrier Point
Created in NX1847.0.0.

License requirements : None

NXOpen::CoordinateSystem* NXOpen::Motion::TireBuilder::ChassisCsys ( )

Returns the chassis coordinate system.

This represents a coordinate systeme attached to the chassis for which z axis defines the up direction and the x axis defines the forward direction of the chassis. For external tires it is optional and it is used for the purposes of including additional stabilizing stiffness to the vehicle motion body during static analysis, provided that the Static Hold variable is TRUE. Ideally all tire elements should refer to the same Chassis axis system. If this optional parameter is not defined, the stabilizing stiffness will be applied to the selected axis system on the carrier motion body. This approach may introduce unwanted transients into a STATIC/DYNAMIC simulation.

Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::ParamOverrideState NXOpen::Motion::TireBuilder::ChassisCsysOvrCtrl ( )

Returns the override state of the Chassis Csys
Created in NX1847.0.0.

License requirements : None

NXOpen::Motion::SelectLink* NXOpen::Motion::TireBuilder::ChassisLink ( )

Returns the chassis motion body.

This represents the motion body where the tire will be attached. For external tires it is used for static data analysis.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::ParamOverrideState NXOpen::Motion::TireBuilder::ChassisLinkOvrCtrl ( )

Returns the override state of the Chassis Link
Created in NX1847.0.0.

License requirements : None

NXOpen::Point* NXOpen::Motion::TireBuilder::ChassisPoint ( )

Returns the chassis point.

This represents the attachment point of the tire body on the motion chassis.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::ParamOverrideState NXOpen::Motion::TireBuilder::ChassisPointOvrCtrl ( )

Returns the override state of the Chassis Point
Created in NX1847.0.0.

License requirements : None

NXString NXOpen::Motion::TireBuilder::Name ( )

Returns the unique name assigned to the tire component
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::SelectTirePropertyBasic* NXOpen::Motion::TireBuilder::PropertyBasic ( )

Returns the basic tire property.

This is an object used to hold parameters for Basic tire type.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::SelectTirePropertyCd* NXOpen::Motion::TireBuilder::PropertyCd ( )

Returns the CD tire property.

This is an object used to hold parameters for CDTire type
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::SelectTirePropertyFt* NXOpen::Motion::TireBuilder::PropertyFTire ( )

Returns the FT tire property.

This is an object used to hold parameters for FTire type
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::SelectTirePropertyMFTyreAndMFSwift* NXOpen::Motion::TireBuilder::PropertyMFTyreAndMFSwift ( )

Returns.

the MF-Tyre property.

This is an object used to hold parameters for MF-Tyre type.

Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::SelectTirePropertyMotorcycle* NXOpen::Motion::TireBuilder::PropertyMotorcycle ( )

Returns the motorcycle tire property.

This is an object used to hold parameters for Motorcycle tire type.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::SelectTirePropertyNonInertial* NXOpen::Motion::TireBuilder::PropertyNonInertial ( )

Returns the non-inertial tire property.

This is an object used to hold parameters for Non-Inertial tire type.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::SelectRoad* NXOpen::Motion::TireBuilder::Road ( )

Returns the road.

This parameter defines the road height Z and slope of the road surface depending on the X and Y location of the tire. If no road is selected, the road profile will default to the global XY plane.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::TireBuilder::SetBodyLinkOvrCtrl ( NXOpen::Motion::ParamOverrideState overrideState )

Sets the override state of the body link
Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

overrideState overridestate

void NXOpen::Motion::TireBuilder::SetBodyPoint ( NXOpen::Point * bodyPoint )

Sets the body point.

This represents the center of the wheel.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

bodyPoint bodypoint

void NXOpen::Motion::TireBuilder::SetBodyPointOvrCtrl ( NXOpen::Motion::ParamOverrideState overrideState )

Sets the override state of the body point
Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

overrideState overridestate

void NXOpen::Motion::TireBuilder::SetBodyVector ( NXOpen::Direction * bodyVector )

Sets the body vector.

This defines the spinning direction.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

bodyVector bodyvector

void NXOpen::Motion::TireBuilder::SetBodyVectorOvrCtrl ( NXOpen::Motion::ParamOverrideState overrideState )

Sets the override state of the body vector
Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

overrideState overridestate

void NXOpen::Motion::TireBuilder::SetCarrierCsys ( NXOpen::CoordinateSystem * csys )

Sets the carrier coordinate system.

This represents a coordinate systeme attached to the chassis for which: z axis defines the up direction and the x axis defines the forward direction of the chassis. It is only used by external tires.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

csys csys

void NXOpen::Motion::TireBuilder::SetCarrierCsysOvrCtrl ( NXOpen::Motion::ParamOverrideState overrideState )

Sets the override state of the Carrier Csys
Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

overrideState overridestate

void NXOpen::Motion::TireBuilder::SetCarrierLinkOvrCtrl ( NXOpen::Motion::ParamOverrideState overrideState )

Sets the override state of the Carrier Link
Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

overrideState overridestate

void NXOpen::Motion::TireBuilder::SetCarrierPoint ( NXOpen::Point * point )

Sets the carrier point.

This represents the attachment point of the tire motion body on the chassis motion body. It is only used by external tires.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

point point

void NXOpen::Motion::TireBuilder::SetCarrierPointOvrCtrl ( NXOpen::Motion::ParamOverrideState overrideState )

Sets the override state of the Carrier Point
Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

overrideState overridestate

void NXOpen::Motion::TireBuilder::SetChassisCsys ( NXOpen::CoordinateSystem * chassisCsys )

Sets the chassis coordinate system.

This represents a coordinate systeme attached to the chassis for which z axis defines the up direction and the x axis defines the forward direction of the chassis. For external tires it is optional and it is used for the purposes of including additional stabilizing stiffness to the vehicle motion body during static analysis, provided that the Static Hold variable is TRUE. Ideally all tire elements should refer to the same Chassis axis system. If this optional parameter is not defined, the stabilizing stiffness will be applied to the selected axis system on the carrier motion body. This approach may introduce unwanted transients into a STATIC/DYNAMIC simulation.

Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

chassisCsys chassiscsys

void NXOpen::Motion::TireBuilder::SetChassisCsysOvrCtrl ( NXOpen::Motion::ParamOverrideState overrideState )

Sets the override state of the Chassis Csys
Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

overrideState overridestate

void NXOpen::Motion::TireBuilder::SetChassisLinkOvrCtrl ( NXOpen::Motion::ParamOverrideState overrideState )

Sets the override state of the Chassis Link
Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

overrideState overridestate

void NXOpen::Motion::TireBuilder::SetChassisPoint ( NXOpen::Point * chassisPoint )

Sets the chassis point.

This represents the attachment point of the tire body on the motion chassis.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

chassisPoint chassispoint

void NXOpen::Motion::TireBuilder::SetChassisPointOvrCtrl ( NXOpen::Motion::ParamOverrideState overrideState )

Sets the override state of the Chassis Point
Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

overrideState overridestate

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

Sets the unique name assigned to the tire component
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

name name

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

Sets the unique name assigned to the tire component
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

name name

void NXOpen::Motion::TireBuilder::SetTireType ( NXOpen::Motion::TireBuilder::Type typeSelection )

Sets the tire type.

Defines the type of the tire used, different tire types use different parameters
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

typeSelection typeselection

NXOpen::Motion::TireBuilder::Type NXOpen::Motion::TireBuilder::TireType ( )

Returns the tire type.

Defines the type of the tire used, different tire types use different parameters
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

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

Motion_TireBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation