PendulumPlacementBuilder Class

class NXOpen.Features.VehicleDesign.PendulumPlacementBuilder

Bases: NXOpen.Builder

This builder allows you to define the pendulum placement information for bumper pendulum features in vehicle design.

It represents NXOpen.Features.VehicleDesign.PendulumPlacementBuilder This class is sub-object of another builder, and cannot be directly instantiated.

New in version NX8.5.0.

Properties

Property	Description
Angle	Returns the rotation angle of this pendulum.
Color	Returns or sets the display color of this pendulum.
Level	Returns the reference level of this pendulum.
Loading	Returns or sets the loading used with this pendulum.
Location	Returns or sets the location to use for positioning this pendulum.
Name	Returns or sets the name of this pendulum.
Offset	Returns the side offset of this pendulum.
PendulumProfile	Returns or sets the pendulum profile of this pendulum.
PositionMethod	Returns or sets the method to use for positioning this pendulum.
Shift	Returns the expression containing the amount to shift the pendulum from the contact point on the car.
ShowPendulum	Returns or sets the value indicating if this pendulum is displayed.
ShowPoint	Returns or sets the value indicating if the contact point (if any) between this pendulum and the bumper is displayed.
Side	Returns or sets the side to use for positioning this pendulum.
Tag	Returns the Tag for this object.

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

PendulumPlacementBuilderLocationType Enumeration	This enum represents the pendulum placement location options.
PendulumPlacementBuilderPendulumProfileType Enumeration	This enum represents the pendulum placement profile options.
PendulumPlacementBuilderPositionMethodType Enumeration	This enum represents the pendulum placement method options.
PendulumPlacementBuilderSideType Enumeration	This enum represents the pendulum placement side options.

Property Detail

Angle

PendulumPlacementBuilder.Angle

Returns the rotation angle of this pendulum.

-------------------------------------

Getter Method

Signature Angle

Returns: Return type:NXOpen.Expression

New in version NX8.5.0.

License requirements: None.

Color

PendulumPlacementBuilder.Color

Returns or sets the display color of this pendulum.

-------------------------------------

Getter Method

Signature Color

Returns: Return type:Id

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Color

Parameters:color (Id) –

New in version NX8.5.0.

License requirements: nx_general_packaging (“NX General Packaging”)

Level

PendulumPlacementBuilder.Level

Returns the reference level of this pendulum.

-------------------------------------

Getter Method

Signature Level

Returns: Return type:NXOpen.Expression

New in version NX8.5.0.

License requirements: None.

Loading

PendulumPlacementBuilder.Loading

Returns or sets the loading used with this pendulum.

-------------------------------------

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

Location

PendulumPlacementBuilder.Location

Returns or sets the location to use for positioning this pendulum.

-------------------------------------

Getter Method

Signature Location

Returns: Return type:NXOpen.Features.VehicleDesign.PendulumPlacementBuilderLocationType

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Location

Parameters:location (NXOpen.Features.VehicleDesign.PendulumPlacementBuilderLocationType) –

New in version NX8.5.0.

License requirements: nx_general_packaging (“NX General Packaging”)

Name

PendulumPlacementBuilder.Name

Returns or sets the name of this pendulum.

-------------------------------------

Getter Method

Signature Name

Returns: Return type:str

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Name

Parameters:name (str) –

New in version NX8.5.0.

License requirements: nx_general_packaging (“NX General Packaging”)

Offset

PendulumPlacementBuilder.Offset

Returns the side offset of this pendulum.

-------------------------------------

Getter Method

Signature Offset

Returns: Return type:NXOpen.Expression

New in version NX8.5.0.

License requirements: None.

PendulumProfile

PendulumPlacementBuilder.PendulumProfile

Returns or sets the pendulum profile of this pendulum.

-------------------------------------

Getter Method

Signature PendulumProfile

Returns: Return type:NXOpen.Features.VehicleDesign.PendulumPlacementBuilderPendulumProfileType

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature PendulumProfile

Parameters:pendulumProfile (NXOpen.Features.VehicleDesign.PendulumPlacementBuilderPendulumProfileType) –

New in version NX8.5.0.

License requirements: nx_general_packaging (“NX General Packaging”)

PositionMethod

PendulumPlacementBuilder.PositionMethod

Returns or sets the method to use for positioning this pendulum.

-------------------------------------

Getter Method

Signature PositionMethod

Returns: Return type:NXOpen.Features.VehicleDesign.PendulumPlacementBuilderPositionMethodType

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature PositionMethod

Parameters:positionMethod (NXOpen.Features.VehicleDesign.PendulumPlacementBuilderPositionMethodType) –

New in version NX8.5.0.

License requirements: nx_general_packaging (“NX General Packaging”)

Shift

PendulumPlacementBuilder.Shift

Returns the expression containing the amount to shift the pendulum from the contact point on the car.

-------------------------------------

Getter Method

Signature Shift

Returns: Return type:NXOpen.Expression

New in version NX8.5.0.

License requirements: None.

ShowPendulum

PendulumPlacementBuilder.ShowPendulum

Returns or sets the value indicating if this pendulum is displayed.

A value of false will hide this pendulum.

-------------------------------------

Getter Method

Signature ShowPendulum

Returns: Return type:bool

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ShowPendulum

Parameters:showPendulum (bool) –

New in version NX8.5.0.

License requirements: nx_general_packaging (“NX General Packaging”)

ShowPoint

PendulumPlacementBuilder.ShowPoint

Returns or sets the value indicating if the contact point (if any) between this pendulum and the bumper is displayed.

A value of false will hide the contact point.

-------------------------------------

Getter Method

Signature ShowPoint

Returns: Return type:bool

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ShowPoint

Parameters:showPoint (bool) –

New in version NX8.5.0.

License requirements: nx_general_packaging (“NX General Packaging”)

Side

PendulumPlacementBuilder.Side

Returns or sets the side to use for positioning this pendulum.

-------------------------------------

Getter Method

Signature Side

Returns: Return type:NXOpen.Features.VehicleDesign.PendulumPlacementBuilderSideType

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Side

Parameters:side (NXOpen.Features.VehicleDesign.PendulumPlacementBuilderSideType) –

New in version NX8.5.0.

License requirements: nx_general_packaging (“NX General Packaging”)

Method Detail

Validate

PendulumPlacementBuilder.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.