NXOpen::Features::VehicleDesign::GroundClearanceBuilder Class Reference

Represents a Features::VehicleDesign::GroundClearance builder. More...

Inheritance diagram for NXOpen::Features::VehicleDesign::GroundClearanceBuilder:

Public Types
enum	PositionType { PositionTypeFront, PositionTypeRear, PositionTypeBoth }
	Represents the ground clearance positions. More...
enum	RequirementControls { RequirementControlsStandardDriven, RequirementControlsUserDefined }
	This enum represents the standard or user defined requirement options for ground clearance. More...
enum	SectionCurveType { SectionCurveTypeHorizontalLine, SectionCurveTypeCircularArc }
	Represents the type of under axle section curve type to create ground clearace. More...
enum	SurfaceLengthType { SurfaceLengthTypeFrontToRear, SurfaceLengthTypeFullVehicle }
	Represents the type of general surface length to create ground clearace. More...
enum	VisualizationTypes { VisualizationTypesCurve, VisualizationTypesSurface, VisualizationTypesCurveandSurface }
	This enum represents the output definition options. More...
enum	WheelType { WheelTypeStaticRadius, WheelTypeDiameter }
	Represents the type of the wheel size option for ground clearance. More...

Public Member Functions
NXOpen::Expression *	DistanceToRoadGeneral ()
	Returns the expression that contains the value which indicates the distance from general surface to road general.
NXOpen::Expression *	DistanceToRoadUnderAxle ()
	Returns the expression that contains the value which indicates the distance from the under axle surface to road.
bool	ExtendSurface ()
	Returns the indication if use surface extension.
NXOpen::Expression *	ExtensionFactor ()
	Returns the expression that contains the value which indicates the extension factor.
NXOpen::ScCollector *	FrontUnderAxleFace ()
	Returns the faces representing the car body geometry for measuring distance to the front under axle surface.
NXOpen::ScCollector *	GeneralClearanceFace ()
	Returns the faces representing the car body geometry for measuring distance to the general surface.
NXString	Loading ()
	Returns the loading to be applied.
NXOpen::Features::VehicleDesign::GroundClearanceBuilder::PositionType	Position ()
	Returns the position of the under axle surface.
NXOpen::ScCollector *	RearUnderAxleFace ()
	Returns the faces representing the car body geometry for measuring distance to the rear under axle surface.
NXOpen::Features::VehicleDesign::GroundClearanceBuilder::RequirementControls	RequirementsControl ()
	Returns the value to determine what type of requirement is controlling the ground clearance values.
NXOpen::Features::VehicleDesign::GroundClearanceBuilder::SectionCurveType	SectionCurve ()
	Returns the section curve type of the under axle surface.
void	SetExtendSurface (bool extendSurface)
	Sets the indication if use surface extension.
void	SetLoading (const NXString &loading)
	Sets the loading to be applied.
void	SetLoading (const char *loading)
	Sets the loading to be applied.
void	SetPosition (NXOpen::Features::VehicleDesign::GroundClearanceBuilder::PositionType position)
	Sets the position of the under axle surface.
void	SetRequirementsControl (NXOpen::Features::VehicleDesign::GroundClearanceBuilder::RequirementControls requirementsControl)
	Sets the value to determine what type of requirement is controlling the ground clearance values.
void	SetSectionCurve (NXOpen::Features::VehicleDesign::GroundClearanceBuilder::SectionCurveType sectionCurveType)
	Sets the section curve type of the under axle surface.
void	SetShowDistanceMeasurement (bool showDistanceMeasurement)
	Sets the value indicating if the distance measurement should be displayed.
void	SetStandard (const NXString &standard)
	Sets the standard to be used for this ground clearance feature.
void	SetStandard (const char *standard)
	Sets the standard to be used for this ground clearance feature.
void	SetSurfaceLength (NXOpen::Features::VehicleDesign::GroundClearanceBuilder::SurfaceLengthType surfaceLength)
	Sets the surface length type which determines the length of the general surface.
void	SetUseGeneralSurface (bool useGeneralSurface)
	Sets the indication if the general surface will be created.
void	SetUseUnderAxleSurface (bool useUnderAxleSurface)
	Sets the indication if the under axle surface will be created.
void	SetVisualization (NXOpen::Features::VehicleDesign::GroundClearanceBuilder::VisualizationTypes visualization)
	Sets the visualization type of the ground clearance output.
void	SetWheelSize (NXOpen::Features::VehicleDesign::GroundClearanceBuilder::WheelType wheelSize)
	Sets the wheel size definition.
bool	ShowDistanceMeasurement ()
	Returns the value indicating if the distance measurement should be displayed.
NXString	Standard ()
	Returns the standard to be used for this ground clearance feature.
