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

Represents a NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder . More...

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

Public Types

enum  SeatDirectionOptions {
  SeatDirectionOptionsFrontward, SeatDirectionOptionsBackward, SeatDirectionOptionsLeft, SeatDirectionOptionsRight,
  SeatDirectionOptionsCustom
}
 This enum represents the options to define the passenger's seat direction type. More...
 

Public Member Functions

bool Active ()
 Returns the status to indicate whether the passenger is active or not. More...
 
void Assign (NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder *other)
 Assigns values from another passenger. More...
 
NXOpen::ExpressionBackAngleExp ()
 Returns the passenger's back angle. More...
 
NXString Description ()
 Returns the name or short description of the passenger. More...
 
double GetBackAngle ()
 Returns the passenger's back angle. More...
 
double GetHorizontalPointTravel ()
 Returns the passenger's horizontal adjustment in x direction. More...
 
double GetSeatAngle ()
 Returns the passenger's seat angle. More...
 
NXOpen::PointHeelReferencePoint ()
 Returns the passenger's heel reference point. More...
 
bool HeelReferencePointActive ()
 Returns the status to indicate whether the passenger heel reference point is active or not. More...
 
NXOpen::ExpressionHorizontalPointTravelExp ()
 Returns the passenger's horizontal adjustment in x direction. More...
 
NXOpen::ExpressionSeatAngleExp ()
 Returns the passenger's seat angle. More...
 
NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder::SeatDirectionOptions SeatDirection ()
 Returns the direction that this passenger is facing. More...
 
NXOpen::PointSeatReferencePoint ()
 Returns the passenger's seat reference point. More...
 
bool SeatReferencePointActive ()
 Returns the status to indicate whether the passenger seat reference point is active or not. More...
 
void SetActive (bool active)
 Sets the status to indicate whether the passenger is active or not. More...
 
void SetBackAngle (double dValue)
 Sets the passenger's back angle. More...
 
void SetDescription (const NXString &description)
 Sets the name or short description of the passenger. More...
 
void SetDescription (const char *description)
 Sets the name or short description of the passenger. More...
 
void SetHeelReferencePoint (NXOpen::Point *refPoint)
 Sets the passenger's heel reference point. More...
 
void SetHeelReferencePointActive (bool activeStatus)
 Sets the status to indicate whether the passenger heel reference point is active or not. More...
 
void SetHorizontalPointTravel (double dValue)
 Sets the passenger's horizontal adjustment in x direction. More...
 
void SetSeatAngle (double dValue)
 Sets the passenger's seat angle. More...
 
void SetSeatDirection (NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder::SeatDirectionOptions seatDirection)
 Sets the direction that this passenger is facing. More...
 
void SetSeatReferencePoint (NXOpen::Point *refPoint)
 Sets the passenger's seat reference point. More...
 
void SetSeatReferencePointActive (bool activeStatus)
 Sets the status to indicate whether the passenger seat reference point is active or not. 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

Represents a NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder .


An instance of this class can be obtained from BaseDataBuilder::CreatePassenger

Created in NX8.5.0.

Member Enumeration Documentation

This enum represents the options to define the passenger's seat direction type.

Enumerator
SeatDirectionOptionsFrontward 

Seat position driving direction.

SeatDirectionOptionsBackward 

Seat position opposite to the driving direction.

SeatDirectionOptionsLeft 

Seat directed towards the left side of the car.

SeatDirectionOptionsRight 

Seat directed towards the right side of the car.

SeatDirectionOptionsCustom 

Specify a custom value for the seat position (in deg).

1 to 179: Turning the seat rightwards; 1 to 179: Turning the seat leftwards.

Member Function Documentation

bool NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder::Active ( )

Returns the status to indicate whether the passenger is active or not.

If it is true, the passenger is active.
Created in NX8.5.0.

License requirements : None

void NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder::Assign ( NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder other)

Assigns values from another passenger.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
otherother
NXOpen::Expression* NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder::BackAngleExp ( )

Returns the passenger's back angle.


Created in NX9.0.1.

License requirements : None

