nxopen.features.vehicledesign

Interface GroundClearanceBuilder

All Superinterfaces:

Builder, FeatureBuilder, IComponentBuilder, Remote, TaggedObject

public interface GroundClearanceBuilder
extends FeatureBuilder

Represents a GroundClearance builder.
To create a new instance of this class, use VehicleDesignCollection.createGroundClearanceBuilder(nxopen.features.vehicledesign.GroundClearance)
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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	GroundClearanceBuilder.PositionType Represents the ground clearance positions.
static class	GroundClearanceBuilder.RequirementControls This enum represents the standard or user defined requirement options for ground clearance.
static class	GroundClearanceBuilder.SectionCurveType Represents the type of under axle section curve type to create ground clearace.
static class	GroundClearanceBuilder.SurfaceLengthType Represents the type of general surface length to create ground clearace.
static class	GroundClearanceBuilder.VisualizationTypes This enum represents the output definition options.
static class	GroundClearanceBuilder.WheelType Represents the type of the wheel size option for ground clearance.

Method Summary

Modifier and Type	Method and Description
Expression	distanceToRoadGeneral() Returns the expression that contains the value which indicates the distance from general surface to road general.
Expression	distanceToRoadUnderAxle() Returns the expression that contains the value which indicates the distance from the under axle surface to road.
boolean	extendSurface() Returns the indication if use surface extension.
Expression	extensionFactor() Returns the expression that contains the value which indicates the extension factor.
ScCollector	frontUnderAxleFace() Returns the faces representing the car body geometry for measuring distance to the front under axle surface.
ScCollector	generalClearanceFace() Returns the faces representing the car body geometry for measuring distance to the general surface.
String	loading() Returns the loading to be applied.
GroundClearanceBuilder.PositionType	position() Returns the position of the under axle surface.
ScCollector	rearUnderAxleFace() Returns the faces representing the car body geometry for measuring distance to the rear under axle surface.
GroundClearanceBuilder.RequirementControls	requirementsControl() Returns the value to determine what type of requirement is controlling the ground clearance values.
GroundClearanceBuilder.SectionCurveType	sectionCurve() Returns the section curve type of the under axle surface.
void	setExtendSurface(boolean extendSurface) License requirements: nx_general_packaging ("NX General Packaging") .
void	setLoading(String loading) License requirements: nx_general_packaging ("NX General Packaging") .
void	setPosition(GroundClearanceBuilder.PositionType position) License requirements: nx_general_packaging ("NX General Packaging") .
void	setRequirementsControl(GroundClearanceBuilder.RequirementControls requirementsControl) License requirements: nx_general_packaging ("NX General Packaging") .
void	setSectionCurve(GroundClearanceBuilder.SectionCurveType sectionCurveType) License requirements: nx_general_packaging ("NX General Packaging") .
void	setShowDistanceMeasurement(boolean showDistanceMeasurement) License requirements: nx_general_packaging ("NX General Packaging") .
void	setStandard(String standard) License requirements: nx_general_packaging ("NX General Packaging") .
void	setSurfaceLength(GroundClearanceBuilder.SurfaceLengthType surfaceLength) License requirements: nx_general_packaging ("NX General Packaging") .
void	setUseGeneralSurface(boolean useGeneralSurface) License requirements: nx_general_packaging ("NX General Packaging") .
void	setUseUnderAxleSurface(boolean useUnderAxleSurface) License requirements: nx_general_packaging ("NX General Packaging") .
void	setVisualization(GroundClearanceBuilder.VisualizationTypes visualization) License requirements: nx_general_packaging ("NX General Packaging") .
void	setWheelSize(GroundClearanceBuilder.WheelType wheelSize) License requirements: nx_general_packaging ("NX General Packaging") .
boolean	showDistanceMeasurement() Returns the value indicating if the distance measurement should be displayed.
String	standard() Returns the standard to be used for this ground clearance feature.
GroundClearanceBuilder.SurfaceLengthType	surfaceLength() Returns the surface length type which determines the length of the general surface.
boolean	useGeneralSurface() Returns the indication if the general surface will be created.
boolean	useUnderAxleSurface() Returns the indication if the under axle surface will be created.
GroundClearanceBuilder.VisualizationTypes	visualization() Returns the visualization type of the ground clearance output.
GroundClearanceBuilder.WheelType	wheelSize() Returns the wheel size definition.

