GroundClearanceBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# GroundClearanceBuilder Class

class `NXOpen.Features.VehicleDesign.``GroundClearanceBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a `NXOpen.Features.VehicleDesign.GroundClearance` builder.

  To create a new instance of this class, use `NXOpen.Features.VehicleDesignCollection.CreateGroundClearanceBuilder()`

  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

  New in version NX8.5.0.

# Properties

Property | Description
--- | ---
DistanceToRoadGeneral | Returns the expression that contains the value which indicates the distance from general surface to road general.
DistanceToRoadUnderAxle | Returns the expression that contains the value which indicates the distance from the under axle surface to road.
ExtendSurface | Returns or sets the indication if use surface extension.
ExtensionFactor | Returns the expression that contains the value which indicates the extension factor.
FrontUnderAxleFace | Returns the faces representing the car body geometry for measuring distance to the front under axle surface.
GeneralClearanceFace | Returns the faces representing the car body geometry for measuring distance to the general surface.
Loading | Returns or sets the loading to be applied.
ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal
PatchSolutionFlag | Returns or sets the patch solution flag
PatchSurfaceFilename | Returns or sets the patch surface filename
Position | Returns or sets the position of the under axle surface.
RearUnderAxleFace | Returns the faces representing the car body geometry for measuring distance to the rear under axle surface.
RequirementsControl | Returns or sets the value to determine what type of requirement is controlling the ground clearance values.
SectionCurve | Returns or sets the section curve type of the under axle surface.
ShowDistanceMeasurement | Returns or sets the value indicating if the distance measurement should be displayed.
Standard | Returns or sets the standard to be used for this ground clearance feature.
SurfaceLength | Returns or sets the surface length type which determines the length of the general surface.
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
UseGeneralSurface | Returns or sets the indication if the general surface will be created.
UseUnderAxleSurface | Returns or sets the indication if the under axle surface will be created.
Visualization | Returns or sets the visualization type of the ground clearance output.
WheelSize | Returns or sets the wheel size definition.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CommitFeature | Commits the feature parameters and creates the feature
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetFeature | Returns the feature currently being edited by this builder.
GetObject | Returns the object currently being edited by this builder.
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited.
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited
ShowInternalParentFeatureForEdit | Unsuppress an internal parent feature (a slave feature) so it can be edited.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UnsetParentFeatureInternal | Set the internal parent feature of the feature being edited to external
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

GroundClearanceBuilderPositionType Enumeration | Represents the ground clearance positions.
GroundClearanceBuilderRequirementControls Enumeration | This enum represents the standard or user defined requirement options for ground clearance.
GroundClearanceBuilderSectionCurveType Enumeration | Represents the type of under axle section curve type to create ground clearace.
GroundClearanceBuilderSurfaceLengthType Enumeration | Represents the type of general surface length to create ground clearace.
GroundClearanceBuilderVisualizationTypes Enumeration | This enum represents the output definition options.
GroundClearanceBuilderWheelType Enumeration | Represents the type of the wheel size option for ground clearance.

# Property Detail

## DistanceToRoadGeneral

`GroundClearanceBuilder.``DistanceToRoadGeneral`

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

  `-------------------------------------`

  Getter Method

  Signature `DistanceToRoadGeneral`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX8.5.0.

  License requirements: None.

## DistanceToRoadUnderAxle

`GroundClearanceBuilder.``DistanceToRoadUnderAxle`

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

  `-------------------------------------`

  Getter Method

  Signature `DistanceToRoadUnderAxle`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX8.5.0.

  License requirements: None.

## ExtendSurface

`GroundClearanceBuilder.``ExtendSurface`

  Returns or sets the indication if use surface extension.

  `-------------------------------------`

  Getter Method

  Signature `ExtendSurface`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ExtendSurface`

  Parameters: | extendSurface (bool) –

  New in version NX8.5.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## ExtensionFactor

`GroundClearanceBuilder.``ExtensionFactor`

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

  `-------------------------------------`

  Getter Method

  Signature `ExtensionFactor`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX8.5.0.

  License requirements: None.

## FrontUnderAxleFace

`GroundClearanceBuilder.``FrontUnderAxleFace`

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

  `-------------------------------------`

  Getter Method

  Signature `FrontUnderAxleFace`

  Returns: |
  Return type: | `NXOpen.ScCollector`

  New in version NX8.5.0.

  License requirements: None.

## GeneralClearanceFace

`GroundClearanceBuilder.``GeneralClearanceFace`

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

  `-------------------------------------`

  Getter Method

  Signature `GeneralClearanceFace`

  Returns: |
  Return type: | `NXOpen.ScCollector`

  New in version NX8.5.0.

  License requirements: None.

## Loading

`GroundClearanceBuilder.``Loading`

  Returns or sets the loading to be applied.

  Can only be modified when requirements control is `NXOpen.Features.VehicleDesign.GroundClearanceBuilderRequirementControls.UserDefined`.

  `-------------------------------------`

  Getter Method

  Signature `Loading`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Loading`

  Parameters: | loading (str) –

  New in version NX8.5.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## Position

`GroundClearanceBuilder.``Position`

  Returns or sets the position of the under axle surface.

  `-------------------------------------`

  Getter Method

  Signature `Position`

  Returns: |
  Return type: | `NXOpen.Features.VehicleDesign.GroundClearanceBuilderPositionType`

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Position`

  Parameters: | position (`NXOpen.Features.VehicleDesign.GroundClearanceBuilderPositionType`) –

  New in version NX8.5.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## RearUnderAxleFace

