NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Features::VehicleDesign::BaseDataBuilder Class Reference

Represents a NXOpen::Features::VehicleDesign::BaseDataBuilder . More...

Inheritance diagram for NXOpen::Features::VehicleDesign::BaseDataBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

void AddLoading (NXOpen::Features::VehicleDesign::BaseDataLoadingBuilder *loading)
 Adds a loading, which represents NXOpen::Features::VehicleDesign::BaseDataLoadingBuilder , to the base data. More...
 
void AddPassenger (NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder *passenger)
 Adds a passenger, which represents NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder , to the base data. More...
 
NXOpen::ExpressionBodyWidthExp ()
 Returns the body width which is used for calculating the fields of vision according to US and CDN standards instead of vehicle width. More...
 
NXOpen::Features::VehicleDesign::BaseDataLoadingBuilderCreateLoading (NXOpen::Features::VehicleDesign::BaseDataLoadingBuilder *pOther)
 Creates an instance of NXOpen::Features::VehicleDesign::BaseDataLoadingBuilder from another instance. More...
 
NXOpen::Features::VehicleDesign::BaseDataPassengerBuilderCreatePassenger (NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder *pOther)
 Creates an instance of NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder from another instance. More...
 
NXOpen::Features::VehicleDesign::BaseDataDriverBuilderDriver ()
 Returns the driver builder, which represents a NXOpen::Features::VehicleDesign::BaseDataDriverBuilder . More...
 
NXOpen::ExpressionFrontOverhangExp ()
 Returns the front overhang of the vehicle which is measured from the front wheel center point in the negative x direction. More...
 
double GetBodyWidth ()
 Returns the body width. More...
 
double GetFrontOverhang ()
 Returns the front overhang of the vehicle. More...
 
int GetLoadingCount ()
 Returns the total number of loadings in the base data. More...
 
NXOpen::Features::VehicleDesign::BaseDataLoadingBuilderGetNthLoading (int nIndex)
 Returns the nth loading, which represents NXOpen::Features::VehicleDesign::BaseDataLoadingBuilder , from the base data. More...
 
NXOpen::Features::VehicleDesign::BaseDataPassengerBuilderGetNthPassenger (int nIndex)
 Returns the nth passenger, which represents NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder , from the base data. More...
 
NXOpen::Features::VehicleDesign::BaseDataWheelBuilderGetNthWheel (int nWheelIndex)
 Gets the nth wheel. More...
 
int GetPassengerCount ()
 Returns the total number of passengers in the base data. More...
 
double GetRearOverhang ()
 Returns the rear overhang of the vehicle. More...
 
double GetVehicleLength ()
 Returns the overall vehicle length. More...
 
double GetVehicleWidth ()
 Returns the vehicle width. More...
 
double GetWheelbase ()
 Returns the wheelbase of the vehicle. More...
 
NXOpen::Features::VehicleDesign::BaseDataLoadingBuilderLoadingDefinition ()
 Returns the loading definition. More...
 
NXOpen::Features::VehicleDesign::BaseDataPassengerBuilderPassengerDefinition ()
 Returns the passenger definition. More...
 
NXOpen::ExpressionRearOverhangExp ()
 Returns the rear overhang of the vehicle which is measured from the rear wheel center point in the positive x direction. More...
 
void RemoveLoading (NXOpen::Features::VehicleDesign::BaseDataLoadingBuilder *loading)
 Removes a loading, which represents NXOpen::Features::VehicleDesign::BaseDataLoadingBuilder , from the base data. More...
 
void RemovePassenger (NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder *passenger)
 Removes a passenger, which represents NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder , from the base data. More...
 
void SetBodyWidth (double bodyWidth)
 Sets the body width. More...
 
void SetFrontOverhang (double overhangFront)
 Sets the front overhang of the vehicle. More...
 
void SetRearOverhang (double overhangBack)
 Sets the rear overhang of the vehicle. More...
 
void SetShowSurface (bool showSurface)
 Sets the option to indicate whether to show surface or not. More...
 
void SetShowWireframe (bool showWireframe)
 Sets the option to indicate whether to show curve or not. More...
 
void SetVehicleCategory (const NXString &vehicleCategory)
 Sets the vehicle category. More...
 
void SetVehicleCategory (const char *vehicleCategory)
 Sets the vehicle category. More...
 
void SetVehicleDescription (const NXString &vehicleDescription)
 Sets the name or short description of the vehicle. More...
 
void SetVehicleDescription (const char *vehicleDescription)
 Sets the name or short description of the vehicle. More...
 
void SetVehicleWidth (double vehicleWidth)
 Sets the vehicle width. More...
 
void SetWheelPositionDefinition (NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::PositionDefinitionOptions positionDefinition)
 Sets the wheel position definition option of the vehicle. More...
 
bool ShowSurface ()
 Returns the option to indicate whether to show surface or not. More...
 
bool ShowWireframe ()
 Returns the option to indicate whether to show curve or not. More...
 
NXString VehicleCategory ()
 Returns the vehicle category. More...
 