NXString NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder::Description ( )

Returns the name or short description of the passenger.


Created in NX8.5.0.

License requirements : None

double NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder::GetBackAngle ( )

Returns the passenger's back angle.

Returns

Deprecated:
Deprecated in NX9.0.1. Obtain the expression using NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder::BackAngleExp to query or edit it.


Created in NX8.5.0.

License requirements : None

double NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder::GetHorizontalPointTravel ( )

Returns the passenger's horizontal adjustment in x direction.

Returns

Deprecated:
Deprecated in NX9.0.1. Obtain the expression using NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder::HorizontalPointTravelExp to query or edit it.


Created in NX8.5.0.

License requirements : None

double NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder::GetSeatAngle ( )

Returns the passenger's seat angle.

Returns

Deprecated:
Deprecated in NX9.0.1. Obtain the expression using NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder::SeatAngleExp to query or edit it.


Created in NX8.5.0.

License requirements : None

NXOpen::Point* NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder::HeelReferencePoint ( )

Returns the passenger's heel reference point.


Created in NX8.5.0.

License requirements : None

bool NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder::HeelReferencePointActive ( )

Returns the status to indicate whether the passenger heel reference point is active or not.

If it is true, the passenger heel reference point is active.
Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder::HorizontalPointTravelExp ( )

Returns the passenger's horizontal adjustment in x direction.


Created in NX9.0.1.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder::SeatAngleExp ( )

Returns the passenger's seat angle.


Created in NX9.0.1.

License requirements : None

NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder::SeatDirectionOptions NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder::SeatDirection ( )

Returns the direction that this passenger is facing.


Created in NX8.5.0.

License requirements : None

NXOpen::Point* NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder::SeatReferencePoint ( )

Returns the passenger's seat reference point.


Created in NX8.5.0.

License requirements : None

bool NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder::SeatReferencePointActive ( )

Returns the status to indicate whether the passenger seat reference point is active or not.

If it is true, the passenger seat reference point is active.
Created in NX8.5.0.

License requirements : None

void NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder::SetActive ( bool  active)

Sets the status to indicate whether the passenger is active or not.

If it is true, the passenger is active.
Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
activeactive
void NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder::SetBackAngle ( double  dValue)

Sets the passenger's back angle.


Deprecated:
Deprecated in NX9.0.1. Obtain the expression using NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder::BackAngleExp to query or edit it.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
dValuedvalue
void NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder::SetDescription ( const NXString description)

Sets the name or short description of the passenger.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
descriptiondescription
void NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder::SetDescription ( const char *  description)

Sets the name or short description of the passenger.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
descriptiondescription
void NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder::SetHeelReferencePoint ( NXOpen::Point refPoint)

Sets the passenger's heel reference point.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
refPointrefpoint
void NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder::SetHeelReferencePointActive ( bool  activeStatus)

Sets the status to indicate whether the passenger heel reference point is active or not.

If it is true, the passenger heel reference point is active.
Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
activeStatusactivestatus
void NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder::SetHorizontalPointTravel ( double  dValue)

Sets the passenger's horizontal adjustment in x direction.


Deprecated:
Deprecated in NX9.0.1. Obtain the expression using NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder::HorizontalPointTravelExp to query or edit it.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
dValuedvalue
void NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder::SetSeatAngle ( double  dValue)

Sets the passenger's seat angle.


Deprecated:
Deprecated in NX9.0.1. Obtain the expression using NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder::SeatAngleExp to query or edit it.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
dValuedvalue
void NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder::SetSeatDirection ( NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder::SeatDirectionOptions  seatDirection)

Sets the direction that this passenger is facing.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
seatDirectionseatdirection
void NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder::SetSeatReferencePoint ( NXOpen::Point refPoint)

Sets the passenger's seat reference point.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
refPointrefpoint
void NXOpen::Features::VehicleDesign::BaseDataPassengerBuilder::SetSeatReferencePointActive ( bool  activeStatus)

Sets the status to indicate whether the passenger seat reference point is active or not.

If it is true, the passenger seat reference point is active.
Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
activeStatusactivestatus

The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.