SlopeBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# SlopeBuilder Class

class `NXOpen.Features.VehicleDesign.``SlopeBuilder`

  Bases: `NXOpen.Builder`

  The builder to create slope feature.

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

  Default values.

  Property | Value
  --- | ---
  Position | Front
  RequirementsControl | StandardDriven
  Visualization | Surface

  New in version NX8.5.0.

# Properties

Property | Description
--- | ---
FrontAngle | Returns the expression containing the front angle.
FrontLoading | Returns or sets the loading applied to the vehicle front used in the slope.
FrontObjects | Returns the selected front faces for slope measurement.
Position | Returns or sets the slope position.
RearAngle | Returns the expression containing the rear angle.
RearLoading | Returns or sets the loading applied to the vehicle rear used in the slope.
RearObjects | Returns the selected rear faces for slope measurement.
RequirementsControl | Returns or sets the requirements control for standard or user defined.
ShowDistanceMeasurement | Returns or sets the value to show distance measurement.
Standard | Returns or sets the standard used to define the slope.
Tag | Returns the Tag for this object.
Visualization | Returns or sets the visualization type of the slope output.
WheelSize | Returns or sets the wheel size used in the slope.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
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.
GetObject | Returns the object currently being edited by this builder.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

SlopeBuilderPositionType Enumeration | Represents the slope positions.
SlopeBuilderRequirementsControlType Enumeration | Represents the requirements control types to define the slope.
SlopeBuilderVisualizationType Enumeration | Represents the visualization types of the output.
SlopeBuilderWheelSizeType Enumeration | Represents the wheel size types to calculate slope output.

# Property Detail

## FrontAngle

`SlopeBuilder.``FrontAngle`

  Returns the expression containing the front angle.

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

  Getter Method

  Signature `FrontAngle`

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

  New in version NX8.5.0.

  License requirements: None.

## FrontLoading

`SlopeBuilder.``FrontLoading`

  Returns or sets the loading applied to the vehicle front used in the slope.

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

  Getter Method

  Signature `FrontLoading`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `FrontLoading`

  Parameters: | frontLoading (str) –

  New in version NX8.5.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## FrontObjects

`SlopeBuilder.``FrontObjects`

  Returns the selected front faces for slope measurement.

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

  Getter Method

  Signature `FrontObjects`

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

  New in version NX8.5.0.

  License requirements: None.

## Position

`SlopeBuilder.``Position`

  Returns or sets the slope position.

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

  Getter Method

  Signature `Position`

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

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `Position`

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

  New in version NX8.5.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## RearAngle

`SlopeBuilder.``RearAngle`

  Returns the expression containing the rear angle.

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

  Getter Method

  Signature `RearAngle`

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

  New in version NX8.5.0.

  License requirements: None.

## RearLoading

`SlopeBuilder.``RearLoading`

  Returns or sets the loading applied to the vehicle rear used in the slope.

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

  Getter Method

  Signature `RearLoading`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `RearLoading`

  Parameters: | rearLoading (str) –

  New in version NX8.5.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## RearObjects

`SlopeBuilder.``RearObjects`

  Returns the selected rear faces for slope measurement.

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

  Getter Method

  Signature `RearObjects`

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

  New in version NX8.5.0.

  License requirements: None.

## RequirementsControl

`SlopeBuilder.``RequirementsControl`

  Returns or sets the requirements control for standard or user defined.

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

  Getter Method

  Signature `RequirementsControl`

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

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `RequirementsControl`

  Parameters: | requirement (`NXOpen.Features.VehicleDesign.SlopeBuilderRequirementsControlType`) –

  New in version NX8.5.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## ShowDistanceMeasurement

`SlopeBuilder.``ShowDistanceMeasurement`

  Returns or sets the value to show distance measurement.

  True will show the distance measurement. False will hide the distance measurement.

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

  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

`SlopeBuilder.``Standard`

  Returns or sets the standard used to define the slope.

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

  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”)

## Visualization

`SlopeBuilder.``Visualization`

  Returns or sets the visualization type of the slope output.

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

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

  Getter Method

  Signature `Visualization`

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

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `Visualization`

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

  New in version NX8.5.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## WheelSize

`SlopeBuilder.``WheelSize`

  Returns or sets the wheel size used in the slope.

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

  Getter Method

  Signature `WheelSize`

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

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `WheelSize`

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

  New in version NX8.5.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

# Method Detail

## Validate

`SlopeBuilder.``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.