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

Represents a NXOpen::Features::VehicleDesign::WheelCovering feature builder for wheel covering surface section checking. More...

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

Public Types

enum  PositionType { PositionTypeFront, PositionTypeRear, PositionTypeBoth }
 Represents the wheel covering positions. More...
 
enum  RequirementsControlType { RequirementsControlTypeStandardDriven, RequirementsControlTypeUserDefined }
 Represents the requirements control types to define the wheel covering. More...
 
enum  SurfacePlaneType { SurfacePlaneTypeWheelPlane, SurfacePlaneTypePerpendiculartoLoading }
 Represents the type of the surface plane. More...
 
enum  SurfaceSectionType { SurfaceSectionTypeCircleSection, SurfaceSectionTypeAdr42, SurfaceSectionTypeExtrudeSection }
 Represents the type of the surface section. More...
 

Public Member Functions

bool DisplayIntersectionCurves ()
 Returns the display of the intersection curves. More...
 
NXOpen::ExpressionFrontBottomOffset ()
 Returns the bottom offset of the front surface section when the front surface section type is NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfaceSectionTypeAdr42 . More...
 
NXOpen::ExpressionFrontClearance ()
 Returns the clearance of the front surface section. More...
 
NXOpen::ExpressionFrontFrontAngle ()
 Returns the front angle of the front surface section. More...
 
NXOpen::ExpressionFrontFrontOffset ()
 Returns the front offset of the front surface section when the front surface section type is NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfaceSectionTypeAdr42 . More...
 
NXOpen::ExpressionFrontHeight ()
 Returns the height of the front surface section when front the surface section type is NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfaceSectionTypeAdr42 . More...
 
NXOpen::ScCollectorFrontHubcapSelection ()
 Returns the front hub cap selection. More...
 
NXOpen::ScCollectorFrontObjectSelection ()
 Returns the front object selection. More...
 
NXOpen::ExpressionFrontRadius ()
 Returns the radius of the front surface section when the front surface section type is NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfaceSectionTypeCircleSection . More...
 
NXOpen::ExpressionFrontRearAngle ()
 Returns the rear angle of the front surface section. More...
 
NXOpen::ExpressionFrontRearOffset ()
 Returns the rear offset of the front surface section when the front surface section type is NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfaceSectionTypeAdr42 . More...
 
NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfacePlaneType FrontSurfacePlane ()
 Returns the surface plane type of the front surface section. More...
 
NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfaceSectionType FrontSurfaceSection ()
 Returns the surface section type of the front surface section. More...
 
NXString Loading ()
 Returns the loading used in the wheel covering. More...
 
NXOpen::Features::VehicleDesign::WheelCoveringBuilder::PositionType Position ()
 Returns the wheel covering position. More...
 
NXOpen::ExpressionRearBottomOffset ()
 Returns the bottom offset of the rear surface section when the rear surface section type is NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfaceSectionTypeAdr42 . More...
 
NXOpen::ExpressionRearClearance ()
 Returns the clearance of the rear surface section. More...
 
NXOpen::ExpressionRearDisToWheelCenter ()
 Returns the distance to the wheel center when rear surface section type is NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfaceSectionTypeCircleSection . More...
 
NXOpen::ExpressionRearFrontAngle ()
 Returns the front angle of the rear surface section. More...
 
NXOpen::ExpressionRearFrontOffset ()
 Returns the front offset of the rear surface section when the rear surface section type is NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfaceSectionTypeAdr42 . More...
 
NXOpen::ExpressionRearHeight ()
 Returns the height of the rear surface section when the rear surface section type is NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfaceSectionTypeAdr42 . More...
 
NXOpen::ScCollectorRearHubcapSelection ()
 Returns the rear hub cap selection. More...
 
NXOpen::ScCollectorRearObjectSelection ()
 Returns the rear object selection. More...
 
NXOpen::ExpressionRearRadius ()
 Returns the radius of the rear surface section when the rear surface section type is NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfaceSectionTypeCircleSection . More...
 
NXOpen::ExpressionRearRearAngle ()
 Returns the rear angle of the rear surface section. More...
 
NXOpen::ExpressionRearRearOffset ()
 Returns the rear offset of the rear surface section when the rear surface section type is NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfaceSectionTypeAdr42 . More...
 
NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfacePlaneType RearSurfacePlane ()
 Returns the surface plane type of the rear surface section. More...
 
NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfaceSectionType RearSurfaceSection ()
 Returns the surface section type of the rear surface section. More...
 
NXOpen::Features::VehicleDesign::WheelCoveringBuilder::RequirementsControlType RequirementsControl ()
 Returns the requirements control for standard driven or user defined. More...
 
