NXOpen::Motion::TirePropertyHighOrderParameters Class Reference

Represents a Tire Property builder for the High Order parameters used in Motorcycle and Basic properties. More...

Inheritance diagram for NXOpen::Motion::TirePropertyHighOrderParameters:

Public Types
enum	UnloadingVertStiffType { UnloadingVertStiffTypeFunction, UnloadingVertStiffTypeProfile }
	The block type can be Function when a spline curve is used or Profile when a profile is used. More...

Public Member Functions
NXOpen::Expression *	CarcassMass ()
	Returns the carcass mass Created in NX11.0.0. More...
NXOpen::Expression *	LateralDamping ()
	Returns the lateral damping. More...
bool	LateralEffects ()
	Returns the lateral effects Created in NX11.0.0. More...
NXOpen::Expression *	LateralStiffness ()
	Returns the lateral stiffness. More...
NXOpen::Expression *	LongDamping ()
	Returns the longitudinal damping Created in NX11.0.0. More...
bool	LongitudinalEffects ()
	Returns the longitudinal effects Created in NX11.0.0. More...
NXOpen::Expression *	LongStiffness ()
	Returns the longitudinal stiffness Created in NX11.0.0. More...
bool	RollMoment ()
	Returns the roll moment. More...
void	SetLateralEffects (bool inValue)
	Sets the lateral effects Created in NX11.0.0. More...
void	SetLongitudinalEffects (bool inValue)
	Sets the longitudinal effects Created in NX11.0.0. More...
void	SetRollMoment (bool inValue)
	Sets the roll moment. More...
void	SetUnloadingVerticalStiffness (NXOpen::Motion::MotionFunction *func)
	Sets the unloading vertical stiffness. More...
void	SetUnloadingVerticalStiffnessType (NXOpen::Motion::TirePropertyHighOrderParameters::UnloadingVertStiffType type)
	Sets the type. More...
void	SetVerticalCarcassEffects (bool inValue)
	Sets the vertical carcass effects Created in NX11.0.0. More...
NXOpen::Motion::MotionFunction *	UnloadingVerticalStiffness ()
	Returns the unloading vertical stiffness. More...
NXOpen::Motion::SelectFieldData *	UnloadingVerticalStiffnessProfile ()
	Returns the Profile. More...
NXOpen::Motion::TirePropertyHighOrderParameters::UnloadingVertStiffType	UnloadingVerticalStiffnessType ()
	Returns the type. More...
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...
bool	VerticalCarcassEffects ()
	Returns the vertical carcass effects Created in NX11.0.0. More...
NXOpen::Expression *	VerticalStiffnessTransVelocity ()
	Returns the vertical stiffness transitional velocity stiffness This parameter is only used in the Motion::TirePropertyBasic . More...
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents a Tire Property builder for the High Order parameters used in Motorcycle and Basic properties.

Created in NX11.0.0.

Member Enumeration Documentation

enum NXOpen::Motion::TirePropertyHighOrderParameters::UnloadingVertStiffType

The block type can be Function when a spline curve is used or Profile when a profile is used.

Enumerator
UnloadingVertStiffTypeFunction	function
UnloadingVertStiffTypeProfile	profile

Member Function Documentation

NXOpen::Expression* NXOpen::Motion::TirePropertyHighOrderParameters::CarcassMass

(

)

Returns the carcass mass
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::TirePropertyHighOrderParameters::LateralDamping

(

)

Returns the lateral damping.

This parameter is only used in the Motion::TirePropertyBasic .
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

bool NXOpen::Motion::TirePropertyHighOrderParameters::LateralEffects

(

)

Returns the lateral effects
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::TirePropertyHighOrderParameters::LateralStiffness

(

)

Returns the lateral stiffness.

This parameter is only used in the Motion::TirePropertyBasic .
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::TirePropertyHighOrderParameters::LongDamping

(

)

Returns the longitudinal damping
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

bool NXOpen::Motion::TirePropertyHighOrderParameters::LongitudinalEffects

(

)

Returns the longitudinal effects
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::TirePropertyHighOrderParameters::LongStiffness

(

)

Returns the longitudinal stiffness
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

bool NXOpen::Motion::TirePropertyHighOrderParameters::RollMoment

(

)

Returns the roll moment.

This parameter is only used in the Motion::TirePropertyBasic . It is a flag that indicates whether or not the roll moment term introduced by the lateral spring-damper should be calculated. This roll moment is caused by the lateral displacement of the tire patch when a lateral spring-damper (lateral stiff) is included in the tire model. If cornering table or cornering stiffness are used, and roll moment is set to "True", lateral stiffness is used to determine a lateral deflection that in turn is used to calculate a roll moment.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::TirePropertyHighOrderParameters::SetLateralEffects

(

bool

inValue

)

Sets the lateral effects
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

inValue

invalue

void NXOpen::Motion::TirePropertyHighOrderParameters::SetLongitudinalEffects

(

bool

inValue

)

Sets the longitudinal effects
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

inValue

invalue

void NXOpen::Motion::TirePropertyHighOrderParameters::SetRollMoment

(

bool

inValue

)

Sets the roll moment.

This parameter is only used in the Motion::TirePropertyBasic . It is a flag that indicates whether or not the roll moment term introduced by the lateral spring-damper should be calculated. This roll moment is caused by the lateral displacement of the tire patch when a lateral spring-damper (lateral stiff) is included in the tire model. If cornering table or cornering stiffness are used, and roll moment is set to "True", lateral stiffness is used to determine a lateral deflection that in turn is used to calculate a roll moment.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

inValue

invalue

void NXOpen::Motion::TirePropertyHighOrderParameters::SetUnloadingVerticalStiffness

(

NXOpen::Motion::MotionFunction *

func

)

Sets the unloading vertical stiffness.

This parameter is only used in the Motion::TirePropertyBasic .
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

func

func

void NXOpen::Motion::TirePropertyHighOrderParameters::SetUnloadingVerticalStiffnessType

(

NXOpen::Motion::TirePropertyHighOrderParameters::UnloadingVertStiffType

type

)

Sets the type.

Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

type

type

void NXOpen::Motion::TirePropertyHighOrderParameters::SetVerticalCarcassEffects

(

bool

inValue

)

Sets the vertical carcass effects
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

inValue

invalue

NXOpen::Motion::MotionFunction* NXOpen::Motion::TirePropertyHighOrderParameters::UnloadingVerticalStiffness

(

)

Returns the unloading vertical stiffness.

This parameter is only used in the Motion::TirePropertyBasic .
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::SelectFieldData* NXOpen::Motion::TirePropertyHighOrderParameters::UnloadingVerticalStiffnessProfile

(

)

Returns the Profile.

Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::TirePropertyHighOrderParameters::UnloadingVertStiffType NXOpen::Motion::TirePropertyHighOrderParameters::UnloadingVerticalStiffnessType

(

)

Returns the type.

Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

virtual bool NXOpen::Motion::TirePropertyHighOrderParameters::Validate ( )

virtual

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Returns

Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.

bool NXOpen::Motion::TirePropertyHighOrderParameters::VerticalCarcassEffects

(

)

Returns the vertical carcass effects
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::TirePropertyHighOrderParameters::VerticalStiffnessTransVelocity

(

)

Returns the vertical stiffness transitional velocity stiffness This parameter is only used in the Motion::TirePropertyBasic .

Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

---

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

• Motion_TirePropertyHighOrderParameters.hxx