HydraulicCylinderBuilder Class¶

class NXOpen.Mechatronics.HydraulicCylinderBuilder¶

Bases: NXOpen.Mechatronics.PhysicsConstraintBuilder

Represents a NXOpen.Mechatronics.HydraulicCylinder builder.

To create a new instance of this class, use NXOpen.Mechatronics.HydraulicCylinderCollection.CreateHydraulicCylinderBuilder()

New in version NX11.0.0.

Properties¶

Property	Description
AxisJoint	Returns the Axis Joint. This can be a `PhysicsJoint`.
Name	Returns or sets the name.
PistonDiameter	Returns the diameter of the piston.
PistonRodDiameter	Returns the diameter of the piston rod.
PressureA	Returns the initial pressure of chamber A.
PressureB	Returns the initial pressure of chamber B.
RodType	Returns or sets the rod type.
StrokeLength	Returns the overall stroke length of the cylinder.
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¶

HydraulicCylinderBuilderOutputRodType Enumeration

the Rod types.

Property Detail¶

AxisJoint¶

HydraulicCylinderBuilder.AxisJoint¶

Returns the Axis Joint. This can be a PhysicsJoint.

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

Getter Method

Signature AxisJoint()

Returns:
Return type:	`NXOpen.Mechatronics.SelectPhysicsJoint`

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

PistonDiameter¶

HydraulicCylinderBuilder.PistonDiameter¶

Returns the diameter of the piston.

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

Getter Method

Signature PistonDiameter()

Returns:
Return type:	`NXOpen.Expression`

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

PistonRodDiameter¶

HydraulicCylinderBuilder.PistonRodDiameter¶

Returns the diameter of the piston rod.

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

Getter Method

Signature PistonRodDiameter()

Returns:
Return type:	`NXOpen.Expression`

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

PressureA¶

HydraulicCylinderBuilder.PressureA¶

Returns the initial pressure of chamber A.

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

Getter Method

Signature PressureA()

Returns:
Return type:	`NXOpen.Expression`

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

PressureB¶

HydraulicCylinderBuilder.PressureB¶

Returns the initial pressure of chamber B.

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

Getter Method

Signature PressureB()

Returns:
Return type:	`NXOpen.Expression`

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

RodType¶

HydraulicCylinderBuilder.RodType¶

Returns or sets the rod type.

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

Getter Method

Signature RodType()

Returns:
Return type:	`NXOpen.Mechatronics.HydraulicCylinderBuilderOutputRodType`

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature RodType(rodType)

Parameters:	rodType (`NXOpen.Mechatronics.HydraulicCylinderBuilderOutputRodType`) –

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

StrokeLength¶

HydraulicCylinderBuilder.StrokeLength¶

Returns the overall stroke length of the cylinder.

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

Getter Method

Signature StrokeLength()

Returns:
Return type:	`NXOpen.Expression`

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Method Detail¶

Validate¶

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