Methods inherited from interface nxopen.features.FeatureBuilder

commitFeature, getFeature, hideInternalParentFeatureAfterEdit, parentFeatureInternal, patchSolutionFlag, patchSurfaceFilename, setParentFeatureInternal, setParentFeatureInternal, setPatchSolutionFlag, setPatchSurfaceFilename, setSurroundingPatchSurfaceFilename, showInternalParentFeatureForEdit, surroundingPatchSurfaceFilename, unsetParentFeatureInternal

Methods inherited from interface nxopen.Builder

commit, destroy, getCommittedObjects, getObject, showResults

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Methods inherited from interface nxopen.geometricutilities.IComponentBuilder

validate

Method Detail

requirementsControl

GroundClearanceBuilder.RequirementControls requirementsControl()
                                                        throws NXException,
                                                               RemoteException

Returns the value to determine what type of requirement is controlling the ground clearance values.
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setRequirementsControl

void setRequirementsControl(GroundClearanceBuilder.RequirementControls requirementsControl)
                     throws NXException,
                            RemoteException

License requirements: nx_general_packaging ("NX General Packaging")
.
Created in NX8.5.0

Parameters:

requirementsControl -

Throws:

NXException

RemoteException

standard

String standard()
         throws NXException,
                RemoteException

Returns the standard to be used for this ground clearance feature. Only valid when requirements control is nxopen.features.VehicleDesign.GroundClearanceBuilder.RequirementControls#STANDARD_DRIVEN .
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setStandard

void setStandard(String standard)
          throws NXException,
                 RemoteException

License requirements: nx_general_packaging ("NX General Packaging")
.
Created in NX8.5.0

Parameters:

standard -

Throws:

NXException

RemoteException

loading

String loading()
        throws NXException,
               RemoteException

Returns the loading to be applied. Can only be modified when requirements control is nxopen.features.VehicleDesign.GroundClearanceBuilder.RequirementControls#USER_DEFINED .
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setLoading

void setLoading(String loading)
         throws NXException,
                RemoteException

License requirements: nx_general_packaging ("NX General Packaging")
.
Created in NX8.5.0

Parameters:

loading -

Throws:

NXException

RemoteException

wheelSize

GroundClearanceBuilder.WheelType wheelSize()
                                    throws NXException,
                                           RemoteException

Returns the wheel size definition. Can only be modified when requirements control is nxopen.features.VehicleDesign.GroundClearanceBuilder.RequirementControls#USER_DEFINED .
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setWheelSize

void setWheelSize(GroundClearanceBuilder.WheelType wheelSize)
           throws NXException,
                  RemoteException

License requirements: nx_general_packaging ("NX General Packaging")
.
Created in NX8.5.0

Parameters:

wheelSize -

Throws:

NXException

RemoteException

useGeneralSurface

boolean useGeneralSurface()
                   throws NXException,
                          RemoteException

Returns the indication if the general surface will be created.
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setUseGeneralSurface

void setUseGeneralSurface(boolean useGeneralSurface)
                   throws NXException,
                          RemoteException

License requirements: nx_general_packaging ("NX General Packaging")
.
Created in NX8.5.0

Parameters:

useGeneralSurface -

Throws:

NXException

RemoteException

surfaceLength

GroundClearanceBuilder.SurfaceLengthType surfaceLength()
                                                throws NXException,
                                                       RemoteException

Returns the surface length type which determines the length of the general surface. See GroundClearanceBuilder.SurfaceLengthType for valid values.
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setSurfaceLength

void setSurfaceLength(GroundClearanceBuilder.SurfaceLengthType surfaceLength)
               throws NXException,
                      RemoteException

