BaseDataBuilder Class¶
-
class
NXOpen.Features.VehicleDesign.
BaseDataBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.Features.VehicleDesign.BaseDataBuilder
.To create a new instance of this class, use
NXOpen.Features.VehicleDesignCollection.CreateBaseDataBuilder
New in version NX8.5.0.
Properties¶
Property | Description |
---|---|
BodyWidthExp | Returns the body width which is used for calculating the fields of vision according to US and CDN standards instead of vehicle width. |
Driver | Returns the driver builder, which represents a NXOpen.Features.VehicleDesign.BaseDataDriverBuilder . |
FrontOverhangExp | Returns the front overhang of the vehicle which is measured from the front wheel center point in the negative x direction. |
LoadingDefinition | Returns the loading definition. |
PassengerDefinition | Returns the passenger definition. |
RearOverhangExp | Returns the rear overhang of the vehicle which is measured from the rear wheel center point in the positive x direction. |
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. |
Tag | Returns the Tag for this object. |
VehicleCategory | Returns or sets the vehicle category. |
VehicleDescription | Returns or sets the name or short description of the vehicle. |
VehicleWidthExp | Returns the vehicle width which is calculated outgoing from the vehicle mid plane half of the defined value in positive y direction and as well half of the defined value in negative y direction. |
WheelPositionDefinition | Returns or sets the wheel position definition option of the vehicle. |
Methods¶
Method | Description |
---|---|
AddLoading | Adds a loading, which represents NXOpen.Features.VehicleDesign.BaseDataLoadingBuilder , to the base data. |
AddPassenger | Adds a passenger, which represents NXOpen.Features.VehicleDesign.BaseDataPassengerBuilder , to the base data. |
Commit | Commits any edits that have been applied to the builder. |
CreateLoading | Creates an instance of NXOpen.Features.VehicleDesign.BaseDataLoadingBuilder from another instance. |
CreatePassenger | Creates an instance of NXOpen.Features.VehicleDesign.BaseDataPassengerBuilder from another instance. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetBodyWidth | Returns the body width. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetFrontOverhang | Returns the front overhang of the vehicle. |
GetLoadingCount | Returns the total number of loadings in the base data. |
GetNthLoading | Returns the nth loading, which represents NXOpen.Features.VehicleDesign.BaseDataLoadingBuilder , from the base data. |
GetNthPassenger | Returns the nth passenger, which represents NXOpen.Features.VehicleDesign.BaseDataPassengerBuilder , from the base data. |
GetNthWheel | Gets the nth wheel. |
GetObject | Returns the object currently being edited by this builder. |
GetPassengerCount | Returns the total number of passengers in the base data. |
GetRearOverhang | Returns the rear overhang of the vehicle. |
GetVehicleLength | Returns the overall vehicle length. |
GetVehicleWidth | Returns the vehicle width. |
GetWheelbase | Returns the wheelbase of the vehicle. |
RemoveLoading | Removes a loading, which represents NXOpen.Features.VehicleDesign.BaseDataLoadingBuilder , from the base data. |
RemovePassenger | Removes a passenger, which represents NXOpen.Features.VehicleDesign.BaseDataPassengerBuilder , from the base data. |
SetBodyWidth | Sets the body width. |
SetFrontOverhang | Sets the front overhang of the vehicle. |
SetRearOverhang | Sets the rear overhang of the vehicle. |
SetVehicleWidth | Sets the vehicle width. |
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. |
Property Detail¶
BodyWidthExp¶
-
BaseDataBuilder.
BodyWidthExp
¶ Returns the body width which is used for calculating the fields of vision according to US and CDN standards instead of vehicle width.
-------------------------------------
Getter Method
Signature
BodyWidthExp()
Returns: Return type: NXOpen.Expression
New in version NX9.0.1.
License requirements: None.
Driver¶
-
BaseDataBuilder.
Driver
¶ Returns the driver builder, which represents a
NXOpen.Features.VehicleDesign.BaseDataDriverBuilder
.-------------------------------------
Getter Method
Signature
Driver()
Returns: Return type: NXOpen.Features.VehicleDesign.BaseDataDriverBuilder
New in version NX8.5.0.
License requirements: None.
FrontOverhangExp¶
-
BaseDataBuilder.
FrontOverhangExp
¶ Returns the front overhang of the vehicle which is measured from the front wheel center point in the negative x direction.
-------------------------------------
Getter Method
Signature
FrontOverhangExp()
Returns: Return type: NXOpen.Expression
New in version NX9.0.1.
License requirements: None.
LoadingDefinition¶
-
BaseDataBuilder.
LoadingDefinition
¶ Returns the loading definition.
-------------------------------------
Getter Method
Signature
LoadingDefinition()
Returns: Return type: NXOpen.Features.VehicleDesign.BaseDataLoadingBuilder
New in version NX8.5.0.
License requirements: None.
PassengerDefinition¶
-
BaseDataBuilder.
PassengerDefinition
¶ Returns the passenger definition.
-------------------------------------
Getter Method
Signature
PassengerDefinition()
Returns: Return type: NXOpen.Features.VehicleDesign.BaseDataPassengerBuilder
New in version NX8.5.0.
License requirements: None.
RearOverhangExp¶
-
BaseDataBuilder.
RearOverhangExp
¶ Returns the rear overhang of the vehicle which is measured from the rear wheel center point in the positive x direction.
-------------------------------------
Getter Method
Signature
RearOverhangExp()
Returns: Return type: NXOpen.Expression
New in version NX9.0.1.
License requirements: None.
ShowSurface¶
-
BaseDataBuilder.
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(showSurface)
Parameters: showSurface (bool) – New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
ShowWireframe¶
-
BaseDataBuilder.
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(showWireframe)
Parameters: showWireframe (bool) – New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
VehicleCategory¶
-
BaseDataBuilder.
VehicleCategory
¶ Returns or sets the vehicle category.
-------------------------------------
Getter Method
Signature
VehicleCategory()
Returns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
VehicleCategory(vehicleCategory)
Parameters: vehicleCategory (str) – New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
VehicleDescription¶
-
BaseDataBuilder.
VehicleDescription
¶ Returns or sets the name or short description of the vehicle.
-------------------------------------
Getter Method
Signature
VehicleDescription()
Returns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
VehicleDescription(vehicleDescription)
Parameters: vehicleDescription (str) – New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
VehicleWidthExp¶
-
BaseDataBuilder.
VehicleWidthExp
¶ Returns the vehicle width which is calculated outgoing from the vehicle mid plane half of the defined value in positive y direction and as well half of the defined value in negative y direction.
-------------------------------------
Getter Method
Signature
VehicleWidthExp()
Returns: Return type: NXOpen.Expression
New in version NX9.0.1.
License requirements: None.
WheelPositionDefinition¶
-
BaseDataBuilder.
WheelPositionDefinition
¶ Returns or sets the wheel position definition option of the vehicle.
-------------------------------------
Getter Method
Signature
WheelPositionDefinition()
Returns: Return type: NXOpen.Features.VehicleDesign.BaseDataWheelBuilderPositionDefinitionOptions
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
WheelPositionDefinition(positionDefinition)
Parameters: positionDefinition ( NXOpen.Features.VehicleDesign.BaseDataWheelBuilderPositionDefinitionOptions
) –New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
Method Detail¶
AddLoading¶
-
BaseDataBuilder.
AddLoading
¶ Adds a loading, which represents
NXOpen.Features.VehicleDesign.BaseDataLoadingBuilder
, to the base data.Signature
AddLoading(loading)
Parameters: loading ( NXOpen.Features.VehicleDesign.BaseDataLoadingBuilder
) –New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
AddPassenger¶
-
BaseDataBuilder.
AddPassenger
¶ Adds a passenger, which represents
NXOpen.Features.VehicleDesign.BaseDataPassengerBuilder
, to the base data.Signature
AddPassenger(passenger)
Parameters: passenger ( NXOpen.Features.VehicleDesign.BaseDataPassengerBuilder
) –New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
CreateLoading¶
-
BaseDataBuilder.
CreateLoading
¶ Creates an instance of
NXOpen.Features.VehicleDesign.BaseDataLoadingBuilder
from another instance.If pOther is NULL, the created builder will be initialized with default value. If pOther is not NULL, the created builder will be iniialized with pOther’s value.
Signature
CreateLoading(pOther)
Parameters: pOther ( NXOpen.Features.VehicleDesign.BaseDataLoadingBuilder
) – data to be initialized from, can be NULLReturns: Return type: NXOpen.Features.VehicleDesign.BaseDataLoadingBuilder
New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
CreatePassenger¶
-
BaseDataBuilder.
CreatePassenger
¶ Creates an instance of
NXOpen.Features.VehicleDesign.BaseDataPassengerBuilder
from another instance.If pOther is NULL, the created builder will be initialized with default value. If pOther is not NULL, the created builder will be iniialized with pOther’s value.
Signature
CreatePassenger(pOther)
Parameters: pOther ( NXOpen.Features.VehicleDesign.BaseDataPassengerBuilder
) – Data to be initialized from, can be NULLReturns: Return type: NXOpen.Features.VehicleDesign.BaseDataPassengerBuilder
New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
GetBodyWidth¶
-
BaseDataBuilder.
GetBodyWidth
¶ Returns the body width.
This value is used for calculating the fields of vision according to US and CDN standards instead of vehicle width.
Signature
GetBodyWidth()
Returns: Return type: float New in version NX9.0.1.
License requirements: None.
GetFrontOverhang¶
-
BaseDataBuilder.
GetFrontOverhang
¶ Returns the front overhang of the vehicle.
The front overhang is measured from the front wheel center point in the negative x direction.
Signature
GetFrontOverhang()
Returns: Return type: float New in version NX8.5.0.
Deprecated since version NX9.0.1: Obtain the expression using
NXOpen.Features.VehicleDesign.BaseDataBuilder.FrontOverhangExp
to query or edit it.License requirements: None.
GetLoadingCount¶
-
BaseDataBuilder.
GetLoadingCount
¶ Returns the total number of loadings in the base data.
Signature
GetLoadingCount()
Returns: Return type: int New in version NX8.5.0.
License requirements: None.
GetNthLoading¶
-
BaseDataBuilder.
GetNthLoading
¶ Returns the nth loading, which represents
NXOpen.Features.VehicleDesign.BaseDataLoadingBuilder
, from the base data.Signature
GetNthLoading(nIndex)
Parameters: nIndex (int) – Returns: Return type: NXOpen.Features.VehicleDesign.BaseDataLoadingBuilder
New in version NX8.5.0.
License requirements: None.
GetNthPassenger¶
-
BaseDataBuilder.
GetNthPassenger
¶ Returns the nth passenger, which represents
NXOpen.Features.VehicleDesign.BaseDataPassengerBuilder
, from the base data.Signature
GetNthPassenger(nIndex)
Parameters: nIndex (int) – Returns: Return type: NXOpen.Features.VehicleDesign.BaseDataPassengerBuilder
New in version NX8.5.0.
License requirements: None.
GetNthWheel¶
-
BaseDataBuilder.
GetNthWheel
¶ Gets the nth wheel.
Signature
GetNthWheel(nWheelIndex)
Parameters: nWheelIndex (int) – Returns: Return type: NXOpen.Features.VehicleDesign.BaseDataWheelBuilder
New in version NX8.5.0.
License requirements: None.
GetPassengerCount¶
-
BaseDataBuilder.
GetPassengerCount
¶ Returns the total number of passengers in the base data.
Signature
GetPassengerCount()
Returns: Return type: int New in version NX8.5.0.
License requirements: None.
GetRearOverhang¶
-
BaseDataBuilder.
GetRearOverhang
¶ Returns the rear overhang of the vehicle.
The rear overhang is measured from the rear wheel center point in the positive x direction.
Signature
GetRearOverhang()
Returns: Return type: float New in version NX8.5.0.
Deprecated since version NX9.0.1: Obtain the expression using
NXOpen.Features.VehicleDesign.BaseDataBuilder.RearOverhangExp
to query or edit it.License requirements: None.
GetVehicleLength¶
-
BaseDataBuilder.
GetVehicleLength
¶ Returns the overall vehicle length.
Vehicle length is a computed value and cannot be changed by the user. The underlying formula calculates vehicle length based on wheelbase plus front and back overhang.
Signature
GetVehicleLength()
Returns: Return type: float New in version NX8.5.0.
License requirements: None.
GetVehicleWidth¶
-
BaseDataBuilder.
GetVehicleWidth
¶ Returns the vehicle width.
The vehicle width is calculated outgoing from the vehicle mid plane half of the defined value in positive y direction and as well half of the defined value in negative y direction.
Signature
GetVehicleWidth()
Returns: Return type: float New in version NX8.5.0.
Deprecated since version NX9.0.1: Obtain the expression using
NXOpen.Features.VehicleDesign.BaseDataBuilder.VehicleWidthExp
to query or edit it.License requirements: None.
GetWheelbase¶
-
BaseDataBuilder.
GetWheelbase
¶ Returns the wheelbase of the vehicle.
Wheelbase is a computed value and cannot be changed by the user. The underlying formula calculates wheelbase based on the x coordinate of the rear wheel center point minus the x coordinate of the front wheel center point.
Signature
GetWheelbase()
Returns: Return type: float New in version NX8.5.0.
License requirements: None.
RemoveLoading¶
-
BaseDataBuilder.
RemoveLoading
¶ Removes a loading, which represents
NXOpen.Features.VehicleDesign.BaseDataLoadingBuilder
, from the base data.Signature
RemoveLoading(loading)
Parameters: loading ( NXOpen.Features.VehicleDesign.BaseDataLoadingBuilder
) –New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
RemovePassenger¶
-
BaseDataBuilder.
RemovePassenger
¶ Removes a passenger, which represents
NXOpen.Features.VehicleDesign.BaseDataPassengerBuilder
, from the base data.Signature
RemovePassenger(passenger)
Parameters: passenger ( NXOpen.Features.VehicleDesign.BaseDataPassengerBuilder
) –New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
SetBodyWidth¶
-
BaseDataBuilder.
SetBodyWidth
¶ Sets the body width.
This value is used for calculating the fields of vision according to US and CDN standards instead of vehicle width.
Signature
SetBodyWidth(bodyWidth)
Parameters: bodyWidth (float) – New in version NX8.5.0.
Deprecated since version NX9.0.1: Obtain the expression using
NXOpen.Features.VehicleDesign.BaseDataBuilder.BodyWidthExp
to query or edit it.License requirements: nx_general_packaging (“NX General Packaging”)
SetFrontOverhang¶
-
BaseDataBuilder.
SetFrontOverhang
¶ Sets the front overhang of the vehicle.
The front overhang is measured from the front wheel center point in the negative x direction.
Signature
SetFrontOverhang(overhangFront)
Parameters: overhangFront (float) – New in version NX8.5.0.
Deprecated since version NX9.0.1: Obtain the expression using
NXOpen.Features.VehicleDesign.BaseDataBuilder.FrontOverhangExp
to query or edit it.License requirements: nx_general_packaging (“NX General Packaging”)
SetRearOverhang¶
-
BaseDataBuilder.
SetRearOverhang
¶ Sets the rear overhang of the vehicle.
The rear overhang is measured from the rear wheel center point in the positive x direction.
Signature
SetRearOverhang(overhangBack)
Parameters: overhangBack (float) – New in version NX8.5.0.
Deprecated since version NX9.0.1: Obtain the expression using
NXOpen.Features.VehicleDesign.BaseDataBuilder.RearOverhangExp
to query or edit it.License requirements: nx_general_packaging (“NX General Packaging”)
SetVehicleWidth¶
-
BaseDataBuilder.
SetVehicleWidth
¶ Sets the vehicle width.
The vehicle width is calculated outgoing from the vehicle mid plane half of the defined value in positive y direction and as well half of the defined value in negative y direction.
Signature
SetVehicleWidth(vehicleWidth)
Parameters: vehicleWidth (float) – New in version NX8.5.0.
Deprecated since version NX9.0.1: Obtain the expression using
NXOpen.Features.VehicleDesign.BaseDataBuilder.VehicleWidthExp
to query or edit it.License requirements: nx_general_packaging (“NX General Packaging”)
Validate¶
-
BaseDataBuilder.
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.