DuctSizeCalculatorBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# DuctSizeCalculatorBuilder Class

class `NXOpen.Routing.``DuctSizeCalculatorBuilder`

  Bases: `NXOpen.Builder`

  Builder to perform calculations of the duct which is to be used in the HVAC applications.

  The duct has some flow attributes and has dimentions. To create a new instance of this class, use `NXOpen.Routing.RouteManager.CreateDuctSizeCalculatorBuilder()`

  Default values.

  Property | Value
  --- | ---
  DuctAreaExp.Value | 0 (millimeters part), 0 (inches part)
  DuctAspectRatioExp.Value | 0
  DuctDiameterExp.Value | 0 (millimeters part), 0 (inches part)
  DuctEqvalentDiameterExp.Value | 0 (millimeters part), 0 (inches part)
  DuctHeightExp.Value | 0 (millimeters part), 0 (inches part)
  DuctShape | Rectangular
  DuctWidthExp.Value | 0 (millimeters part), 0 (inches part)
  IsCreateSpaceReservationEnabled | 0
  IsDisplayFlowParamsEnabled | 0
  VelocityExp.Value | 0 (millimeters part), 0 (inches part)
  VolumeFlowRateExp.Value | 0 (millimeters part), 0 (inches part)

  New in version NX8.0.0.

# Properties

Property | Description
--- | ---
DuctAreaExp | Returns the duct area
DuctAspectRatioExp | Returns the Aspect ratio of the duct dimentions
DuctDiameterExp | Returns the duct diameter
DuctEqvalentDiameterExp | Returns the duct equivalent diameter
DuctHeightExp | Returns the duct height
DuctShape | Returns or sets the shape of the duct
DuctWidthExp | Returns the duct width
IsCreateSpaceReservationEnabled | Returns or sets the status of the create space reservation toggle; whether the toggle is on or off.
IsDisplayFlowParamsEnabled | Returns or sets the ON or OFF status of the Display flow parameters over Segments toggle
RouteObjectCollector | Returns the route object collector Stores the routing segments for which calculations are to be done
Tag | Returns the Tag for this object.
VelocityExp | Returns the velocity component Flow parameter for the duct.
VolumeFlowRateExp | Returns the volume flow rate associated with the duct.

# 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

DuctSizeCalculatorBuilderDuctShapeType Enumeration | This enum represents the shape of the duct

# Property Detail

## DuctAreaExp

`DuctSizeCalculatorBuilder.``DuctAreaExp`

  Returns the duct area

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

  Getter Method

  Signature `DuctAreaExp`

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

  New in version NX8.0.0.

  License requirements: routing_hvac (“Routing HVAC”)

## DuctAspectRatioExp

`DuctSizeCalculatorBuilder.``DuctAspectRatioExp`

  Returns the Aspect ratio of the duct dimentions

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

  Getter Method

  Signature `DuctAspectRatioExp`

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

  New in version NX8.0.0.

  License requirements: routing_hvac (“Routing HVAC”)

## DuctDiameterExp

`DuctSizeCalculatorBuilder.``DuctDiameterExp`

  Returns the duct diameter

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

  Getter Method

  Signature `DuctDiameterExp`

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

  New in version NX8.0.0.

  License requirements: routing_hvac (“Routing HVAC”)

## DuctEqvalentDiameterExp

`DuctSizeCalculatorBuilder.``DuctEqvalentDiameterExp`

  Returns the duct equivalent diameter

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

  Getter Method

  Signature `DuctEqvalentDiameterExp`

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

  New in version NX8.0.0.

  License requirements: routing_hvac (“Routing HVAC”)

## DuctHeightExp

`DuctSizeCalculatorBuilder.``DuctHeightExp`

  Returns the duct height

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

  Getter Method

  Signature `DuctHeightExp`

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

  New in version NX8.0.0.

  License requirements: routing_hvac (“Routing HVAC”)

## DuctShape

`DuctSizeCalculatorBuilder.``DuctShape`

  Returns or sets the shape of the duct

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

  Getter Method

  Signature `DuctShape`

  Returns: |
  Return type: | `NXOpen.Routing.DuctSizeCalculatorBuilderDuctShapeType`

  New in version NX8.0.0.

  License requirements: routing_hvac (“Routing HVAC”)

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

  Setter Method

  Signature `DuctShape`

  Parameters: | ductShape (`NXOpen.Routing.DuctSizeCalculatorBuilderDuctShapeType`) –

  New in version NX8.0.0.

  License requirements: routing_hvac (“Routing HVAC”)

## DuctWidthExp

`DuctSizeCalculatorBuilder.``DuctWidthExp`

  Returns the duct width

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

  Getter Method

  Signature `DuctWidthExp`

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

  New in version NX8.0.0.

  License requirements: routing_hvac (“Routing HVAC”)

## IsCreateSpaceReservationEnabled

`DuctSizeCalculatorBuilder.``IsCreateSpaceReservationEnabled`

  Returns or sets the status of the create space reservation toggle; whether the toggle is on or off.

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

  Getter Method

  Signature `IsCreateSpaceReservationEnabled`

  Returns: |
  Return type: | bool

  New in version NX8.0.0.

  License requirements: routing_hvac (“Routing HVAC”)

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

  Setter Method

  Signature `IsCreateSpaceReservationEnabled`

  Parameters: | isCreateSpaceReservation (bool) –

  New in version NX8.0.0.

  License requirements: routing_hvac (“Routing HVAC”)

## IsDisplayFlowParamsEnabled

`DuctSizeCalculatorBuilder.``IsDisplayFlowParamsEnabled`

  Returns or sets the ON or OFF status of the Display flow parameters over Segments toggle

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

  Getter Method

  Signature `IsDisplayFlowParamsEnabled`

  Returns: |
  Return type: | bool

  New in version NX8.0.0.

  License requirements: routing_hvac (“Routing HVAC”)

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

  Setter Method

  Signature `IsDisplayFlowParamsEnabled`

  Parameters: | isDispFlowParams (bool) –

  New in version NX8.0.0.

  License requirements: routing_hvac (“Routing HVAC”)

## RouteObjectCollector

`DuctSizeCalculatorBuilder.``RouteObjectCollector`

  Returns the route object collector Stores the routing segments for which calculations are to be done

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

  Getter Method

  Signature `RouteObjectCollector`

  Returns: |
  Return type: | `NXOpen.Routing.RouteObjectCollector`

  New in version NX8.0.0.

  License requirements: routing_hvac (“Routing HVAC”)

## VelocityExp

`DuctSizeCalculatorBuilder.``VelocityExp`

  Returns the velocity component Flow parameter for the duct.

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

  Getter Method

  Signature `VelocityExp`

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

  New in version NX8.0.0.

  License requirements: routing_hvac (“Routing HVAC”)

## VolumeFlowRateExp

`DuctSizeCalculatorBuilder.``VolumeFlowRateExp`

  Returns the volume flow rate associated with the duct.

  This is a flow parameter

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

  Getter Method

  Signature `VolumeFlowRateExp`

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

  New in version NX8.0.0.

  License requirements: routing_hvac (“Routing HVAC”)

# Method Detail

## Validate

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