NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Motion.TirePropertyBasicParameters Class Reference

Represents a TirePropertyBasicParameters builder More...

Inheritance diagram for NXOpen.Motion.TirePropertyBasicParameters:
NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.IExternalFileReferencer NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  CorneringType { Cornering, Carpet }
 A constant will be used for the Cornering Stiffness when CorneringType is 'Cornering'. More...
 

Public Member Functions

unsafe
NXOpen.ExternalFileReferenceAdapter 
EstablishReference (int referenceObjectId, NXOpen.ExternalFileReferenceAdapter.Type referenceType, string externalFileSpec)
 Establish the external reference to the given file specification. More...
 
unsafe string GetExternalFileDefinitionKey (NXOpen.ExternalFileReferenceAdapter adapter)
 Gets the file definition to use for external file adapter. More...
 
unsafe
NXOpen.ExternalFileReferenceAdapter 
GetExternalFileReferenceAdapter (int referenceObjectId)
 Returns the external file reference object. More...
 
unsafe void SetExternalFileReferenceAdapter (int referenceObjectId, NXOpen.ExternalFileReferenceAdapter adapter)
 Sets the external file reference object. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe NXOpen.Expression CorneringStiffness [get]
 Returns the cornering stiffness constant This parameter is only used in the Motion.TirePropertyBasic . More...
 
unsafe string CorneringTableFile [get, set]
 Returns or sets the cornering table file. More...
 
unsafe
NXOpen.Motion.SelectFieldData 
CorneringTableProfile [get]
 Returns the cornering table profile. More...
 
unsafe NXOpen.Expression FrictionCoefficient [get]
 Returns the friction coefficient between the tire and road. More...
 
unsafe
NXOpen.Motion.TirePropertyBasicParameters.CorneringType 
LateralForceType [get, set]
 Returns or sets the lateral force (cornering) type. More...
 
unsafe string Name [get, set]
 Returns or sets the unique name of the tire property. More...
 
unsafe NXOpen.Expression Radius [get]
 Returns the radius. More...
 
unsafe NXOpen.Expression RollingResistance [get]
 Returns the rolling resistance coefficient of the tire. More...
 
unsafe
NXOpen.Motion.ExpressionFunctionBuilder 
VerticalDamping [get]
 Returns the vertical damping. More...
 
unsafe
NXOpen.Motion.ExpressionFunctionBuilder 
VerticalStiffness [get]
 Returns the vertical stiffness. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents a TirePropertyBasicParameters builder

Created in NX11.0.0

Member Enumeration Documentation

A constant will be used for the Cornering Stiffness when CorneringType is 'Cornering'.

When CorneringType is 'Carpet', a surface will be used from a data table file.

Enumerator
Cornering 
Carpet 

Member Function Documentation

unsafe NXOpen.ExternalFileReferenceAdapter NXOpen.Motion.TirePropertyBasicParameters.EstablishReference ( int  referenceObjectId,
NXOpen.ExternalFileReferenceAdapter.Type  referenceType,
string  externalFileSpec 
)
inline

Establish the external reference to the given file specification.

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.
Returns
external file reference object

Implements NXOpen.IExternalFileReferencer.

unsafe string NXOpen.Motion.TirePropertyBasicParameters.GetExternalFileDefinitionKey ( NXOpen.ExternalFileReferenceAdapter  adapter)
inline

Gets the file definition to use for external file adapter.

Created in NX1847.0.0

License requirements: None.

Parameters
adapterexternal file reference object
Returns

Implements NXOpen.IExternalFileReferencer.

unsafe NXOpen.ExternalFileReferenceAdapter NXOpen.Motion.TirePropertyBasicParameters.GetExternalFileReferenceAdapter ( int  referenceObjectId)
inline

Returns the external file reference object.

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

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
Returns
external file reference object

Implements NXOpen.IExternalFileReferencer.

unsafe void NXOpen.Motion.TirePropertyBasicParameters.SetExternalFileReferenceAdapter ( int  referenceObjectId,
NXOpen.ExternalFileReferenceAdapter  adapter 
)
inline

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.

unsafe bool NXOpen.Motion.TirePropertyBasicParameters.Validate ( )
inline

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.

Created in NX3.0.1

License requirements: None.

Returns
Was self validation successful

Implements NXOpen.GeometricUtilities.IComponentBuilder.

Property Documentation

unsafe NXOpen.Expression NXOpen.Motion.TirePropertyBasicParameters.CorneringStiffness
get

Returns the cornering stiffness constant This parameter is only used in the Motion.TirePropertyBasic .

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

unsafe string NXOpen.Motion.TirePropertyBasicParameters.CorneringTableFile
getset

Returns or 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

Deprecated in NX12.0.1. CorneringTableProfile

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.SelectFieldData NXOpen.Motion.TirePropertyBasicParameters.CorneringTableProfile
get

Returns the cornering table profile.

Created in NX12.0.0

License requirements: mechanisms ("MECHANISMS")

unsafe NXOpen.Expression NXOpen.Motion.TirePropertyBasicParameters.FrictionCoefficient
get

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")

unsafe NXOpen.Motion.TirePropertyBasicParameters.CorneringType NXOpen.Motion.TirePropertyBasicParameters.LateralForceType
getset

Returns or sets the lateral force (cornering) type.

This parameter is only used by the Motion.TirePropertyBasic class.

Created in NX11.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe string NXOpen.Motion.TirePropertyBasicParameters.Name
getset

Returns or 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 to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Expression NXOpen.Motion.TirePropertyBasicParameters.Radius
get

Returns the radius.

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

unsafe NXOpen.Expression NXOpen.Motion.TirePropertyBasicParameters.RollingResistance
get

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")

unsafe NXOpen.Motion.ExpressionFunctionBuilder NXOpen.Motion.TirePropertyBasicParameters.VerticalDamping
get

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")

unsafe NXOpen.Motion.ExpressionFunctionBuilder NXOpen.Motion.TirePropertyBasicParameters.VerticalStiffness
get

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:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.