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

The builder to create slope feature. More...

Inheritance diagram for NXOpen::Features::VehicleDesign::SlopeBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  PositionType { PositionTypeFront, PositionTypeRear, PositionTypeBoth }
 Represents the slope positions. More...
 
enum  RequirementsControlType { RequirementsControlTypeStandardDriven, RequirementsControlTypeUserDefined }
 Represents the requirements control types to define the slope. More...
 
enum  VisualizationType { VisualizationTypeCurve, VisualizationTypeSurface, VisualizationTypeCurveandSurface }
 Represents the visualization types of the output. More...
 
enum  WheelSizeType { WheelSizeTypeStaticRadius, WheelSizeTypeDiameter }
 Represents the wheel size types to calculate slope output. More...
 

Public Member Functions

NXOpen::ExpressionFrontAngle ()
 Returns the expression containing the front angle. More...
 
NXString FrontLoading ()
 Returns the loading applied to the vehicle front used in the slope. More...
 
NXOpen::ScCollectorFrontObjects ()
 Returns the selected front faces for slope measurement. More...
 
NXOpen::Features::VehicleDesign::SlopeBuilder::PositionType Position ()
 Returns the slope position. More...
 
NXOpen::ExpressionRearAngle ()
 Returns the expression containing the rear angle. More...
 
NXString RearLoading ()
 Returns the loading applied to the vehicle rear used in the slope. More...
 
NXOpen::ScCollectorRearObjects ()
 Returns the selected rear faces for slope measurement. More...
 
NXOpen::Features::VehicleDesign::SlopeBuilder::RequirementsControlType RequirementsControl ()
 Returns the requirements control for standard or user defined. More...
 
void SetFrontLoading (const NXString &frontLoading)
 Sets the loading applied to the vehicle front used in the slope. More...
 
void SetFrontLoading (const char *frontLoading)
 Sets the loading applied to the vehicle front used in the slope. More...
 
void SetPosition (NXOpen::Features::VehicleDesign::SlopeBuilder::PositionType position)
 Sets the slope position. More...
 
void SetRearLoading (const NXString &rearLoading)
 Sets the loading applied to the vehicle rear used in the slope. More...
 
void SetRearLoading (const char *rearLoading)
 Sets the loading applied to the vehicle rear used in the slope. More...
 
void SetRequirementsControl (NXOpen::Features::VehicleDesign::SlopeBuilder::RequirementsControlType requirement)
 Sets the requirements control for standard or user defined. More...
 
void SetShowDistanceMeasurement (bool showDistanceMeasurement)
 Sets the value to show distance measurement. More...
 
void SetStandard (const NXString &standard)
 Sets the standard used to define the slope. More...
 
void SetStandard (const char *standard)
 Sets the standard used to define the slope. More...
 
void SetVisualization (NXOpen::Features::VehicleDesign::SlopeBuilder::VisualizationType visualization)
 Sets the visualization type of the slope output. More...
 
void SetWheelSize (NXOpen::Features::VehicleDesign::SlopeBuilder::WheelSizeType wheelSize)
 Sets the wheel size used in the slope. More...
 
bool ShowDistanceMeasurement ()
 Returns the value to show distance measurement. More...
 
NXString Standard ()
 Returns the standard used to define the slope. More...
 
NXOpen::Features::VehicleDesign::SlopeBuilder::VisualizationType Visualization ()
 Returns the visualization type of the slope output. More...
 
NXOpen::Features::VehicleDesign::SlopeBuilder::WheelSizeType WheelSize ()
 Returns the wheel size used in the slope. 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

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


Created in NX8.5.0.

Member Enumeration Documentation

Represents the slope positions.

Enumerator
PositionTypeFront 

front

PositionTypeRear 

rear

PositionTypeBoth 

both

Represents the requirements control types to define the slope.

Enumerator
RequirementsControlTypeStandardDriven 

standard driven

RequirementsControlTypeUserDefined 

user defined

Represents the visualization types of the output.

Enumerator
VisualizationTypeCurve 

curve

VisualizationTypeSurface 

surface

VisualizationTypeCurveandSurface 

curveand surface

Represents the wheel size types to calculate slope output.

Enumerator
WheelSizeTypeStaticRadius 

static radius

WheelSizeTypeDiameter 

diameter

Member Function Documentation

