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

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

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

Public Types

enum  PositionDefinitionOptions { PositionDefinitionOptionsWheelCenterPoint, PositionDefinitionOptionsAttachmentPointRimOffset }
 This enum represents the options to define the wheel position. More...
 

Public Member Functions

double Camber ()
 Returns the wheel camber in degree. More...
 
double CoordinateX ()
 Returns the x coordinate of right wheel center point or attachment point. More...
 
double CoordinateY ()
 Returns the y coordinate of right wheel center point or attachment point. More...
 
double CoordinateZ ()
 Returns the z coordinate of right wheel center point or attachment point. More...
 
double Diameter ()
 Returns the norminal diameter of the wheel. More...
 
NXString Name ()
 Returns the name of the wheel. More...
 
NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::PositionDefinitionOptions PositionDefinition ()
 Returns the value to indicate which option is used to define the wheel position. More...
 
double RimOffset ()
 Returns the rim offset. More...
 
void SetCamber (double dValue)
 Sets the wheel camber in degree. More...
 
void SetCoordinateX (double dValue)
 Sets the x coordinate of right wheel center point or attachment point. More...
 
void SetCoordinateY (double dValue)
 Sets the y coordinate of right wheel center point or attachment point. More...
 
void SetCoordinateZ (double dValue)
 Sets the z coordinate of right wheel center point or attachment point. More...
 
void SetDiameter (double dValue)
 Sets the norminal diameter of the wheel. More...
 
void SetName (const NXString &name)
 Sets the name of the wheel. More...
 
void SetName (const char *name)
 Sets the name of the wheel. More...
 
void SetPositionDefinition (NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::PositionDefinitionOptions positionDefinition)
 Sets the value to indicate which option is used to define the wheel position. More...
 
void SetRimOffset (double dValue)
 Sets the rim offset. More...
 
void SetShowSurface (bool showFace)
 Sets the option to indicate whether to show surface or not. More...
 
void SetShowWireframe (bool showWire)
 Sets the option to indicate whether to show curve or not. More...
 
void SetStaticRadius (double dValue)
 Sets the static radius of the wheel. More...
 
void SetToe (double dValue)
 Sets the wheel toe in/out in degreee. More...
 
void SetWidth (double dValue)
 Sets the width of the wheel. 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...
 
double StaticRadius ()
 Returns the static radius of the wheel. More...
 
double Toe ()
 Returns the wheel toe in/out in degreee. More...
 
double Track ()
 Returns the track of the axle. More...
 
double Width ()
 Returns the width of the wheel. 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::BaseDataWheelBuilder .


This class can only be used in base data, thus cannot be created directly by user.

Created in NX8.5.0.

Member Enumeration Documentation

This enum represents the options to define the wheel position.

Enumerator
PositionDefinitionOptionsWheelCenterPoint 

wheel center point

PositionDefinitionOptionsAttachmentPointRimOffset 

attachment point rim offset

Member Function Documentation

double NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::Camber ( )

Returns the wheel camber in degree.


Created in NX8.5.0.

License requirements : None

double NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::CoordinateX ( )

Returns the x coordinate of right wheel center point or attachment point.

If NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::PositionDefinition is NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::PositionDefinitionOptionsWheelCenterPoint , it is center point x coordinate. If NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::PositionDefinition and NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::SetPositionDefinition is NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::PositionDefinitionOptionsAttachmentPointRimOffset , it is attachment point x coordinate. The left wheel will be located symmetrical to the vehicle centerline.
Created in NX8.5.0.

License requirements : None

double NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::CoordinateY ( )
double NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::CoordinateZ ( )
double NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::Diameter ( )

Returns the norminal diameter of the wheel.


Created in NX8.5.0.

License requirements : None

NXString NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::Name ( )

Returns the name of the wheel.


Created in NX8.5.0.

License requirements : None

NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::PositionDefinitionOptions NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::PositionDefinition ( )

Returns the value to indicate which option is used to define the wheel position.


Created in NX8.5.0.

License requirements : None

double NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::RimOffset ( )

Returns 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 and NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::SetPositionDefinition is NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::PositionDefinitionOptionsAttachmentPointRimOffset .
Created in NX8.5.0.

License requirements : None

void NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::SetCamber ( double  dValue)

Sets the wheel camber in degree.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
dValuedvalue
void NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::SetCoordinateX ( double  dValue)

Sets the x coordinate of right wheel center point or attachment point.

If NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::PositionDefinition is NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::PositionDefinitionOptionsWheelCenterPoint , it is center point x coordinate. If NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::PositionDefinition and NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::SetPositionDefinition is NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::PositionDefinitionOptionsAttachmentPointRimOffset , it is attachment point x coordinate. The left wheel will be located symmetrical to the vehicle centerline.
Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
dValuedvalue
void NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::SetCoordinateY ( double  dValue)

Sets the y coordinate of right wheel center point or attachment point.

If NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::PositionDefinition and NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::SetPositionDefinition is NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::PositionDefinitionOptionsWheelCenterPoint , it is center point y coordinate. If NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::PositionDefinition and NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::SetPositionDefinition is NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::PositionDefinitionOptionsAttachmentPointRimOffset , it is attachment point y coordinate. The left wheel will be located symmetrical to the vehicle centerline.
Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
dValuedvalue
void NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::SetCoordinateZ ( double  dValue)

Sets the z coordinate of right wheel center point or attachment point.

If NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::PositionDefinition and NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::SetPositionDefinition is NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::PositionDefinitionOptionsWheelCenterPoint , it is center point z coordinate. If NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::PositionDefinition and NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::SetPositionDefinition is NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::PositionDefinitionOptionsAttachmentPointRimOffset , it is attachment point z coordinate. The left wheel will be located symmetrical to the vehicle centerline.
Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
dValuedvalue
void NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::SetDiameter ( double  dValue)

Sets the norminal diameter of the wheel.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
dValuedvalue
void NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::SetName ( const NXString name)

Sets the name of the wheel.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
namename
void NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::SetName ( const char *  name)

Sets the name of the wheel.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
namename
void NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::SetPositionDefinition ( NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::PositionDefinitionOptions  positionDefinition)

Sets the value to indicate which option is used to define the wheel position.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
positionDefinitionpositiondefinition
void NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::SetRimOffset ( double  dValue)

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 and NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::SetPositionDefinition is NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::PositionDefinitionOptionsAttachmentPointRimOffset .
Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
dValuedvalue
void NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::SetShowSurface ( bool  showFace)

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
showFaceshowface
void NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::SetShowWireframe ( bool  showWire)

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
showWireshowwire
void NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::SetStaticRadius ( double  dValue)

Sets the static radius of the wheel.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
dValuedvalue
void NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::SetToe ( double  dValue)

Sets the wheel toe in/out in degreee.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
dValuedvalue
void NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::SetWidth ( double  dValue)

Sets the width of the wheel.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
dValuedvalue
bool NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::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::BaseDataWheelBuilder::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

double NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::StaticRadius ( )

Returns the static radius of the wheel.


Created in NX8.5.0.

License requirements : None

double NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::Toe ( )

Returns the wheel toe in/out in degreee.


Created in NX8.5.0.

License requirements : None

double NXOpen::Features::VehicleDesign::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.
Created in NX8.5.0.

License requirements : None

double NXOpen::Features::VehicleDesign::BaseDataWheelBuilder::Width ( )

Returns the width of the wheel.


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.