NXString VehicleDescription ()
 Returns the name or short description of the vehicle. More...
 
NXOpen::ExpressionVehicleWidthExp ()
 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. More...
 
NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::PositionDefinitionOptions WheelPositionDefinition ()
 Returns the wheel position definition option of the vehicle. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a NXOpen::Features::VehicleDesign::BaseDataBuilder .


To create a new instance of this class, use NXOpen::Features::VehicleDesignCollection::CreateBaseDataBuilder

Created in NX8.5.0.

Member Function Documentation

void NXOpen::Features::VehicleDesign::BaseDataBuilder::AddLoading ( NXOpen::Features::VehicleDesign::BaseDataLoadingBuilder loading)

Adds a loading, which represents NXOpen::Features::VehicleDesign::BaseDataLoadingBuilder , to the base data.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
loadingloading
void NXOpen::Features::VehicleDesign::BaseDataBuilder::AddPassenger ( NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder passenger)

Adds a passenger, which represents NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder , to the base data.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
passengerpassenger
NXOpen::Expression* NXOpen::Features::VehicleDesign::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.


Created in NX9.0.1.

License requirements : None

NXOpen::Features::VehicleDesign::BaseDataLoadingBuilder* NXOpen::Features::VehicleDesign::BaseDataBuilder::CreateLoading ( NXOpen::Features::VehicleDesign::BaseDataLoadingBuilder pOther)

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.

Returns

Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")
Parameters
pOtherdata to be initialized from, can be NULL
NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder* NXOpen::Features::VehicleDesign::BaseDataBuilder::CreatePassenger ( NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder pOther)

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.

Returns

Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")
Parameters
pOtherData to be initialized from, can be NULL
NXOpen::Features::VehicleDesign::BaseDataDriverBuilder* NXOpen::Features::VehicleDesign::BaseDataBuilder::Driver ( )

Returns the driver builder, which represents a NXOpen::Features::VehicleDesign::BaseDataDriverBuilder .


Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::BaseDataBuilder::FrontOverhangExp ( )

Returns the front overhang of the vehicle which is measured from the front wheel center point in the negative x direction.


Created in NX9.0.1.

License requirements : None

double NXOpen::Features::VehicleDesign::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.

Returns

Created in NX9.0.1.

License requirements : None
double NXOpen::Features::VehicleDesign::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.

Returns

Deprecated:
Deprecated in NX9.0.1. Obtain the expression using NXOpen::Features::VehicleDesign::BaseDataBuilder::FrontOverhangExp to query or edit it.


Created in NX8.5.0.

License requirements : None

int NXOpen::Features::VehicleDesign::BaseDataBuilder::GetLoadingCount ( )

Returns the total number of loadings in the base data.

Returns

Created in NX8.5.0.

License requirements : None
NXOpen::Features::VehicleDesign::BaseDataLoadingBuilder* NXOpen::Features::VehicleDesign::BaseDataBuilder::GetNthLoading ( int  nIndex)

Returns the nth loading, which represents NXOpen::Features::VehicleDesign::BaseDataLoadingBuilder , from the base data.

Returns

Created in NX8.5.0.

License requirements : None
Parameters
nIndexnindex
NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder* NXOpen::Features::VehicleDesign::BaseDataBuilder::GetNthPassenger ( int  nIndex)

Returns the nth passenger, which represents NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder , from the base data.

Returns

Created in NX8.5.0.

License requirements : None
Parameters
nIndexnindex
NXOpen::Features::VehicleDesign::BaseDataWheelBuilder* NXOpen::Features::VehicleDesign::BaseDataBuilder::GetNthWheel ( int  nWheelIndex)

Gets the nth wheel.

Returns

Created in NX8.5.0.

License requirements : None
Parameters
nWheelIndexnwheelindex
int NXOpen::Features::VehicleDesign::BaseDataBuilder::GetPassengerCount ( )

Returns the total number of passengers in the base data.

Returns

Created in NX8.5.0.

License requirements : None
double NXOpen::Features::VehicleDesign::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.

Returns

Deprecated:
Deprecated in NX9.0.1. Obtain the expression using NXOpen::Features::VehicleDesign::BaseDataBuilder::RearOverhangExp to query or edit it.


Created in NX8.5.0.

License requirements : None

double NXOpen::Features::VehicleDesign::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.

Returns

Created in NX8.5.0.

License requirements : None
double NXOpen::Features::VehicleDesign::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.

Returns

Deprecated:
Deprecated in NX9.0.1. Obtain the expression using NXOpen::Features::VehicleDesign::BaseDataBuilder::VehicleWidthExp to query or edit it.


Created in NX8.5.0.

License requirements : None

double NXOpen::Features::VehicleDesign::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.

Returns

Created in NX8.5.0.

License requirements : None
NXOpen::Features::VehicleDesign::BaseDataLoadingBuilder* NXOpen::Features::VehicleDesign::BaseDataBuilder::LoadingDefinition ( )

Returns the loading definition.


Created in NX8.5.0.

License requirements : None

NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder* NXOpen::Features::VehicleDesign::BaseDataBuilder::PassengerDefinition ( )

