Represents a TirePropertyBasicParameters builder
Created in NX11.0.0.
More...
Public Types | |
| enum | CorneringType { CorneringTypeCornering, CorneringTypeCarpet } |
| A constant will be used for the Cornering Stiffness when CorneringType is 'Cornering'. More... | |
Public Member Functions | |
| NXOpen::Expression * | CorneringStiffness () |
| Returns the cornering stiffness constant This parameter is only used in the Motion::TirePropertyBasic . More... | |
| NXString | CorneringTableFile () |
| Returns the cornering table file. More... | |
| NXOpen::Motion::SelectFieldData * | CorneringTableProfile () |
| Returns the cornering table profile. More... | |
| NXOpen::Expression * | FrictionCoefficient () |
| Returns the friction coefficient between the tire and road. More... | |
| NXOpen::Motion::TirePropertyBasicParameters::CorneringType | LateralForceType () |
| Returns the lateral force (cornering) type. More... | |
| NXString | MagicFile () |
| Returns the magic file. More... | |
| NXString | Name () |
| Returns the unique name of the tire property. More... | |
| NXOpen::Expression * | Radius () |
| Returns the radius. More... | |
| NXOpen::Expression * | RollingResistance () |
| Returns the rolling resistance coefficient of the tire. More... | |
| void | SetCorneringTableFile (const NXString &fileName) |
| Sets the cornering table file. More... | |
| void | SetCorneringTableFile (const char *fileName) |
| Sets the cornering table file. More... | |
| void | SetLateralForceType (NXOpen::Motion::TirePropertyBasicParameters::CorneringType type) |
| Sets the lateral force (cornering) type. More... | |
| void | SetMagicFile (const NXString &fileName) |
| Sets the magic file. More... | |
| void | SetMagicFile (const char *fileName) |
| Sets the magic file. More... | |
| void | SetName (const NXString &name) |
| Sets the unique name of the tire property. More... | |
| void | SetName (const char *name) |
| Sets the unique name of the tire property. More... | |
| virtual bool | Validate () |
| Validate whether the inputs to the component are sufficient for commit to be called. More... | |
| NXOpen::Motion::ExpressionFunctionBuilder * | VerticalDamping () |
| Returns the vertical damping. More... | |
| NXOpen::Motion::ExpressionFunctionBuilder * | VerticalStiffness () |
| Returns the vertical stiffness. More... | |
 Public Member Functions inherited from NXOpen::TaggedObject | |