void SetDisplayIntersectionCurves (bool displayIntersectionCurves)
 Sets the display of the intersection curves. More...
 
void SetFrontSurfacePlane (NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfacePlaneType frontSurfacePlane)
 Sets the surface plane type of the front surface section. More...
 
void SetFrontSurfaceSection (NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfaceSectionType frontSurfaceSection)
 Sets the surface section type of the front surface section. More...
 
void SetLoading (const NXString &loading)
 Sets the loading used in the wheel covering. More...
 
void SetLoading (const char *loading)
 Sets the loading used in the wheel covering. More...
 
void SetPosition (NXOpen::Features::VehicleDesign::WheelCoveringBuilder::PositionType position)
 Sets the wheel covering position. More...
 
void SetRearSurfacePlane (NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfacePlaneType rearSurfacePlane)
 Sets the surface plane type of the rear surface section. More...
 
void SetRearSurfaceSection (NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfaceSectionType rearSurfaceSection)
 Sets the surface section type of the rear surface section. More...
 
void SetRequirementsControl (NXOpen::Features::VehicleDesign::WheelCoveringBuilder::RequirementsControlType requirement)
 Sets the requirements control for standard driven or user defined. More...
 
void SetStandard (const NXString &standard)
 Sets the standard used to define the wheel covering. More...
 
void SetStandard (const char *standard)
 Sets the standard used to define the wheel covering. More...
 
NXString Standard ()
 Returns the standard used to define the wheel covering. 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::WheelCovering feature builder for wheel covering surface section checking.


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

Created in NX8.5.0.

Member Enumeration Documentation

Represents the wheel covering positions.

Enumerator
PositionTypeFront 

Creates checking surface for front wheel only.

PositionTypeRear 

Creates checking surface for rear wheel only.

PositionTypeBoth 

Creates checking surface for both front and rear wheels.

Represents the requirements control types to define the wheel covering.

Enumerator
RequirementsControlTypeStandardDriven 

Represents the option for reading parameters from the config file.

RequirementsControlTypeUserDefined 

Represents the option for input of user defined parameters.

Represents the type of the surface plane.

Enumerator
SurfacePlaneTypeWheelPlane 

The checking surface is coplanar to the ourside of the wheels.

SurfacePlaneTypePerpendiculartoLoading 

The checking surface is perpendicular to the active loading plane.

Represents the type of the surface section.

Enumerator
SurfaceSectionTypeCircleSection 

The checking surface is created as circle section type.

SurfaceSectionTypeAdr42 

The checking surface is created as ADR 42 type.

SurfaceSectionTypeExtrudeSection 

The checking surface is created as extrude section type.

Member Function Documentation

bool NXOpen::Features::VehicleDesign::WheelCoveringBuilder::DisplayIntersectionCurves ( )

Returns the display of the intersection curves.


Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::WheelCoveringBuilder::FrontBottomOffset ( )

Returns the bottom offset of the front surface section when the front surface section type is NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfaceSectionTypeAdr42 .


Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::WheelCoveringBuilder::FrontClearance ( )

Returns the clearance of the front surface section.


Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::WheelCoveringBuilder::FrontFrontAngle ( )

Returns the front angle of the front surface section.


Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::WheelCoveringBuilder::FrontFrontOffset ( )

Returns the front offset of the front surface section when the front surface section type is NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfaceSectionTypeAdr42 .


Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::WheelCoveringBuilder::FrontHeight ( )

Returns the height of the front surface section when front the surface section type is NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfaceSectionTypeAdr42 .


Created in NX8.5.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Features::VehicleDesign::WheelCoveringBuilder::FrontHubcapSelection ( )

Returns the front hub cap selection.

The collector contains the hub cap faces used to create the front surface section shape.
Created in NX8.5.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Features::VehicleDesign::WheelCoveringBuilder::FrontObjectSelection ( )

Returns the front object selection.

The collector contains the faces used to create the front intersection curves with the front surface section shape.
Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::WheelCoveringBuilder::FrontRadius ( )

Returns the radius of the front surface section when the front surface section type is NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfaceSectionTypeCircleSection .


Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::WheelCoveringBuilder::FrontRearAngle ( )

Returns the rear angle of the front surface section.


Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::WheelCoveringBuilder::FrontRearOffset ( )

Returns the rear offset of the front surface section when the front surface section type is NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfaceSectionTypeAdr42 .


Created in NX8.5.0.

License requirements : None

NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfacePlaneType NXOpen::Features::VehicleDesign::WheelCoveringBuilder::FrontSurfacePlane ( )

