NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Routing::DuctSizeCalculatorBuilder Class Reference

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

Inheritance diagram for NXOpen::Routing::DuctSizeCalculatorBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  DuctShapeType { DuctShapeTypeRectangular, DuctShapeTypeCircular, DuctShapeTypeFlatOval }
 This enum represents the shape of the duct. More...
 

Public Member Functions

NXOpen::ExpressionDuctAreaExp ()
 Returns the duct area
Created in NX8.0.0. More...
 
NXOpen::ExpressionDuctAspectRatioExp ()
 Returns the Aspect ratio of the duct dimentions
Created in NX8.0.0. More...
 
NXOpen::ExpressionDuctDiameterExp ()
 Returns the duct diameter
Created in NX8.0.0. More...
 
NXOpen::ExpressionDuctEqvalentDiameterExp ()
 Returns the duct equivalent diameter
Created in NX8.0.0. More...
 
NXOpen::ExpressionDuctHeightExp ()
 Returns the duct height
Created in NX8.0.0. More...
 
NXOpen::Routing::DuctSizeCalculatorBuilder::DuctShapeType DuctShape ()
 Returns the shape of the duct
Created in NX8.0.0. More...
 
NXOpen::ExpressionDuctWidthExp ()
 Returns the duct width
Created in NX8.0.0. More...
 
bool IsCreateSpaceReservationEnabled ()
 Returns the status of the create space reservation toggle; whether the toggle is on or off. More...
 
bool IsDisplayFlowParamsEnabled ()
 Returns the ON or OFF status of the Display flow parameters over Segments toggle
Created in NX8.0.0. More...
 
NXOpen::Routing::RouteObjectCollectorRouteObjectCollector ()
 Returns the route object collector Stores the routing segments for which calculations are to be done
Created in NX8.0.0. More...
 
void SetCreateSpaceReservationEnabled (bool isCreateSpaceReservation)
 Sets the status of the create space reservation toggle; whether the toggle is on or off. More...
 
void SetDisplayFlowParamsEnabled (bool isDispFlowParams)
 Sets the ON or OFF status of the Display flow parameters over Segments toggle
Created in NX8.0.0. More...
 
void SetDuctShape (NXOpen::Routing::DuctSizeCalculatorBuilder::DuctShapeType ductShape)
 Sets the shape of the duct
Created in NX8.0.0. More...
 
NXOpen::ExpressionVelocityExp ()
 Returns the velocity component Flow parameter for the duct. More...
 
NXOpen::ExpressionVolumeFlowRateExp ()
 Returns the volume flow rate associated with the duct. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

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)


Created in NX8.0.0.

Member Enumeration Documentation

This enum represents the shape of the duct.

Enumerator
DuctShapeTypeRectangular 

rectangular

DuctShapeTypeCircular 

circular

DuctShapeTypeFlatOval 

flat oval

Member Function Documentation

NXOpen::Expression* NXOpen::Routing::DuctSizeCalculatorBuilder::DuctAreaExp ( )

Returns the duct area
Created in NX8.0.0.



License requirements : routing_hvac ("Routing HVAC")

NXOpen::Expression* NXOpen::Routing::DuctSizeCalculatorBuilder::DuctAspectRatioExp ( )

Returns the Aspect ratio of the duct dimentions
Created in NX8.0.0.



License requirements : routing_hvac ("Routing HVAC")

NXOpen::Expression* NXOpen::Routing::DuctSizeCalculatorBuilder::DuctDiameterExp ( )

Returns the duct diameter
Created in NX8.0.0.



License requirements : routing_hvac ("Routing HVAC")

NXOpen::Expression* NXOpen::Routing::DuctSizeCalculatorBuilder::DuctEqvalentDiameterExp ( )

Returns the duct equivalent diameter
Created in NX8.0.0.



License requirements : routing_hvac ("Routing HVAC")

NXOpen::Expression* NXOpen::Routing::DuctSizeCalculatorBuilder::DuctHeightExp ( )

Returns the duct height
Created in NX8.0.0.



License requirements : routing_hvac ("Routing HVAC")

NXOpen::Routing::DuctSizeCalculatorBuilder::DuctShapeType NXOpen::Routing::DuctSizeCalculatorBuilder::DuctShape ( )

Returns the shape of the duct
Created in NX8.0.0.



License requirements : routing_hvac ("Routing HVAC")

NXOpen::Expression* NXOpen::Routing::DuctSizeCalculatorBuilder::DuctWidthExp ( )

Returns the duct width
Created in NX8.0.0.



License requirements : routing_hvac ("Routing HVAC")

bool NXOpen::Routing::DuctSizeCalculatorBuilder::IsCreateSpaceReservationEnabled ( )

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


Created in NX8.0.0.

License requirements : routing_hvac ("Routing HVAC")

bool NXOpen::Routing::DuctSizeCalculatorBuilder::IsDisplayFlowParamsEnabled ( )

Returns the ON or OFF status of the Display flow parameters over Segments toggle
Created in NX8.0.0.



License requirements : routing_hvac ("Routing HVAC")

NXOpen::Routing::RouteObjectCollector* NXOpen::Routing::DuctSizeCalculatorBuilder::RouteObjectCollector ( )

Returns the route object collector Stores the routing segments for which calculations are to be done
Created in NX8.0.0.



License requirements : routing_hvac ("Routing HVAC")

void NXOpen::Routing::DuctSizeCalculatorBuilder::SetCreateSpaceReservationEnabled ( bool  isCreateSpaceReservation)

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


Created in NX8.0.0.

License requirements : routing_hvac ("Routing HVAC")

Parameters
isCreateSpaceReservationiscreatespacereservation
void NXOpen::Routing::DuctSizeCalculatorBuilder::SetDisplayFlowParamsEnabled ( bool  isDispFlowParams)

Sets the ON or OFF status of the Display flow parameters over Segments toggle
Created in NX8.0.0.



License requirements : routing_hvac ("Routing HVAC")

Parameters
isDispFlowParamsisdispflowparams
void NXOpen::Routing::DuctSizeCalculatorBuilder::SetDuctShape ( NXOpen::Routing::DuctSizeCalculatorBuilder::DuctShapeType  ductShape)

Sets the shape of the duct
Created in NX8.0.0.



License requirements : routing_hvac ("Routing HVAC")

Parameters
ductShapeductshape
NXOpen::Expression* NXOpen::Routing::DuctSizeCalculatorBuilder::VelocityExp ( )

Returns the velocity component Flow parameter for the duct.


Created in NX8.0.0.

License requirements : routing_hvac ("Routing HVAC")

NXOpen::Expression* NXOpen::Routing::DuctSizeCalculatorBuilder::VolumeFlowRateExp ( )

Returns the volume flow rate associated with the duct.

This is a flow parameter
Created in NX8.0.0.

License requirements : routing_hvac ("Routing HVAC")


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.