BaseDataWheelBuilder Class¶
-
class
NXOpen.Features.VehicleDesign.BaseDataWheelBuilder¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.Features.VehicleDesign.BaseDataWheelBuilder.This class can only be used in base data, thus cannot be created directly by user.
New in version NX8.5.0.
Properties¶
| Property | Description |
|---|---|
| Camber | Returns or sets the wheel camber in degree. |
| CoordinateX | Returns or sets the x coordinate of right wheel center point or attachment point. |
| CoordinateY | Returns or sets the y coordinate of right wheel center point or attachment point. |
| CoordinateZ | Returns or sets the z coordinate of right wheel center point or attachment point. |
| Diameter | Returns or sets the norminal diameter of the wheel. |
| Name | Returns or sets the name of the wheel. |
| PositionDefinition | Returns or sets the value to indicate which option is used to define the wheel position. |
| RimOffset | Returns or sets the rim offset. |
| ShowSurface | Returns or sets the option to indicate whether to show surface or not. |
| ShowWireframe | Returns or sets the option to indicate whether to show curve or not. |
| StaticRadius | Returns or sets the static radius of the wheel. |
| Tag | Returns the Tag for this object. |
| Toe | Returns or sets the wheel toe in/out in degreee. |
| Track | Returns the track of the axle. |
| Width | Returns or sets the width of the wheel. |
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¶
| BaseDataWheelBuilderPositionDefinitionOptions Enumeration | This enum represents the options to define the wheel position. |
Property Detail¶
Camber¶
-
BaseDataWheelBuilder.Camber¶ Returns or sets the wheel camber in degree.
-------------------------------------Getter Method
Signature
Camber()Returns: Return type: float New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Camber(dValue)Parameters: dValue (float) – New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
CoordinateX¶
-
BaseDataWheelBuilder.CoordinateX¶ Returns or sets the x coordinate of right wheel center point or attachment point.
If
NXOpen.Features.VehicleDesign.BaseDataWheelBuilder.PositionDefinition()isNXOpen.Features.VehicleDesign.BaseDataWheelBuilderPositionDefinitionOptions.WheelCenterPoint, it is center point x coordinate. IfNXOpen.Features.VehicleDesign.BaseDataWheelBuilder.PositionDefinition`()isNXOpen.Features.VehicleDesign.BaseDataWheelBuilderPositionDefinitionOptions.AttachmentPointRimOffset, it is attachment point x coordinate. The left wheel will be located symmetrical to the vehicle centerline.-------------------------------------Getter Method
Signature
CoordinateX()Returns: Return type: float New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CoordinateX(dValue)Parameters: dValue (float) – New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
CoordinateY¶
-
BaseDataWheelBuilder.CoordinateY¶ Returns or sets the y coordinate of right wheel center point or attachment point.
If
NXOpen.Features.VehicleDesign.BaseDataWheelBuilder.PositionDefinition`()isNXOpen.Features.VehicleDesign.BaseDataWheelBuilderPositionDefinitionOptions.WheelCenterPoint, it is center point y coordinate. IfNXOpen.Features.VehicleDesign.BaseDataWheelBuilder.PositionDefinition`()isNXOpen.Features.VehicleDesign.BaseDataWheelBuilderPositionDefinitionOptions.AttachmentPointRimOffset, it is attachment point y coordinate. The left wheel will be located symmetrical to the vehicle centerline.-------------------------------------Getter Method
Signature
CoordinateY()Returns: Return type: float New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CoordinateY(dValue)Parameters: dValue (float) – New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
CoordinateZ¶
-
BaseDataWheelBuilder.CoordinateZ¶ Returns or sets the z coordinate of right wheel center point or attachment point.
If
NXOpen.Features.VehicleDesign.BaseDataWheelBuilder.PositionDefinition`()isNXOpen.Features.VehicleDesign.BaseDataWheelBuilderPositionDefinitionOptions.WheelCenterPoint, it is center point z coordinate. IfNXOpen.Features.VehicleDesign.BaseDataWheelBuilder.PositionDefinition`()isNXOpen.Features.VehicleDesign.BaseDataWheelBuilderPositionDefinitionOptions.AttachmentPointRimOffset, it is attachment point z coordinate. The left wheel will be located symmetrical to the vehicle centerline.-------------------------------------Getter Method
Signature
CoordinateZ()Returns: Return type: float New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CoordinateZ(dValue)Parameters: dValue (float) – New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
Diameter¶
-
BaseDataWheelBuilder.Diameter¶ Returns or sets the norminal diameter of the wheel.
-------------------------------------Getter Method
Signature
Diameter()Returns: Return type: float New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Diameter(dValue)Parameters: dValue (float) – New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
Name¶
-
BaseDataWheelBuilder.Name¶ Returns or sets the name of the wheel.
-------------------------------------Getter Method
Signature
Name()Returns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Name(name)Parameters: name (str) – New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
PositionDefinition¶
-
BaseDataWheelBuilder.PositionDefinition¶ Returns or sets the value to indicate which option is used to define the wheel position.
-------------------------------------Getter Method
Signature
PositionDefinition()Returns: Return type: NXOpen.Features.VehicleDesign.BaseDataWheelBuilderPositionDefinitionOptionsNew in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
PositionDefinition(positionDefinition)Parameters: positionDefinition ( NXOpen.Features.VehicleDesign.BaseDataWheelBuilderPositionDefinitionOptions) –New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
RimOffset¶
-
BaseDataWheelBuilder.RimOffset¶ Returns or sets the rim offset.
Rim offset is the shift between the mounting point of the wheel and the wheel center. It is used only when
NXOpen.Features.VehicleDesign.BaseDataWheelBuilder.PositionDefinition`()isNXOpen.Features.VehicleDesign.BaseDataWheelBuilderPositionDefinitionOptions.AttachmentPointRimOffset.-------------------------------------Getter Method
Signature
RimOffset()Returns: Return type: float New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
RimOffset(dValue)Parameters: dValue (float) – New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
ShowSurface¶
-
BaseDataWheelBuilder.ShowSurface¶ Returns or sets the option to indicate whether to show surface or not.
If it is true, the wheel surface is shown.
-------------------------------------Getter Method
Signature
ShowSurface()Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ShowSurface(showFace)Parameters: showFace (bool) – New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
ShowWireframe¶
-
BaseDataWheelBuilder.ShowWireframe¶ Returns or sets the option to indicate whether to show curve or not.
If it is true, the wheel curve is shown.
-------------------------------------Getter Method
Signature
ShowWireframe()Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ShowWireframe(showWire)Parameters: showWire (bool) – New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
StaticRadius¶
-
BaseDataWheelBuilder.StaticRadius¶ Returns or sets the static radius of the wheel.
-------------------------------------Getter Method
Signature
StaticRadius()Returns: Return type: float New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
StaticRadius(dValue)Parameters: dValue (float) – New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
Toe¶
-
BaseDataWheelBuilder.Toe¶ Returns or sets the wheel toe in/out in degreee.
-------------------------------------Getter Method
Signature
Toe()Returns: Return type: float New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Toe(dValue)Parameters: dValue (float) – New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
Track¶
-
BaseDataWheelBuilder.Track¶ Returns the track of the axle.
Track is a computed value - the distance between the right wheel center point and the left wheel center point.
-------------------------------------Getter Method
Signature
Track()Returns: Return type: float New in version NX8.5.0.
License requirements: None.
Width¶
-
BaseDataWheelBuilder.Width¶ Returns or sets the width of the wheel.
-------------------------------------Getter Method
Signature
Width()Returns: Return type: float New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Width(dValue)Parameters: dValue (float) – New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
Method Detail¶
Validate¶
-
BaseDataWheelBuilder.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.