BaseDataPassengerBuilder Class¶
-
class
NXOpen.Features.VehicleDesign.
BaseDataPassengerBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.Features.VehicleDesign.BaseDataPassengerBuilder
.An instance of this class can be obtained from
BaseDataBuilder.CreatePassenger
New in version NX8.5.0.
Properties¶
Property | Description |
---|---|
Active | Returns or sets the status to indicate whether the passenger is active or not. |
BackAngleExp | Returns the passenger’s back angle. |
Description | Returns or sets the name or short description of the passenger. |
HeelReferencePoint | Returns or sets the passenger’s heel reference point. |
HeelReferencePointActive | Returns or sets the status to indicate whether the passenger heel reference point is active or not. |
HorizontalPointTravelExp | Returns the passenger’s horizontal adjustment in x direction. |
SeatAngleExp | Returns the passenger’s seat angle. |
SeatDirection | Returns or sets the direction that this passenger is facing. |
SeatReferencePoint | Returns or sets the passenger’s seat reference point. |
SeatReferencePointActive | Returns or sets the status to indicate whether the passenger seat reference point is active or not. |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Assign | Assigns values from another passenger. |
Commit | Commits any edits that have been applied to the builder. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetBackAngle | Returns the passenger’s back angle. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetHorizontalPointTravel | Returns the passenger’s horizontal adjustment in x direction. |
GetObject | Returns the object currently being edited by this builder. |
GetSeatAngle | Returns the passenger’s seat angle @return |
SetBackAngle | Sets the passenger’s back angle. |
SetHorizontalPointTravel | Sets the passenger’s horizontal adjustment in x direction. |
SetSeatAngle | Sets the passenger’s seat angle. |
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¶
BaseDataPassengerBuilderSeatDirectionOptions Enumeration | This enum represents the options to define the passenger’s seat direction type. |
Property Detail¶
Active¶
-
BaseDataPassengerBuilder.
Active
¶ Returns or sets the status to indicate whether the passenger is active or not.
If it is true, the passenger is active.
-------------------------------------
Getter Method
Signature
Active()
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Active(active)
Parameters: active (bool) – New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
BackAngleExp¶
-
BaseDataPassengerBuilder.
BackAngleExp
¶ Returns the passenger’s back angle.
-------------------------------------
Getter Method
Signature
BackAngleExp()
Returns: Return type: NXOpen.Expression
New in version NX9.0.1.
License requirements: None.
Description¶
-
BaseDataPassengerBuilder.
Description
¶ Returns or sets the name or short description of the passenger.
-------------------------------------
Getter Method
Signature
Description()
Returns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Description(description)
Parameters: description (str) – New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
HeelReferencePoint¶
-
BaseDataPassengerBuilder.
HeelReferencePoint
¶ Returns or sets the passenger’s heel reference point.
-------------------------------------
Getter Method
Signature
HeelReferencePoint()
Returns: Return type: NXOpen.Point
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HeelReferencePoint(refPoint)
Parameters: refPoint ( NXOpen.Point
) –New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
HeelReferencePointActive¶
-
BaseDataPassengerBuilder.
HeelReferencePointActive
¶ Returns or 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.
-------------------------------------
Getter Method
Signature
HeelReferencePointActive()
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HeelReferencePointActive(activeStatus)
Parameters: activeStatus (bool) – New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
HorizontalPointTravelExp¶
-
BaseDataPassengerBuilder.
HorizontalPointTravelExp
¶ Returns the passenger’s horizontal adjustment in x direction.
-------------------------------------
Getter Method
Signature
HorizontalPointTravelExp()
Returns: Return type: NXOpen.Expression
New in version NX9.0.1.
License requirements: None.
SeatAngleExp¶
-
BaseDataPassengerBuilder.
SeatAngleExp
¶ Returns the passenger’s seat angle.
-------------------------------------
Getter Method
Signature
SeatAngleExp()
Returns: Return type: NXOpen.Expression
New in version NX9.0.1.
License requirements: None.
SeatDirection¶
-
BaseDataPassengerBuilder.
SeatDirection
¶ Returns or sets the direction that this passenger is facing.
-------------------------------------
Getter Method
Signature
SeatDirection()
Returns: Return type: NXOpen.Features.VehicleDesign.BaseDataPassengerBuilderSeatDirectionOptions
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SeatDirection(seatDirection)
Parameters: seatDirection ( NXOpen.Features.VehicleDesign.BaseDataPassengerBuilderSeatDirectionOptions
) –New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
SeatReferencePoint¶
-
BaseDataPassengerBuilder.
SeatReferencePoint
¶ Returns or sets the passenger’s seat reference point.
-------------------------------------
Getter Method
Signature
SeatReferencePoint()
Returns: Return type: NXOpen.Point
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SeatReferencePoint(refPoint)
Parameters: refPoint ( NXOpen.Point
) –New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
SeatReferencePointActive¶
-
BaseDataPassengerBuilder.
SeatReferencePointActive
¶ Returns or 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.
-------------------------------------
Getter Method
Signature
SeatReferencePointActive()
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SeatReferencePointActive(activeStatus)
Parameters: activeStatus (bool) – New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
Method Detail¶
Assign¶
-
BaseDataPassengerBuilder.
Assign
¶ Assigns values from another passenger.
Signature
Assign(other)
Parameters: other ( NXOpen.Features.VehicleDesign.BaseDataPassengerBuilder
) –New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
GetBackAngle¶
-
BaseDataPassengerBuilder.
GetBackAngle
¶ Returns the passenger’s back angle.
Signature
GetBackAngle()
Returns: Return type: float New in version NX8.5.0.
Deprecated since version NX9.0.1: Obtain the expression using
NXOpen.Features.VehicleDesign.BaseDataPassengerBuilder.BackAngleExp
to query or edit it.License requirements: None.
GetHorizontalPointTravel¶
-
BaseDataPassengerBuilder.
GetHorizontalPointTravel
¶ Returns the passenger’s horizontal adjustment in x direction.
Signature
GetHorizontalPointTravel()
Returns: Return type: float New in version NX8.5.0.
Deprecated since version NX9.0.1: Obtain the expression using
NXOpen.Features.VehicleDesign.BaseDataPassengerBuilder.HorizontalPointTravelExp
to query or edit it.License requirements: None.
GetSeatAngle¶
-
BaseDataPassengerBuilder.
GetSeatAngle
¶ Returns the passenger’s seat angle
Signature
GetSeatAngle()
Returns: Return type: float New in version NX8.5.0.
Deprecated since version NX9.0.1: Obtain the expression using
NXOpen.Features.VehicleDesign.BaseDataPassengerBuilder.SeatAngleExp
to query or edit it.License requirements: None.
SetBackAngle¶
-
BaseDataPassengerBuilder.
SetBackAngle
¶ Sets the passenger’s back angle.
Signature
SetBackAngle(dValue)
Parameters: dValue (float) – New in version NX8.5.0.
Deprecated since version NX9.0.1: Obtain the expression using
NXOpen.Features.VehicleDesign.BaseDataPassengerBuilder.BackAngleExp
to query or edit it.License requirements: nx_general_packaging (“NX General Packaging”)
SetHorizontalPointTravel¶
-
BaseDataPassengerBuilder.
SetHorizontalPointTravel
¶ Sets the passenger’s horizontal adjustment in x direction.
Signature
SetHorizontalPointTravel(dValue)
Parameters: dValue (float) – New in version NX8.5.0.
Deprecated since version NX9.0.1: Obtain the expression using
NXOpen.Features.VehicleDesign.BaseDataPassengerBuilder.HorizontalPointTravelExp
to query or edit it.License requirements: nx_general_packaging (“NX General Packaging”)
SetSeatAngle¶
-
BaseDataPassengerBuilder.
SetSeatAngle
¶ Sets the passenger’s seat angle.
Signature
SetSeatAngle(dValue)
Parameters: dValue (float) – New in version NX8.5.0.
Deprecated since version NX9.0.1: Obtain the expression using
NXOpen.Features.VehicleDesign.BaseDataPassengerBuilder.SeatAngleExp
to query or edit it.License requirements: nx_general_packaging (“NX General Packaging”)
Validate¶
-
BaseDataPassengerBuilder.
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.