NXOpen::Features::VehicleDesign::GroundClearanceBuilder::SurfaceLengthType	SurfaceLength ()
	Returns the surface length type which determines the length of the general surface.
bool	UseGeneralSurface ()
	Returns the indication if the general surface will be created.
bool	UseUnderAxleSurface ()
	Returns the indication if the under axle surface will be created.
NXOpen::Features::VehicleDesign::GroundClearanceBuilder::VisualizationTypes	Visualization ()
	Returns the visualization type of the ground clearance output.
NXOpen::Features::VehicleDesign::GroundClearanceBuilder::WheelType	WheelSize ()
	Returns the wheel size definition.
Public Member Functions inherited from NXOpen::Features::FeatureBuilder
NXOpen::Features::Feature *	CommitFeature ()
	Commits the feature parameters and creates the feature.
NXOpen::Features::Feature *	GetFeature ()
	Returns the feature currently being edited by this builder.
void	HideInternalParentFeatureAfterEdit (NXOpen::Features::Feature *parentFeature)
	Re-suppress an internal parent feature (a slave feature) after it has been edited.
bool	ParentFeatureInternal ()
	Returns whether or not the latest timestamped parent feature of this feature should be made internal Created in NX5.0.0.
bool	PatchSolutionFlag ()
	Returns the patch solution flag Created in NX8.0.1.
NXString	PatchSurfaceFilename ()
	Returns the patch surface filename Created in NX8.0.1.
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.
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.
void	SetPatchSolutionFlag (bool optionValue)
	Sets the patch solution flag Created in NX8.0.1.
void	SetPatchSurfaceFilename (const NXString &surfaceFilename)
	Sets the patch surface filename Created in NX8.0.1.
void	SetPatchSurfaceFilename (const char *surfaceFilename)
	Sets the patch surface filename Created in NX8.0.1.
void	SetSurroundingPatchSurfaceFilename (const NXString &surroundingSurfaceFilename)
	Sets the surrounding patch surface filename Created in NX8.0.1.
void	SetSurroundingPatchSurfaceFilename (const char *surroundingSurfaceFilename)
	Sets the surrounding patch surface filename Created in NX8.0.1.
void	ShowInternalParentFeatureForEdit (NXOpen::Features::Feature *parentFeature)
	Unsuppress an internal parent feature (a slave feature) so it can be edited.
NXString	SurroundingPatchSurfaceFilename ()
	Returns the surrounding patch surface filename Created in NX8.0.1.
void	UnsetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
	Set the internal parent feature of the feature being edited to external Created in NX6.0.0.
Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.
void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.
std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.
NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.
void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br>    Use Tag instead.
tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a Features::VehicleDesign::GroundClearance builder.

 <br> To create a new instance of this class, use @link Features::VehicleDesignCollection::CreateGroundClearanceBuilder  Features::VehicleDesignCollection::CreateGroundClearanceBuilder @endlink  <br> 

Default values.

Property	Value
DistanceToRoadGeneral.Value	200 (millimeters part), 7.9 (inches part)
DistanceToRoadUnderAxle.Value	100 (millimeters part), 3.9 (inches part)
ExtendSurface	0
ExtensionFactor.Value	1000
Position	Front
RequirementsControl	StandardDriven
SectionCurve	HorizontalLine
ShowDistanceMeasurement	1
SurfaceLength	FrontToRear
UseGeneralSurface	1
UseUnderAxleSurface	1
Visualization	Surface
WheelSize	StaticRadius

Created in NX8.5.0.

Member Enumeration Documentation

enum NXOpen::Features::VehicleDesign::GroundClearanceBuilder::PositionType

Represents the ground clearance positions.

Enumerator:

PositionTypeFront	front
PositionTypeRear	rear
PositionTypeBoth	both

enum NXOpen::Features::VehicleDesign::GroundClearanceBuilder::RequirementControls

This enum represents the standard or user defined requirement options for ground clearance.

Enumerator:

RequirementControlsStandardDriven	standard driven
RequirementControlsUserDefined	user defined

enum NXOpen::Features::VehicleDesign::GroundClearanceBuilder::SectionCurveType

Represents the type of under axle section curve type to create ground clearace.

Enumerator:

SectionCurveTypeHorizontalLine	horizontal line
SectionCurveTypeCircularArc	circular arc

enum NXOpen::Features::VehicleDesign::GroundClearanceBuilder::SurfaceLengthType

Represents the type of general surface length to create ground clearace.

Enumerator:

SurfaceLengthTypeFrontToRear	front to rear
SurfaceLengthTypeFullVehicle	full vehicle

enum NXOpen::Features::VehicleDesign::GroundClearanceBuilder::VisualizationTypes

This enum represents the output definition options.

Enumerator:

VisualizationTypesCurve	curve
VisualizationTypesSurface	surface
VisualizationTypesCurveandSurface	curveand surface

