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

Represents a NXOpen::Routing::SplitDuctBuilder. More...

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

Public Types

enum  FlowTypes { FlowTypesAbsoluteFlow, FlowTypesRelativeFlow }
 The type of flow, whether Absolute or Relative, to be displayed in the Flow column in the list. More...
 

Public Member Functions

void AddDivisionsBuilderToList (NXOpen::Routing::Port *selectedPort)
 Creates divisions builders for all the divisions, if any, associated with the cross-section to which the input port belongs and adds them to the list of divisions. More...
 
NXOpen::Routing::DivisionsBuilderCreateNewDivisionsListItem (NXOpen::Routing::Port *selectedPort, bool isAbsoluteFlow)
 Creates a new item for the divisions list in Split Duct dialog. More...
 
NXOpen::TaggedObjectListDivisionsList ()
 Returns the divisions list
Created in NX7.5.0. More...
 
NXOpen::Routing::SplitDuctBuilder::FlowTypes FlowType ()
 Returns the type of flow to be displayed in the list flow column
Created in NX7.5.0. More...
 
void SetFlowType (NXOpen::Routing::SplitDuctBuilder::FlowTypes flowType)
 Sets the type of flow to be displayed in the list flow column
Created in NX7.5.0. 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

Represents a NXOpen::Routing::SplitDuctBuilder.

Builder for creating/editing splits at an end of a duct. Takes an end face of a rectangular stock and splits it into a pair of divisions based on the specified absolute flow percentage for each division.
To create a new instance of this class, use NXOpen::Routing::RouteManager::CreateSplitDuctBuilder
Default values.

Property Value

FlowType

AbsoluteFlow


Created in NX7.5.0.

Member Enumeration Documentation

The type of flow, whether Absolute or Relative, to be displayed in the Flow column in the list.

This also controls the type of flow based on which divisions can be created or edited

Enumerator
FlowTypesAbsoluteFlow 

Absolute flow.

FlowTypesRelativeFlow 

Relative flow.

Member Function Documentation

void NXOpen::Routing::SplitDuctBuilder::AddDivisionsBuilderToList ( NXOpen::Routing::Port selectedPort)

Creates divisions builders for all the divisions, if any, associated with the cross-section to which the input port belongs and adds them to the list of divisions.


Created in NX7.5.0.

License requirements : routing_hvac ("Routing HVAC")

Parameters
selectedPortSelected port
NXOpen::Routing::DivisionsBuilder* NXOpen::Routing::SplitDuctBuilder::CreateNewDivisionsListItem ( NXOpen::Routing::Port selectedPort,
bool  isAbsoluteFlow 
)

Creates a new item for the divisions list in Split Duct dialog.

Returns

Created in NX7.5.0.

License requirements : routing_hvac ("Routing HVAC")
Parameters
selectedPortSelected port
isAbsoluteFlowif TRUE: displays absolute flow percentage for each division, else displays relative flow percentage
NXOpen::TaggedObjectList* NXOpen::Routing::SplitDuctBuilder::DivisionsList ( )

Returns the divisions list
Created in NX7.5.0.



License requirements : routing_hvac ("Routing HVAC")

NXOpen::Routing::SplitDuctBuilder::FlowTypes NXOpen::Routing::SplitDuctBuilder::FlowType ( )

Returns the type of flow to be displayed in the list flow column
Created in NX7.5.0.



License requirements : routing_hvac ("Routing HVAC")

void NXOpen::Routing::SplitDuctBuilder::SetFlowType ( NXOpen::Routing::SplitDuctBuilder::FlowTypes  flowType)

Sets the type of flow to be displayed in the list flow column
Created in NX7.5.0.



License requirements : routing_hvac ("Routing HVAC")

Parameters
flowTypeflowtype

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