Returns the passenger definition.


Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::BaseDataBuilder::RearOverhangExp ( )

Returns the rear overhang of the vehicle which is measured from the rear wheel center point in the positive x direction.


Created in NX9.0.1.

License requirements : None

void NXOpen::Features::VehicleDesign::BaseDataBuilder::RemoveLoading ( NXOpen::Features::VehicleDesign::BaseDataLoadingBuilder loading)

Removes a loading, which represents NXOpen::Features::VehicleDesign::BaseDataLoadingBuilder , from the base data.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
loadingloading
void NXOpen::Features::VehicleDesign::BaseDataBuilder::RemovePassenger ( NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder passenger)

Removes a passenger, which represents NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder , from the base data.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
passengerpassenger
void NXOpen::Features::VehicleDesign::BaseDataBuilder::SetBodyWidth ( double  bodyWidth)

Sets the body width.

This value is used for calculating the fields of vision according to US and CDN standards instead of vehicle width.

Deprecated:
Deprecated in NX9.0.1. Obtain the expression using NXOpen::Features::VehicleDesign::BaseDataBuilder::BodyWidthExp to query or edit it.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
bodyWidthbodywidth
void NXOpen::Features::VehicleDesign::BaseDataBuilder::SetFrontOverhang ( double  overhangFront)

Sets the front overhang of the vehicle.

The front overhang is measured from the front wheel center point in the negative x direction.

Deprecated:
Deprecated in NX9.0.1. Obtain the expression using NXOpen::Features::VehicleDesign::BaseDataBuilder::FrontOverhangExp to query or edit it.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
overhangFrontoverhangfront
void NXOpen::Features::VehicleDesign::BaseDataBuilder::SetRearOverhang ( double  overhangBack)

Sets the rear overhang of the vehicle.

The rear overhang is measured from the rear wheel center point in the positive x direction.

Deprecated:
Deprecated in NX9.0.1. Obtain the expression using NXOpen::Features::VehicleDesign::BaseDataBuilder::RearOverhangExp to query or edit it.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
overhangBackoverhangback
void NXOpen::Features::VehicleDesign::BaseDataBuilder::SetShowSurface ( bool  showSurface)

Sets the option to indicate whether to show surface or not.

If it is true, the wheel surface is shown.
Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
showSurfaceshowsurface
void NXOpen::Features::VehicleDesign::BaseDataBuilder::SetShowWireframe ( bool  showWireframe)

Sets the option to indicate whether to show curve or not.

If it is true, the wheel curve is shown.
Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
showWireframeshowwireframe
void NXOpen::Features::VehicleDesign::BaseDataBuilder::SetVehicleCategory ( const NXString vehicleCategory)

Sets the vehicle category.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
vehicleCategoryvehiclecategory
void NXOpen::Features::VehicleDesign::BaseDataBuilder::SetVehicleCategory ( const char *  vehicleCategory)

Sets the vehicle category.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
vehicleCategoryvehiclecategory
void NXOpen::Features::VehicleDesign::BaseDataBuilder::SetVehicleDescription ( const NXString vehicleDescription)

Sets the name or short description of the vehicle.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
vehicleDescriptionvehicledescription
void NXOpen::Features::VehicleDesign::BaseDataBuilder::SetVehicleDescription ( const char *  vehicleDescription)

Sets the name or short description of the vehicle.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
vehicleDescriptionvehicledescription
void NXOpen::Features::VehicleDesign::BaseDataBuilder::SetVehicleWidth ( double  vehicleWidth)

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.

Deprecated:
Deprecated in NX9.0.1. Obtain the expression using NXOpen::Features::VehicleDesign::BaseDataBuilder::VehicleWidthExp to query or edit it.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
vehicleWidthvehiclewidth
void NXOpen::Features::VehicleDesign::BaseDataBuilder::SetWheelPositionDefinition ( NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::PositionDefinitionOptions  positionDefinition)

Sets the wheel position definition option of the vehicle.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
positionDefinitionpositiondefinition
bool NXOpen::Features::VehicleDesign::BaseDataBuilder::ShowSurface ( )

Returns the option to indicate whether to show surface or not.

If it is true, the wheel surface is shown.
Created in NX8.5.0.

License requirements : None

bool NXOpen::Features::VehicleDesign::BaseDataBuilder::ShowWireframe ( )

Returns the option to indicate whether to show curve or not.

If it is true, the wheel curve is shown.
Created in NX8.5.0.

License requirements : None

NXString NXOpen::Features::VehicleDesign::BaseDataBuilder::VehicleCategory ( )

Returns the vehicle category.


Created in NX8.5.0.

License requirements : None

NXString NXOpen::Features::VehicleDesign::BaseDataBuilder::VehicleDescription ( )

Returns the name or short description of the vehicle.


Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::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.


Created in NX9.0.1.

License requirements : None

NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::PositionDefinitionOptions NXOpen::Features::VehicleDesign::BaseDataBuilder::WheelPositionDefinition ( )

Returns the wheel position definition option of the vehicle.


Created in NX8.5.0.

License requirements : None


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.