enum NXOpen::Features::VehicleDesign::GroundClearanceBuilder::WheelType

Represents the type of the wheel size option for ground clearance.

Enumerator:

WheelTypeStaticRadius	static radius
WheelTypeDiameter	diameter

Member Function Documentation

NXOpen::Expression* NXOpen::Features::VehicleDesign::GroundClearanceBuilder::DistanceToRoadGeneral

(

)

Returns the expression that contains the value which indicates the distance from general surface to road general.

Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::GroundClearanceBuilder::DistanceToRoadUnderAxle

(

)

Returns the expression that contains the value which indicates the distance from the under axle surface to road.

Created in NX8.5.0.

License requirements : None

bool NXOpen::Features::VehicleDesign::GroundClearanceBuilder::ExtendSurface

(

)

Returns the indication if use surface extension.

Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::GroundClearanceBuilder::ExtensionFactor

(

)

Returns the expression that contains the value which indicates the extension factor.

Created in NX8.5.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Features::VehicleDesign::GroundClearanceBuilder::FrontUnderAxleFace

(

)

Returns the faces representing the car body geometry for measuring distance to the front under axle surface.

Created in NX8.5.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Features::VehicleDesign::GroundClearanceBuilder::GeneralClearanceFace

(

)

Returns the faces representing the car body geometry for measuring distance to the general surface.

Created in NX8.5.0.

License requirements : None

NXString NXOpen::Features::VehicleDesign::GroundClearanceBuilder::Loading

(

)

Returns the loading to be applied.

Can only be modified when requirements control is Features::VehicleDesign::GroundClearanceBuilder::RequirementControlsUserDefined .
Created in NX8.5.0.

License requirements : None

NXOpen::Features::VehicleDesign::GroundClearanceBuilder::PositionType NXOpen::Features::VehicleDesign::GroundClearanceBuilder::Position

(

)

Returns the position of the under axle surface.

Created in NX8.5.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Features::VehicleDesign::GroundClearanceBuilder::RearUnderAxleFace

(

)

Returns the faces representing the car body geometry for measuring distance to the rear under axle surface.

Created in NX8.5.0.

License requirements : None

NXOpen::Features::VehicleDesign::GroundClearanceBuilder::RequirementControls NXOpen::Features::VehicleDesign::GroundClearanceBuilder::RequirementsControl

(

)

Returns the value to determine what type of requirement is controlling the ground clearance values.

Created in NX8.5.0.

License requirements : None

NXOpen::Features::VehicleDesign::GroundClearanceBuilder::SectionCurveType NXOpen::Features::VehicleDesign::GroundClearanceBuilder::SectionCurve

(

)

Returns the section curve type of the under axle surface.

   See @link Features::VehicleDesign::GroundClearanceBuilder::SectionCurveType Features::VehicleDesign::GroundClearanceBuilder::SectionCurveType@endlink  for valid values.

Created in NX8.5.0.

License requirements : None

void NXOpen::Features::VehicleDesign::GroundClearanceBuilder::SetExtendSurface

(

bool

extendSurface

)

Sets the indication if use surface extension.

Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters

extendSurface

extendsurface

void NXOpen::Features::VehicleDesign::GroundClearanceBuilder::SetLoading

(

const NXString &

loading

)

Sets the loading to be applied.

Can only be modified when requirements control is Features::VehicleDesign::GroundClearanceBuilder::RequirementControlsUserDefined .
Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters

loading

loading

void NXOpen::Features::VehicleDesign::GroundClearanceBuilder::SetLoading

(

const char *

loading

)

Sets the loading to be applied.

Can only be modified when requirements control is Features::VehicleDesign::GroundClearanceBuilder::RequirementControlsUserDefined .
Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters

loading

loading

void NXOpen::Features::VehicleDesign::GroundClearanceBuilder::SetPosition

(

NXOpen::Features::VehicleDesign::GroundClearanceBuilder::PositionType

position

)

Sets the position of the under axle surface.

Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters

position

position

void NXOpen::Features::VehicleDesign::GroundClearanceBuilder::SetRequirementsControl

(

NXOpen::Features::VehicleDesign::GroundClearanceBuilder::RequirementControls

requirementsControl

)

Sets the value to determine what type of requirement is controlling the ground clearance values.

Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters

requirementsControl

requirementscontrol

void NXOpen::Features::VehicleDesign::GroundClearanceBuilder::SetSectionCurve

(

NXOpen::Features::VehicleDesign::GroundClearanceBuilder::SectionCurveType

sectionCurveType

)

Sets the section curve type of the under axle surface.

   See @link Features::VehicleDesign::GroundClearanceBuilder::SectionCurveType Features::VehicleDesign::GroundClearanceBuilder::SectionCurveType@endlink  for valid values.

Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters

sectionCurveType

sectioncurvetype

