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

Represents a NXOpen::Features::VehicleDesign::WheelFixing builder used to create or edit a vehicle design wheel fixing. More...

Inheritance diagram for NXOpen::Features::VehicleDesign::WheelFixingBuilder:
NXOpen::Features::FeatureBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  ObjectPositionType { ObjectPositionTypeWheelExtents, ObjectPositionTypeWheelContact }
 Represents the object position used to indicate if the wheel fixing is positioned at the theoretically widest dimension of the wheel (diameter) or exactly at the wheel geometry of the base data. More...
 
enum  PositionType { PositionTypeFront, PositionTypeRear, PositionTypeBoth }
 Represents the wheel fixing positions. More...
 
enum  RequirementsControlType { RequirementsControlTypeStandardDriven, RequirementsControlTypeUserDefined }
 Represents the requirements control types to define the wheel fixing. More...
 
enum  ShapeType { ShapeTypeBlock, ShapeTypeCircleSegment }
 Represents the shape used to indicate if the wheel fixing is a block or a circle segment. More...
 
enum  WheelSizeType { WheelSizeTypeStaticRadius, WheelSizeTypeDiameter }
 Represents the wheel size used to indicate if the wheel fixing is based on static radius or the diameter of the wheels. More...
 

Public Member Functions

NXOpen::ExpressionHeightZ ()
 Returns the expression that contains the value which indicates the height Z of the wheel fixing when the shape is block. More...
 
NXOpen::ExpressionLengthX ()
 Returns the expression that contains the value which indicates the Length X of the wheel fixing when the shape is block. More...
 
NXOpen::ExpressionLevelZ ()
 Returns the expression that contains the value which indicates the level Z of the wheel fixing when the shape is circle segment. More...
 
NXString Loading ()
 Returns the loading used in the wheel fixing. More...
 
NXOpen::Features::VehicleDesign::WheelFixingBuilder::ObjectPositionType ObjectPosition ()
 Returns the wheel fixing object position. More...
 
NXOpen::Features::VehicleDesign::WheelFixingBuilder::PositionType Position ()
 Returns the wheel fixing position. More...
 
NXOpen::ExpressionRadius ()
 Returns the expression that contains the value which indicates the radius of the wheel fixing when the shape is circle segment. More...
 
NXOpen::Features::VehicleDesign::WheelFixingBuilder::RequirementsControlType RequirementsControl ()
 Returns the requirements control for standard driven or user defined. More...
 
void SetLoading (const NXString &loading)
 Sets the loading used in the wheel fixing. More...
 
void SetLoading (const char *loading)
 Sets the loading used in the wheel fixing. More...
 
void SetObjectPosition (NXOpen::Features::VehicleDesign::WheelFixingBuilder::ObjectPositionType objectPosition)
 Sets the wheel fixing object position. More...
 
void SetPosition (NXOpen::Features::VehicleDesign::WheelFixingBuilder::PositionType position)
 Sets the wheel fixing position. More...
 
void SetRequirementsControl (NXOpen::Features::VehicleDesign::WheelFixingBuilder::RequirementsControlType requirementsControl)
 Sets the requirements control for standard driven or user defined. More...
 
void SetShape (NXOpen::Features::VehicleDesign::WheelFixingBuilder::ShapeType shape)
 Sets the wheel fixing shape. More...
 
void SetStandard (const NXString &standard)
 Sets the standard used to define the wheel fixing. More...
 
void SetStandard (const char *standard)
 Sets the standard used to define the wheel fixing. More...
 
void SetWheelSize (NXOpen::Features::VehicleDesign::WheelFixingBuilder::WheelSizeType wheelSize)
 Sets the wheel size of the wheel fixing. More...
 
NXOpen::Features::VehicleDesign::WheelFixingBuilder::ShapeType Shape ()
 Returns the wheel fixing shape. More...
 
NXString Standard ()
 Returns the standard used to define the wheel fixing. More...
 
NXOpen::Features::VehicleDesign::WheelFixingBuilder::WheelSizeType WheelSize ()
 Returns the wheel size of the wheel fixing. More...
 
NXOpen::ExpressionWidthY ()
 Returns the expression that contains the value which indicates the Width Y of the wheel fixing when the shape is block. More...
 
- Public Member Functions inherited from NXOpen::Features::FeatureBuilder
NXOpen::Features::FeatureCommitFeature ()
 Commits the feature parameters and creates the feature. More...
 