| tag_t | Tag () const |
| Returns the tag of this object. More... | |
Detailed Description
Represents a TirePropertyBasicParameters builder
Created in NX11.0.0.
Member Enumeration Documentation
Member Function Documentation
| NXOpen::Expression* NXOpen::Motion::TirePropertyBasicParameters::CorneringStiffness | ( | ) |
Returns the cornering stiffness constant This parameter is only used in the Motion::TirePropertyBasic .
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
| NXString NXOpen::Motion::TirePropertyBasicParameters::CorneringTableFile | ( | ) |
Returns the cornering table file.
This parameter is only used by the Motion::TirePropertyBasic (LMS) Tire Property. It is used to input the tire lateral force as a function of the steer slip angle and normal force. For a "spline explicit" type curve, X is the slip angle, Y is the normal force, and Z is the lateral forces. It is given as a data file.
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
| NXOpen::Motion::SelectFieldData* NXOpen::Motion::TirePropertyBasicParameters::CorneringTableProfile | ( | ) |
Returns the cornering table profile.
Created in NX12.0.0.
License requirements : mechanisms ("MECHANISMS")
| NXOpen::Expression* NXOpen::Motion::TirePropertyBasicParameters::FrictionCoefficient | ( | ) |
Returns the friction coefficient between the tire and road.
Should be greater than or equal to zero.
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
| NXOpen::Motion::TirePropertyBasicParameters::CorneringType NXOpen::Motion::TirePropertyBasicParameters::LateralForceType | ( | ) |
Returns the lateral force (cornering) type.
This parameter is only used by the Motion::TirePropertyBasic class.
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
| NXString NXOpen::Motion::TirePropertyBasicParameters::MagicFile | ( | ) |
Returns the magic file.
This parameter is used only by the Motion::TirePropertyMotorcycle .
A file containing coefficients for the Magic Formula formulation of lateral force, aligning torque, and longitudinal force. The coefficients are entered in free format, one-per-line, with the coefficient name first, followed by the value. Blank lines and lines starting with a semicolon (;) or asterisk (*) are ignored. The coefficient names are a single letter (A, B, or C) followed by a one-or two-digit suffix. The values presently used are A0 through A19, B0 through B13, and C0 through C26. The meaning of each coefficient is explained in the section on lateral force above. In addition, several constants can be defined to perform conversions from Simcenter model units to Magic Formula units. KFN converts normal force values, KSS converts steerslip values, KRS converts steerslip values, KCAM converts camber values, KFRC converts output force values, and KTRQ converts output torque values. For instance, a KSS value of 57.2958 might be used to convert a steerslip angle (calculated in radians) to a Magic Formula steerslip angle (in degrees). Likewise, a KTRQ value of 0.11302344 might be used to convert a Magic Formula output torque (calculated in N-m) to a Simcenter torque (in in-lb). Regardless of its use, the constant always represents the conversion factor to Magic Formula units. Example: The following set of lines are valid; This is an example lateral force coefficient A10 1.234 This is an example longitudinal force coefficient B2 5.678E-3 This is an example aligning torque coefficient C24 9.0 This is an example conversion factor, converting Simcenter normal forces (lb) to Magic Formula normal forces (kN) KFN 4.449741738D-3
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
| NXString NXOpen::Motion::TirePropertyBasicParameters::Name | ( | ) |
Returns the unique name of the tire property.
This must be set after this builder is attached to its owner.
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
| NXOpen::Expression* NXOpen::Motion::TirePropertyBasicParameters::Radius | ( | ) |
Returns the radius.
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
| NXOpen::Expression* NXOpen::Motion::TirePropertyBasicParameters::RollingResistance | ( | ) |
Returns the rolling resistance coefficient of the tire.
It is used to calculate a force as a function of the normal force. This adds to the longitudinal force acting as the tire/road interface. This represents parasitic longitudinal force due to carcass deformation losses, bearing friction, etc., as a fraction of normal force.
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
| void NXOpen::Motion::TirePropertyBasicParameters::SetCorneringTableFile | ( | const NXString & | fileName | ) |
Sets the cornering table file.
This parameter is only used by the Motion::TirePropertyBasic (LMS) Tire Property. It is used to input the tire lateral force as a function of the steer slip angle and normal force. For a "spline explicit" type curve, X is the slip angle, Y is the normal force, and Z is the lateral forces. It is given as a data file.
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
- Parameters
-
fileName filename
| void NXOpen::Motion::TirePropertyBasicParameters::SetCorneringTableFile | ( | const char * | fileName | ) |
Sets the cornering table file.
This parameter is only used by the Motion::TirePropertyBasic (LMS) Tire Property. It is used to input the tire lateral force as a function of the steer slip angle and normal force. For a "spline explicit" type curve, X is the slip angle, Y is the normal force, and Z is the lateral forces. It is given as a data file.
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
- Parameters
-
fileName filename
| void NXOpen::Motion::TirePropertyBasicParameters::SetLateralForceType | ( | NXOpen::Motion::TirePropertyBasicParameters::CorneringType | type | ) |
Sets the lateral force (cornering) type.
This parameter is only used by the Motion::TirePropertyBasic class.
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
- Parameters
-
type type
| void NXOpen::Motion::TirePropertyBasicParameters::SetMagicFile | ( | const NXString & | fileName | ) |
Sets the magic file.
This parameter is used only by the Motion::TirePropertyMotorcycle .
A file containing coefficients for the Magic Formula formulation of lateral force, aligning torque, and longitudinal force. The coefficients are entered in free format, one-per-line, with the coefficient name first, followed by the value. Blank lines and lines starting with a semicolon (;) or asterisk (*) are ignored. The coefficient names are a single letter (A, B, or C) followed by a one-or two-digit suffix. The values presently used are A0 through A19, B0 through B13, and C0 through C26. The meaning of each coefficient is explained in the section on lateral force above. In addition, several constants can be defined to perform conversions from Simcenter model units to Magic Formula units. KFN converts normal force values, KSS converts steerslip values, KRS converts steerslip values, KCAM converts camber values, KFRC converts output force values, and KTRQ converts output torque values. For instance, a KSS value of 57.2958 might be used to convert a steerslip angle (calculated in radians) to a Magic Formula steerslip angle (in degrees). Likewise, a KTRQ value of 0.11302344 might be used to convert a Magic Formula output torque (calculated in N-m) to a Simcenter torque (in in-lb). Regardless of its use, the constant always represents the conversion factor to Magic Formula units. Example: The following set of lines are valid; This is an example lateral force coefficient A10 1.234 This is an example longitudinal force coefficient B2 5.678E-3 This is an example aligning torque coefficient C24 9.0 This is an example conversion factor, converting Simcenter normal forces (lb) to Magic Formula normal forces (kN) KFN 4.449741738D-3
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
- Parameters
-
fileName filename
| void NXOpen::Motion::TirePropertyBasicParameters::SetMagicFile | ( | const char * | fileName | ) |
Sets the magic file.
This parameter is used only by the Motion::TirePropertyMotorcycle .
A file containing coefficients for the Magic Formula formulation of lateral force, aligning torque, and longitudinal force. The coefficients are entered in free format, one-per-line, with the coefficient name first, followed by the value. Blank lines and lines starting with a semicolon (;) or asterisk (*) are ignored. The coefficient names are a single letter (A, B, or C) followed by a one-or two-digit suffix. The values presently used are A0 through A19, B0 through B13, and C0 through C26. The meaning of each coefficient is explained in the section on lateral force above. In addition, several constants can be defined to perform conversions from Simcenter model units to Magic Formula units. KFN converts normal force values, KSS converts steerslip values, KRS converts steerslip values, KCAM converts camber values, KFRC converts output force values, and KTRQ converts output torque values. For instance, a KSS value of 57.2958 might be used to convert a steerslip angle (calculated in radians) to a Magic Formula steerslip angle (in degrees). Likewise, a KTRQ value of 0.11302344 might be used to convert a Magic Formula output torque (calculated in N-m) to a Simcenter torque (in in-lb). Regardless of its use, the constant always represents the conversion factor to Magic Formula units. Example: The following set of lines are valid; This is an example lateral force coefficient A10 1.234 This is an example longitudinal force coefficient B2 5.678E-3 This is an example aligning torque coefficient C24 9.0 This is an example conversion factor, converting Simcenter normal forces (lb) to Magic Formula normal forces (kN) KFN 4.449741738D-3
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
- Parameters
-
fileName filename
| void NXOpen::Motion::TirePropertyBasicParameters::SetName | ( | const NXString & | name | ) |
Sets the unique name of the tire property.
This must be set after this builder is attached to its owner.
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
- Parameters
-
name name
| void NXOpen::Motion::TirePropertyBasicParameters::SetName | ( | const char * | name | ) |
Sets the unique name of the tire property.
This must be set after this builder is attached to its owner.
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
- Parameters
-
name name
|
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.
| NXOpen::Motion::ExpressionFunctionBuilder* NXOpen::Motion::TirePropertyBasicParameters::VerticalDamping | ( | ) |
Returns the vertical damping.
It is used in the normal force calculation. It is specified as an ExpressionFunctionBuilder , depening on the type a constant (expression) or a function will be used. A vertical damping coefficient defines the normal force due to vertical deflection velocity.
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
| NXOpen::Motion::ExpressionFunctionBuilder* NXOpen::Motion::TirePropertyBasicParameters::VerticalStiffness | ( | ) |
Returns the vertical stiffness.
It is specified as an ExpressionFunctionBuilder , depening on the type a constant (expression) or a function will be used. It is the tire stiffness normal to the road profile. Vertical stiffness defines tire normal force as a linear (if a constant is selected) or a non-linear (if a function is selected) function of vertical deflection.
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
The documentation for this class was generated from the following file:
- Motion_TirePropertyBasicParameters.hxx