void NXOpen::Features::VehicleDesign::GroundClearanceBuilder::SetShowDistanceMeasurement

(

bool

showDistanceMeasurement

)

Sets the value indicating if the distance measurement should be displayed.

Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters

showDistanceMeasurement

showdistancemeasurement

void NXOpen::Features::VehicleDesign::GroundClearanceBuilder::SetStandard

(

const NXString &

standard

)

Sets the standard to be used for this ground clearance feature.

Only valid when requirements control is Features::VehicleDesign::GroundClearanceBuilder::RequirementControlsStandardDriven .
Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters

standard

standard

void NXOpen::Features::VehicleDesign::GroundClearanceBuilder::SetStandard

(

const char *

standard

)

Sets the standard to be used for this ground clearance feature.

Only valid when requirements control is Features::VehicleDesign::GroundClearanceBuilder::RequirementControlsStandardDriven .
Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters

standard

standard

void NXOpen::Features::VehicleDesign::GroundClearanceBuilder::SetSurfaceLength

(

NXOpen::Features::VehicleDesign::GroundClearanceBuilder::SurfaceLengthType

surfaceLength

)

Sets the surface length type which determines the length of the general surface.

   See @link Features::VehicleDesign::GroundClearanceBuilder::SurfaceLengthType Features::VehicleDesign::GroundClearanceBuilder::SurfaceLengthType@endlink  for valid values. 

Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters

surfaceLength

surfacelength

void NXOpen::Features::VehicleDesign::GroundClearanceBuilder::SetUseGeneralSurface

(

bool

useGeneralSurface

)

Sets the indication if the general surface will be created.

Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters

useGeneralSurface

usegeneralsurface

void NXOpen::Features::VehicleDesign::GroundClearanceBuilder::SetUseUnderAxleSurface

(

bool

useUnderAxleSurface

)

Sets the indication if the under axle surface will be created.

Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters

useUnderAxleSurface

useunderaxlesurface

void NXOpen::Features::VehicleDesign::GroundClearanceBuilder::SetVisualization

(

NXOpen::Features::VehicleDesign::GroundClearanceBuilder::VisualizationTypes

visualization

)

Sets the visualization type of the ground clearance output.

Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters

visualization

visualization

void NXOpen::Features::VehicleDesign::GroundClearanceBuilder::SetWheelSize

(

NXOpen::Features::VehicleDesign::GroundClearanceBuilder::WheelType

wheelSize

)

Sets the wheel size definition.

Can only be modified when requirements control is Features::VehicleDesign::GroundClearanceBuilder::RequirementControlsUserDefined .
Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters

wheelSize

wheelsize

bool NXOpen::Features::VehicleDesign::GroundClearanceBuilder::ShowDistanceMeasurement

(

)

Returns the value indicating if the distance measurement should be displayed.

Created in NX8.5.0.

License requirements : None

NXString NXOpen::Features::VehicleDesign::GroundClearanceBuilder::Standard

(

)

Returns the standard to be used for this ground clearance feature.

Only valid when requirements control is Features::VehicleDesign::GroundClearanceBuilder::RequirementControlsStandardDriven .
Created in NX8.5.0.

License requirements : None

NXOpen::Features::VehicleDesign::GroundClearanceBuilder::SurfaceLengthType NXOpen::Features::VehicleDesign::GroundClearanceBuilder::SurfaceLength

(

)

Returns the surface length type which determines the length of the general surface.

   See @link Features::VehicleDesign::GroundClearanceBuilder::SurfaceLengthType Features::VehicleDesign::GroundClearanceBuilder::SurfaceLengthType@endlink  for valid values. 

Created in NX8.5.0.

License requirements : None

bool NXOpen::Features::VehicleDesign::GroundClearanceBuilder::UseGeneralSurface

(

)

Returns the indication if the general surface will be created.

Created in NX8.5.0.

License requirements : None

bool NXOpen::Features::VehicleDesign::GroundClearanceBuilder::UseUnderAxleSurface

(

)

Returns the indication if the under axle surface will be created.

Created in NX8.5.0.

License requirements : None

NXOpen::Features::VehicleDesign::GroundClearanceBuilder::VisualizationTypes NXOpen::Features::VehicleDesign::GroundClearanceBuilder::Visualization

(

)

Returns the visualization type of the ground clearance output.

Created in NX8.5.0.

License requirements : None

NXOpen::Features::VehicleDesign::GroundClearanceBuilder::WheelType NXOpen::Features::VehicleDesign::GroundClearanceBuilder::WheelSize

(

)

Returns the wheel size definition.

Can only be modified when requirements control is Features::VehicleDesign::GroundClearanceBuilder::RequirementControlsUserDefined .
Created in NX8.5.0.

License requirements : None

---

The documentation for this class was generated from the following file:

• Features_VehicleDesign_GroundClearanceBuilder.hxx