NXOpen::Features::FeatureGetFeature ()
 Returns the feature currently being edited by this builder. More...
 
void HideInternalParentFeatureAfterEdit (NXOpen::Features::Feature *parentFeature)
 Re-suppress an internal parent feature (a slave feature) after it has been edited. More...
 
bool ParentFeatureInternal ()
 Returns whether or not the latest timestamped parent feature of this feature should be made internal
Created in NX5.0.0. More...
 
bool PatchSolutionFlag ()
 Returns the patch solution flag
Created in NX8.0.1. More...
 
NXString PatchSurfaceFilename ()
 Returns the patch surface filename
Created in NX8.0.1. More...
 
void SetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
 Set the parent features which would be internal or slaves to the feature being created or commited
Created in NX6.0.0. More...
 
void SetParentFeatureInternal (bool isInternal)
 Sets whether or not the latest timestamped parent feature of this feature should be made internal
Created in NX5.0.0. More...
 
void SetPatchSolutionFlag (bool optionValue)
 Sets the patch solution flag
Created in NX8.0.1. More...
 
void SetPatchSurfaceFilename (const NXString &surfaceFilename)
 Sets the patch surface filename
Created in NX8.0.1. More...
 
void SetPatchSurfaceFilename (const char *surfaceFilename)
 Sets the patch surface filename
Created in NX8.0.1. More...
 
void SetSurroundingPatchSurfaceFilename (const NXString &surroundingSurfaceFilename)
 Sets the surrounding patch surface filename
Created in NX8.0.1. More...
 
void SetSurroundingPatchSurfaceFilename (const char *surroundingSurfaceFilename)
 Sets the surrounding patch surface filename
Created in NX8.0.1. More...
 
void ShowInternalParentFeatureForEdit (NXOpen::Features::Feature *parentFeature)
 Unsuppress an internal parent feature (a slave feature) so it can be edited. More...
 
NXString SurroundingPatchSurfaceFilename ()
 Returns the surrounding patch surface filename
Created in NX8.0.1. More...
 
void UnsetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
 Set the internal parent feature of the feature being edited to external
Created in NX6.0.0. 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::WheelFixing builder used to create or edit a vehicle design wheel fixing.


To create a new instance of this class, use NXOpen::Features::VehicleDesignCollection::CreateWheelFixingBuilder
Default values.

Property Value

HeightZ.Value

0

LengthX.Value

0

LevelZ.Value

0

ObjectPosition

WheelExtents

Position

Front

Radius.Value

0

RequirementsControl

StandardDriven

Shape

Block

WheelSize

StaticRadius

WidthY.Value

0


Created in NX8.5.0.

Member Enumeration Documentation

Represents the object position used to indicate if the wheel fixing is positioned at the theoretically widest dimension of the wheel (diameter) or exactly at the wheel geometry of the base data.

Enumerator
ObjectPositionTypeWheelExtents 

wheel extents

ObjectPositionTypeWheelContact 

wheel contact

Represents the wheel fixing positions.

Enumerator
PositionTypeFront 

front

PositionTypeRear 

rear

PositionTypeBoth 

both

Represents the requirements control types to define the wheel fixing.

Enumerator
RequirementsControlTypeStandardDriven 

standard driven

RequirementsControlTypeUserDefined 

user defined

Represents the shape used to indicate if the wheel fixing is a block or a circle segment.

Enumerator
ShapeTypeBlock 

block

ShapeTypeCircleSegment 

circle segment

Represents the wheel size used to indicate if the wheel fixing is based on static radius or the diameter of the wheels.

Enumerator
WheelSizeTypeStaticRadius 

static radius

WheelSizeTypeDiameter 

diameter

Member Function Documentation

NXOpen::Expression* NXOpen::Features::VehicleDesign::WheelFixingBuilder::HeightZ ( )

Returns the expression that contains the value which indicates the height Z of the wheel fixing when the shape is block.


Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::WheelFixingBuilder::LengthX ( )

Returns the expression that contains the value which indicates the Length X of the wheel fixing when the shape is block.


Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::WheelFixingBuilder::LevelZ ( )

Returns the expression that contains the value which indicates the level Z of the wheel fixing when the shape is circle segment.


Created in NX8.5.0.

License requirements : None

NXString NXOpen::Features::VehicleDesign::WheelFixingBuilder::Loading ( )