`GroundClearanceBuilder.``RearUnderAxleFace`

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

  `-------------------------------------`

  Getter Method

  Signature `RearUnderAxleFace`

  Returns: |
  Return type: | `NXOpen.ScCollector`

  New in version NX8.5.0.

  License requirements: None.

## RequirementsControl

`GroundClearanceBuilder.``RequirementsControl`

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

  `-------------------------------------`

  Getter Method

  Signature `RequirementsControl`

  Returns: |
  Return type: | `NXOpen.Features.VehicleDesign.GroundClearanceBuilderRequirementControls`

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `RequirementsControl`

  Parameters: | requirementsControl (`NXOpen.Features.VehicleDesign.GroundClearanceBuilderRequirementControls`) –

  New in version NX8.5.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## SectionCurve

`GroundClearanceBuilder.``SectionCurve`

  Returns or sets the section curve type of the under axle surface.

  See `NXOpen.Features.VehicleDesign.GroundClearanceBuilderSectionCurveType` for valid values.

  `-------------------------------------`

  Getter Method

  Signature `SectionCurve`

  Returns: |
  Return type: | `NXOpen.Features.VehicleDesign.GroundClearanceBuilderSectionCurveType`

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `SectionCurve`

  Parameters: | sectionCurveType (`NXOpen.Features.VehicleDesign.GroundClearanceBuilderSectionCurveType`) –

  New in version NX8.5.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## ShowDistanceMeasurement

`GroundClearanceBuilder.``ShowDistanceMeasurement`

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

  `-------------------------------------`

  Getter Method

  Signature `ShowDistanceMeasurement`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ShowDistanceMeasurement`

  Parameters: | showDistanceMeasurement (bool) –

  New in version NX8.5.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## Standard

`GroundClearanceBuilder.``Standard`

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

  Only valid when requirements control is `NXOpen.Features.VehicleDesign.GroundClearanceBuilderRequirementControls.StandardDriven`.

  `-------------------------------------`

  Getter Method

  Signature `Standard`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Standard`

  Parameters: | standard (str) –

  New in version NX8.5.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## SurfaceLength

`GroundClearanceBuilder.``SurfaceLength`

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

  See `NXOpen.Features.VehicleDesign.GroundClearanceBuilderSurfaceLengthType` for valid values.

  `-------------------------------------`

  Getter Method

  Signature `SurfaceLength`

  Returns: |
  Return type: | `NXOpen.Features.VehicleDesign.GroundClearanceBuilderSurfaceLengthType`

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `SurfaceLength`

  Parameters: | surfaceLength (`NXOpen.Features.VehicleDesign.GroundClearanceBuilderSurfaceLengthType`) –

  New in version NX8.5.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## UseGeneralSurface

`GroundClearanceBuilder.``UseGeneralSurface`

  Returns or sets the indication if the general surface will be created.

  `-------------------------------------`

  Getter Method

  Signature `UseGeneralSurface`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `UseGeneralSurface`

  Parameters: | useGeneralSurface (bool) –

  New in version NX8.5.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## UseUnderAxleSurface

`GroundClearanceBuilder.``UseUnderAxleSurface`

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

  `-------------------------------------`

  Getter Method

  Signature `UseUnderAxleSurface`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `UseUnderAxleSurface`

  Parameters: | useUnderAxleSurface (bool) –

  New in version NX8.5.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## Visualization

`GroundClearanceBuilder.``Visualization`

  Returns or sets the visualization type of the ground clearance output.

  `-------------------------------------`

  Getter Method

  Signature `Visualization`

  Returns: |
  Return type: | `NXOpen.Features.VehicleDesign.GroundClearanceBuilderVisualizationTypes`

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Visualization`

  Parameters: | visualization (`NXOpen.Features.VehicleDesign.GroundClearanceBuilderVisualizationTypes`) –

  New in version NX8.5.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## WheelSize

`GroundClearanceBuilder.``WheelSize`

  Returns or sets the wheel size definition.

  Can only be modified when requirements control is `NXOpen.Features.VehicleDesign.GroundClearanceBuilderRequirementControls.UserDefined`.

  `-------------------------------------`

  Getter Method

  Signature `WheelSize`

  Returns: |
  Return type: | `NXOpen.Features.VehicleDesign.GroundClearanceBuilderWheelType`

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `WheelSize`

  Parameters: | wheelSize (`NXOpen.Features.VehicleDesign.GroundClearanceBuilderWheelType`) –

  New in version NX8.5.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

# Method Detail

## Validate

`GroundClearanceBuilder.``Validate`

  Validate whether the inputs to the component are sufficient for commit to be called.

  If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

  Signature `Validate()`

  Returns: | Was self validation successful
  Return type: | bool

  New in version NX3.0.1.

  License requirements: None.