NXOpen::Expression* NXOpen::Features::VehicleDesign::SlopeBuilder::FrontAngle ( )

Returns the expression containing the front angle.


Created in NX8.5.0.

License requirements : None

NXString NXOpen::Features::VehicleDesign::SlopeBuilder::FrontLoading ( )

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


Created in NX8.5.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Features::VehicleDesign::SlopeBuilder::FrontObjects ( )

Returns the selected front faces for slope measurement.


Created in NX8.5.0.

License requirements : None

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

Returns the slope position.


Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::SlopeBuilder::RearAngle ( )

Returns the expression containing the rear angle.


Created in NX8.5.0.

License requirements : None

NXString NXOpen::Features::VehicleDesign::SlopeBuilder::RearLoading ( )

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


Created in NX8.5.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Features::VehicleDesign::SlopeBuilder::RearObjects ( )

Returns the selected rear faces for slope measurement.


Created in NX8.5.0.

License requirements : None

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

Returns the requirements control for standard or user defined.


Created in NX8.5.0.

License requirements : None

void NXOpen::Features::VehicleDesign::SlopeBuilder::SetFrontLoading ( const NXString frontLoading)

Sets the loading applied to the vehicle front used in the slope.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
frontLoadingfrontloading
void NXOpen::Features::VehicleDesign::SlopeBuilder::SetFrontLoading ( const char *  frontLoading)

Sets the loading applied to the vehicle front used in the slope.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
frontLoadingfrontloading
void NXOpen::Features::VehicleDesign::SlopeBuilder::SetPosition ( NXOpen::Features::VehicleDesign::SlopeBuilder::PositionType  position)

Sets the slope position.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
positionposition
void NXOpen::Features::VehicleDesign::SlopeBuilder::SetRearLoading ( const NXString rearLoading)

Sets the loading applied to the vehicle rear used in the slope.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
rearLoadingrearloading
void NXOpen::Features::VehicleDesign::SlopeBuilder::SetRearLoading ( const char *  rearLoading)

Sets the loading applied to the vehicle rear used in the slope.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
rearLoadingrearloading
void NXOpen::Features::VehicleDesign::SlopeBuilder::SetRequirementsControl ( NXOpen::Features::VehicleDesign::SlopeBuilder::RequirementsControlType  requirement)

Sets the requirements control for standard or user defined.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
requirementrequirement
void NXOpen::Features::VehicleDesign::SlopeBuilder::SetShowDistanceMeasurement ( bool  showDistanceMeasurement)

Sets the value to show distance measurement.

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


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
showDistanceMeasurementshowdistancemeasurement
void NXOpen::Features::VehicleDesign::SlopeBuilder::SetStandard ( const NXString standard)

Sets the standard used to define the slope.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

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

Sets the standard used to define the slope.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
standardstandard
void NXOpen::Features::VehicleDesign::SlopeBuilder::SetVisualization ( NXOpen::Features::VehicleDesign::SlopeBuilder::VisualizationType  visualization)

Sets the visualization type of the slope output.

See NXOpen::Features::VehicleDesign::SlopeBuilder::VisualizationType for valid values.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
visualizationvisualization
void NXOpen::Features::VehicleDesign::SlopeBuilder::SetWheelSize ( NXOpen::Features::VehicleDesign::SlopeBuilder::WheelSizeType  wheelSize)

Sets the wheel size used in the slope.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
wheelSizewheelsize
bool NXOpen::Features::VehicleDesign::SlopeBuilder::ShowDistanceMeasurement ( )

Returns the value to show distance measurement.

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


Created in NX8.5.0.

License requirements : None

NXString NXOpen::Features::VehicleDesign::SlopeBuilder::Standard ( )

Returns the standard used to define the slope.


Created in NX8.5.0.

License requirements : None

NXOpen::Features::VehicleDesign::SlopeBuilder::VisualizationType NXOpen::Features::VehicleDesign::SlopeBuilder::Visualization ( )

Returns the visualization type of the slope output.

See NXOpen::Features::VehicleDesign::SlopeBuilder::VisualizationType for valid values.


Created in NX8.5.0.

License requirements : None

NXOpen::Features::VehicleDesign::SlopeBuilder::WheelSizeType NXOpen::Features::VehicleDesign::SlopeBuilder::WheelSize ( )

Returns the wheel size used in the slope.


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.