Returns the loading used in the wheel fixing.


Created in NX8.5.0.

License requirements : None

NXOpen::Features::VehicleDesign::WheelFixingBuilder::ObjectPositionType NXOpen::Features::VehicleDesign::WheelFixingBuilder::ObjectPosition ( )

Returns the wheel fixing object position.


Created in NX8.5.0.

License requirements : None

NXOpen::Features::VehicleDesign::WheelFixingBuilder::PositionType NXOpen::Features::VehicleDesign::WheelFixingBuilder::Position ( )

Returns the wheel fixing position.


Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::WheelFixingBuilder::Radius ( )

Returns the expression that contains the value which indicates the radius of the wheel fixing when the shape is circle segment.


Created in NX8.5.0.

License requirements : None

NXOpen::Features::VehicleDesign::WheelFixingBuilder::RequirementsControlType NXOpen::Features::VehicleDesign::WheelFixingBuilder::RequirementsControl ( )

Returns the requirements control for standard driven or user defined.


Created in NX8.5.0.

License requirements : None

void NXOpen::Features::VehicleDesign::WheelFixingBuilder::SetLoading ( const NXString loading)

Sets the loading used in the wheel fixing.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
loadingloading
void NXOpen::Features::VehicleDesign::WheelFixingBuilder::SetLoading ( const char *  loading)

Sets the loading used in the wheel fixing.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
loadingloading
void NXOpen::Features::VehicleDesign::WheelFixingBuilder::SetObjectPosition ( NXOpen::Features::VehicleDesign::WheelFixingBuilder::ObjectPositionType  objectPosition)

Sets the wheel fixing object position.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
objectPositionobjectposition
void NXOpen::Features::VehicleDesign::WheelFixingBuilder::SetPosition ( NXOpen::Features::VehicleDesign::WheelFixingBuilder::PositionType  position)

Sets the wheel fixing position.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
positionposition
void NXOpen::Features::VehicleDesign::WheelFixingBuilder::SetRequirementsControl ( NXOpen::Features::VehicleDesign::WheelFixingBuilder::RequirementsControlType  requirementsControl)

Sets the requirements control for standard driven or user defined.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
requirementsControlrequirementscontrol
void NXOpen::Features::VehicleDesign::WheelFixingBuilder::SetShape ( NXOpen::Features::VehicleDesign::WheelFixingBuilder::ShapeType  shape)

Sets the wheel fixing shape.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
shapeshape
void NXOpen::Features::VehicleDesign::WheelFixingBuilder::SetStandard ( const NXString standard)

Sets the standard used to define the wheel fixing.

Only used when the requirements control type is NXOpen::Features::VehicleDesign::WheelFixingBuilder::RequirementsControlTypeStandardDriven .
Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
standardstandard
void NXOpen::Features::VehicleDesign::WheelFixingBuilder::SetStandard ( const char *  standard)

Sets the standard used to define the wheel fixing.

Only used when the requirements control type is NXOpen::Features::VehicleDesign::WheelFixingBuilder::RequirementsControlTypeStandardDriven .
Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
standardstandard
void NXOpen::Features::VehicleDesign::WheelFixingBuilder::SetWheelSize ( NXOpen::Features::VehicleDesign::WheelFixingBuilder::WheelSizeType  wheelSize)

Sets the wheel size of the wheel fixing.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
wheelSizewheelsize
NXOpen::Features::VehicleDesign::WheelFixingBuilder::ShapeType NXOpen::Features::VehicleDesign::WheelFixingBuilder::Shape ( )

Returns the wheel fixing shape.


Created in NX8.5.0.

License requirements : None

NXString NXOpen::Features::VehicleDesign::WheelFixingBuilder::Standard ( )

Returns the standard used to define the wheel fixing.

Only used when the requirements control type is NXOpen::Features::VehicleDesign::WheelFixingBuilder::RequirementsControlTypeStandardDriven .
Created in NX8.5.0.

License requirements : None

NXOpen::Features::VehicleDesign::WheelFixingBuilder::WheelSizeType NXOpen::Features::VehicleDesign::WheelFixingBuilder::WheelSize ( )

Returns the wheel size of the wheel fixing.


Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::WheelFixingBuilder::WidthY ( )

Returns the expression that contains the value which indicates the Width Y of the wheel fixing when the shape is block.


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.