SplitDuctBuilder Class¶
-
class
NXOpen.Routing.
SplitDuctBuilder
¶ Bases:
NXOpen.Builder
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 New in version NX7.5.0.
Properties¶
Property | Description |
---|---|
DivisionsList | Returns the divisions list |
FlowType | Returns or sets the type of flow to be displayed in the list flow column |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
AddDivisionsBuilderToList | 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. |
Commit | Commits any edits that have been applied to the builder. |
CreateNewDivisionsListItem | Creates a new item for the divisions list in Split Duct dialog @return |
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¶
SplitDuctBuilderFlowTypes Enumeration | The type of flow, whether Absolute or Relative, to be displayed in the %Flow column in the list. |
Property Detail¶
DivisionsList¶
-
SplitDuctBuilder.
DivisionsList
¶ Returns the divisions list
-------------------------------------
Getter Method
Signature
DivisionsList()
Returns: Return type: NXOpen.TaggedObjectList
New in version NX7.5.0.
License requirements: routing_hvac (“Routing HVAC”)
FlowType¶
-
SplitDuctBuilder.
FlowType
¶ Returns or sets the type of flow to be displayed in the list flow column
-------------------------------------
Getter Method
Signature
FlowType()
Returns: Return type: NXOpen.Routing.SplitDuctBuilderFlowTypes
New in version NX7.5.0.
License requirements: routing_hvac (“Routing HVAC”)
-------------------------------------
Setter Method
Signature
FlowType(flowType)
Parameters: flowType ( NXOpen.Routing.SplitDuctBuilderFlowTypes
) –New in version NX7.5.0.
License requirements: routing_hvac (“Routing HVAC”)
Method Detail¶
AddDivisionsBuilderToList¶
-
SplitDuctBuilder.
AddDivisionsBuilderToList
¶ 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.
Signature
AddDivisionsBuilderToList(selectedPort)
Parameters: selectedPort ( NXOpen.Routing.Port
) – Selected portNew in version NX7.5.0.
License requirements: routing_hvac (“Routing HVAC”)
CreateNewDivisionsListItem¶
-
SplitDuctBuilder.
CreateNewDivisionsListItem
¶ Creates a new item for the divisions list in Split Duct dialog
Signature
CreateNewDivisionsListItem(selectedPort, isAbsoluteFlow)
Parameters: - selectedPort (
NXOpen.Routing.Port
) – Selected port - isAbsoluteFlow (bool) – if TRUE: displays absolute flow percentage for each division, else displays relative flow percentage
Returns: Return type: New in version NX7.5.0.
License requirements: routing_hvac (“Routing HVAC”)
- selectedPort (
Validate¶
-
SplitDuctBuilder.
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.