Returns the surface plane type of the front surface section.


Created in NX8.5.0.

License requirements : None

NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfaceSectionType NXOpen::Features::VehicleDesign::WheelCoveringBuilder::FrontSurfaceSection ( )

Returns the surface section type of the front surface section.


Created in NX8.5.0.

License requirements : None

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

Returns the loading used in the wheel covering.


Created in NX8.5.0.

License requirements : None

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

Returns the wheel covering position.


Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::WheelCoveringBuilder::RearBottomOffset ( )

Returns the bottom offset of the rear surface section when the rear surface section type is NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfaceSectionTypeAdr42 .


Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::WheelCoveringBuilder::RearClearance ( )

Returns the clearance of the rear surface section.


Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::WheelCoveringBuilder::RearDisToWheelCenter ( )

Returns the distance to the wheel center when rear surface section type is NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfaceSectionTypeCircleSection .


Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::WheelCoveringBuilder::RearFrontAngle ( )

Returns the front angle of the rear surface section.


Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::WheelCoveringBuilder::RearFrontOffset ( )

Returns the front offset of the rear surface section when the rear surface section type is NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfaceSectionTypeAdr42 .


Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::WheelCoveringBuilder::RearHeight ( )

Returns the height of the rear surface section when the rear surface section type is NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfaceSectionTypeAdr42 .


Created in NX8.5.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Features::VehicleDesign::WheelCoveringBuilder::RearHubcapSelection ( )

Returns the rear hub cap selection.

The collector contains the hub cap faces used to create the rear surface section shape.
Created in NX8.5.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Features::VehicleDesign::WheelCoveringBuilder::RearObjectSelection ( )

Returns the rear object selection.

The collector contains the faces used to create the rear intersection curves with the rear surface section shape.
Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::WheelCoveringBuilder::RearRadius ( )

Returns the radius of the rear surface section when the rear surface section type is NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfaceSectionTypeCircleSection .


Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::WheelCoveringBuilder::RearRearAngle ( )

Returns the rear angle of the rear surface section.


Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::WheelCoveringBuilder::RearRearOffset ( )

Returns the rear offset of the rear surface section when the rear surface section type is NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfaceSectionTypeAdr42 .


Created in NX8.5.0.

License requirements : None

NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfacePlaneType NXOpen::Features::VehicleDesign::WheelCoveringBuilder::RearSurfacePlane ( )

Returns the surface plane type of the rear surface section.


Created in NX8.5.0.

License requirements : None

NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfaceSectionType NXOpen::Features::VehicleDesign::WheelCoveringBuilder::RearSurfaceSection ( )

Returns the surface section type of the rear surface section.


Created in NX8.5.0.

License requirements : None

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

Returns the requirements control for standard driven or user defined.


Created in NX8.5.0.

License requirements : None

void NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SetDisplayIntersectionCurves ( bool  displayIntersectionCurves)

Sets the display of the intersection curves.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
displayIntersectionCurvesdisplayintersectioncurves
void NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SetFrontSurfacePlane ( NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfacePlaneType  frontSurfacePlane)

Sets the surface plane type of the front surface section.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
frontSurfacePlanefrontsurfaceplane
void NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SetFrontSurfaceSection ( NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfaceSectionType  frontSurfaceSection)

Sets the surface section type of the front surface section.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
frontSurfaceSectionfrontsurfacesection
void NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SetLoading ( const NXString loading)

Sets the loading used in the wheel covering.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

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

Sets the loading used in the wheel covering.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
loadingloading
void NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SetPosition ( NXOpen::Features::VehicleDesign::WheelCoveringBuilder::PositionType  position)

Sets the wheel covering position.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
positionposition
void NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SetRearSurfacePlane ( NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfacePlaneType  rearSurfacePlane)

Sets the surface plane type of the rear surface section.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
rearSurfacePlanerearsurfaceplane
void NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SetRearSurfaceSection ( NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SurfaceSectionType  rearSurfaceSection)

Sets the surface section type of the rear surface section.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
rearSurfaceSectionrearsurfacesection
void NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SetRequirementsControl ( NXOpen::Features::VehicleDesign::WheelCoveringBuilder::RequirementsControlType  requirement)

Sets the requirements control for standard driven or user defined.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
requirementrequirement
void NXOpen::Features::VehicleDesign::WheelCoveringBuilder::SetStandard ( const NXString standard)

Sets the standard used to define the wheel covering.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

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

Sets the standard used to define the wheel covering.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
standardstandard
NXString NXOpen::Features::VehicleDesign::WheelCoveringBuilder::Standard ( )

Returns the standard used to define the wheel covering.


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.