License requirements: nx_general_packaging ("NX General Packaging")
.
Created in NX8.5.0

Parameters:

surfaceLength -

Throws:

NXException

RemoteException

distanceToRoadGeneral

Expression distanceToRoadGeneral()
                          throws NXException,
                                 RemoteException

Returns the expression that contains the value which indicates the distance from general surface to road general.
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

useUnderAxleSurface

boolean useUnderAxleSurface()
                     throws NXException,
                            RemoteException

Returns the indication if the under axle surface will be created.
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setUseUnderAxleSurface

void setUseUnderAxleSurface(boolean useUnderAxleSurface)
                     throws NXException,
                            RemoteException

License requirements: nx_general_packaging ("NX General Packaging")
.
Created in NX8.5.0

Parameters:

useUnderAxleSurface -

Throws:

NXException

RemoteException

position

GroundClearanceBuilder.PositionType position()
                                      throws NXException,
                                             RemoteException

Returns the position of the under axle surface.
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setPosition

void setPosition(GroundClearanceBuilder.PositionType position)
          throws NXException,
                 RemoteException

License requirements: nx_general_packaging ("NX General Packaging")
.
Created in NX8.5.0

Parameters:

position -

Throws:

NXException

RemoteException

sectionCurve

GroundClearanceBuilder.SectionCurveType sectionCurve()
                                              throws NXException,
                                                     RemoteException

Returns the section curve type of the under axle surface. See GroundClearanceBuilder.SectionCurveType for valid values.
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setSectionCurve

void setSectionCurve(GroundClearanceBuilder.SectionCurveType sectionCurveType)
              throws NXException,
                     RemoteException

License requirements: nx_general_packaging ("NX General Packaging")
.
Created in NX8.5.0

Parameters:

sectionCurveType -

Throws:

NXException

RemoteException

distanceToRoadUnderAxle

Expression distanceToRoadUnderAxle()
                            throws NXException,
                                   RemoteException

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

Created in NX8.5.0

Throws:

NXException

RemoteException

extendSurface

boolean extendSurface()
               throws NXException,
                      RemoteException

Returns the indication if use surface extension.
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setExtendSurface

void setExtendSurface(boolean extendSurface)
               throws NXException,
                      RemoteException

License requirements: nx_general_packaging ("NX General Packaging")
.
Created in NX8.5.0

Parameters:

extendSurface -

Throws:

NXException

RemoteException

extensionFactor

Expression extensionFactor()
                    throws NXException,
                           RemoteException

Returns the expression that contains the value which indicates the extension factor.
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

generalClearanceFace

ScCollector generalClearanceFace()
                          throws NXException,
                                 RemoteException

Returns the faces representing the car body geometry for measuring distance to the general surface.
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

frontUnderAxleFace

ScCollector frontUnderAxleFace()
                        throws NXException,
                               RemoteException

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

Created in NX8.5.0

Throws:

NXException

RemoteException

rearUnderAxleFace

ScCollector rearUnderAxleFace()
                       throws NXException,
                              RemoteException

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

Created in NX8.5.0

Throws:

NXException

RemoteException

showDistanceMeasurement

boolean showDistanceMeasurement()
                         throws NXException,
                                RemoteException

Returns the value indicating if the distance measurement should be displayed.
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setShowDistanceMeasurement

void setShowDistanceMeasurement(boolean showDistanceMeasurement)
                         throws NXException,
                                RemoteException

License requirements: nx_general_packaging ("NX General Packaging")
.
Created in NX8.5.0

Parameters:

showDistanceMeasurement -

Throws:

NXException

RemoteException

visualization

GroundClearanceBuilder.VisualizationTypes visualization()
                                                 throws NXException,
                                                        RemoteException

Returns the visualization type of the ground clearance output.
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setVisualization

void setVisualization(GroundClearanceBuilder.VisualizationTypes visualization)
               throws NXException,
                      RemoteException

License requirements: nx_general_packaging ("NX General Packaging")
.
Created in NX8.5.0

Parameters:

visualization -

Throws:

NXException

RemoteException