TireBuilder Class

class NXOpen.Motion.TireBuilder

Bases: NXOpen.Motion.MotionBuilder

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

New in version NX11.0.0.

Properties

Property Description
BodyLink Returns the body link.
BodyPoint Returns or sets the body point.
BodyVector Returns or sets the body vector.
CarrierCsys Returns or sets the carrier coordinate system.
CarrierLink Returns the carrier link.
CarrierPoint Returns or sets the carrier point.
ChassisCsys Returns or sets the chassis coordinate system.
ChassisLink Returns the chassis link.
ChassisPoint Returns or sets the chassis point.
DisplayScale Returns or sets the icon display scale
GroupName Returns or sets the group name
GroupType Returns or sets the group type
Name Returns or sets the unique name assigned to the tire component
PropertyBasic Returns the basic tire property.
PropertyCd Returns the CD tire property.
PropertyFTire Returns the FT tire property.
PropertyMotorcycle Returns the motorcycle tire property.
PropertyNonInertial Returns the non-inertial tire property.
PropertyTno Returns the TNO tire property.
Road Returns the road.
Tag Returns the Tag for this object.
TireType Returns or sets the tire type.

Methods

Method Description
Commit Commits any edits that have been applied to the builder.
Destroy Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetObject Returns the object currently being edited by this builder.
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

TireBuilderType Enumeration the Tire type.

Property Detail

BodyPoint

TireBuilder.BodyPoint

Returns or sets the body point.

This represents the center of the wheel.

-------------------------------------

Getter Method

Signature BodyPoint

Returns:
Return type:NXOpen.Point

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature BodyPoint

Parameters:bodyPoint (NXOpen.Point) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

BodyVector

TireBuilder.BodyVector

Returns or sets the body vector.

This defines the spinning direction.

-------------------------------------

Getter Method

Signature BodyVector

Returns:
Return type:NXOpen.Direction

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature BodyVector

Parameters:bodyVector (NXOpen.Direction) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

CarrierCsys

TireBuilder.CarrierCsys

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

-------------------------------------

Getter Method

Signature CarrierCsys

Returns:
Return type:NXOpen.CoordinateSystem

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature CarrierCsys

Parameters:csys (NXOpen.CoordinateSystem) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

CarrierPoint

TireBuilder.CarrierPoint

Returns or sets the carrier point.

This represents the attachment point of the tire link on the chassis link. It is only used by external tires.

-------------------------------------

Getter Method

Signature CarrierPoint

Returns:
Return type:NXOpen.Point

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature CarrierPoint

Parameters:point (NXOpen.Point) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

ChassisCsys

TireBuilder.ChassisCsys

Returns or 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 link 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 link. This approach may introduce unwanted transients into a STATIC/DYNAMIC simulation.

-------------------------------------

Getter Method

Signature ChassisCsys

Returns:
Return type:NXOpen.CoordinateSystem

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature ChassisCsys

Parameters:chassisCsys (NXOpen.CoordinateSystem) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

ChassisPoint

TireBuilder.ChassisPoint

Returns or sets the chassis point.

This represents the attachment point of the tire body on the chassis link.

-------------------------------------

Getter Method

Signature ChassisPoint

Returns:
Return type:NXOpen.Point

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature ChassisPoint

Parameters:chassisPoint (NXOpen.Point) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

Name

TireBuilder.Name

Returns or sets the unique name assigned to the tire component

-------------------------------------

Getter Method

Signature Name

Returns:
Return type:str

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature Name

Parameters:name (str) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

PropertyBasic

TireBuilder.PropertyBasic

Returns the basic tire property.

This is an object used to hold parameters for Basic tire type.

-------------------------------------

Getter Method

Signature PropertyBasic

Returns:
Return type:NXOpen.Motion.SelectTirePropertyBasic

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

PropertyCd

TireBuilder.PropertyCd

Returns the CD tire property.

This is an object used to hold parameters for CDTire type

-------------------------------------

Getter Method

Signature PropertyCd

Returns:
Return type:NXOpen.Motion.SelectTirePropertyCd

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

PropertyFTire

TireBuilder.PropertyFTire

Returns the FT tire property.

This is an object used to hold parameters for FTire type

-------------------------------------

Getter Method

Signature PropertyFTire

Returns:
Return type:NXOpen.Motion.SelectTirePropertyFt

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

PropertyMotorcycle

TireBuilder.PropertyMotorcycle

Returns the motorcycle tire property.

This is an object used to hold parameters for Motorcycle tire type.

-------------------------------------

Getter Method

Signature PropertyMotorcycle

Returns:
Return type:NXOpen.Motion.SelectTirePropertyMotorcycle

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

PropertyNonInertial

TireBuilder.PropertyNonInertial

Returns the non-inertial tire property.

This is an object used to hold parameters for Non-Inertial tire type.

-------------------------------------

Getter Method

Signature PropertyNonInertial

Returns:
Return type:NXOpen.Motion.SelectTirePropertyNonInertial

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

PropertyTno

TireBuilder.PropertyTno

Returns the TNO tire property.

This is an object used to hold parameters for TNO Tire type

-------------------------------------

Getter Method

Signature PropertyTno

Returns:
Return type:NXOpen.Motion.SelectTirePropertyTno

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

Road

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.

-------------------------------------

Getter Method

Signature Road

Returns:
Return type:NXOpen.Motion.SelectRoad

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

TireType

TireBuilder.TireType

Returns or sets the tire type.

Defines the type of the tire used, different tire types use different parameters

-------------------------------------

Getter Method

Signature TireType

Returns:
Return type:NXOpen.Motion.TireBuilderType

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature TireType

Parameters:typeSelection (NXOpen.Motion.TireBuilderType) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

Method Detail

Validate

TireBuilder.Validate

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.

Signature Validate()

Returns:Was self validation successful
Return type:bool

New in version NX3.0.1.

License requirements: None.