HydraulicValveBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# HydraulicValveBuilder Class

class `NXOpen.Mechatronics.``HydraulicValveBuilder`

  Bases: `NXOpen.Mechatronics.PhysicsConstraintBuilder`

  Represents a `NXOpen.Mechatronics.HydraulicValve` builder.

  To create a new instance of this class, use `NXOpen.Mechatronics.HydraulicValveCollection.CreateHydraulicValveBuilder()`

  New in version NX11.0.0.

# Properties

Property | Description
--- | ---
ControlInput | Returns the initial control input.
Cylinders | Returns the Cylinder. This can be a `HydraulicCylinder`.
ExhaustPressure | Returns the initial exhaust pressure.
Name | Returns or sets the name.
NominalFlow | Returns the initial nominal flow.
NominalPressure | Returns the initial nominal pressure.
SupplyPressure | Returns the initial supply pressure.
Tag | Returns the Tag for this object.
ValveType | Returns or sets the valve type.

# 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.
SetCylinders | the Cylinders. Sets the cylinder array.
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

HydraulicValveBuilderOutputValveType Enumeration | the Valve types.

# Property Detail

## ControlInput

`HydraulicValveBuilder.``ControlInput`

  Returns the initial control input.

  `-------------------------------------`

  Getter Method

  Signature `ControlInput`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX11.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## Cylinders

`HydraulicValveBuilder.``Cylinders`

  Returns the Cylinder. This can be a `HydraulicCylinder`.

  `-------------------------------------`

  Getter Method

  Signature `Cylinders`

  Returns: |
  Return type: | `NXOpen.Mechatronics.SelectHydraulicCylinderList`

  New in version NX11.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## ExhaustPressure

`HydraulicValveBuilder.``ExhaustPressure`

  Returns the initial exhaust pressure.

  `-------------------------------------`

  Getter Method

  Signature `ExhaustPressure`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX11.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## NominalFlow

`HydraulicValveBuilder.``NominalFlow`

  Returns the initial nominal flow.

  `-------------------------------------`

  Getter Method

  Signature `NominalFlow`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX11.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## NominalPressure

`HydraulicValveBuilder.``NominalPressure`

  Returns the initial nominal pressure.

  `-------------------------------------`

  Getter Method

  Signature `NominalPressure`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX11.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## SupplyPressure

`HydraulicValveBuilder.``SupplyPressure`

  Returns the initial supply pressure.

  `-------------------------------------`

  Getter Method

  Signature `SupplyPressure`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX11.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## ValveType

`HydraulicValveBuilder.``ValveType`

  Returns or sets the valve type.

  `-------------------------------------`

  Getter Method

  Signature `ValveType`

  Returns: |
  Return type: | `NXOpen.Mechatronics.HydraulicValveBuilderOutputValveType`

  New in version NX11.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

  `-------------------------------------`

  Setter Method

  Signature `ValveType`

  Parameters: | valveType (`NXOpen.Mechatronics.HydraulicValveBuilderOutputValveType`) –

  New in version NX11.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

# Method Detail

## SetCylinders

`HydraulicValveBuilder.``SetCylinders`

  the Cylinders. Sets the cylinder array.

  Signature `SetCylinders(cylinders)`

  Parameters: | cylinders (list of `NXOpen.Mechatronics.HydraulicCylinder`) – Input geometries

  New in version NX11.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## Validate

`HydraulicValveBuilder.``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.