WindCatcherBuilder Class¶
-
class
NXOpen.Routing.WindCatcherBuilder¶ Bases:
NXOpen.BuilderBuilder class for Wind Catcher feature.
See
NXOpen.Routing.WindCatcherfor the Wind Catcher class documentation.To create a new instance of this class, use
NXOpen.Routing.RouteManager.CreateWindCatcherBuilder()New in version NX8.5.0.
Properties¶
| Property | Description |
|---|---|
| EndAngleExpression | Returns the angle in degrees between the wind direction vector and the open face of the Wind Catcher. |
| ParentDuct | Returns or sets the duct from which the Wind Catcher derives the wind direction. |
| ReverseWindDirection | Returns or sets the flag that indicates whether the wind direction is reversed from its normal direction. |
| Tag | Returns the Tag for this object. |
| TrimToParentDuct | Returns or sets the flag that indicates whether the Wind Catcher’s duct should be trimmed back to the top of the parent duct. |
| Type | Returns or sets the type of Wind Catcher. |
| WindCatcherDuct | Returns or sets the duct on which the Wind Catcher attaches. |
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. |
| GetClosestParentDuctSegment | Returns the linear segment under the Parent Duct that is closest to the Wind Catcher. |
| 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¶
| WindCatcherBuilderWindCatcherType Enumeration | Specifies the type of Wind Catcher. |
Property Detail¶
EndAngleExpression¶
-
WindCatcherBuilder.EndAngleExpression¶ Returns the angle in degrees between the wind direction vector and the open face of the Wind Catcher.
-------------------------------------Getter Method
Signature
EndAngleExpressionReturns: Return type: NXOpen.ExpressionNew in version NX8.5.0.
License requirements: routing_hvac (“Routing HVAC”)
ParentDuct¶
-
WindCatcherBuilder.ParentDuct¶ Returns or sets the duct from which the Wind Catcher derives the wind direction.
-------------------------------------Getter Method
Signature
ParentDuctReturns: Return type: NXOpen.Routing.StockNew in version NX8.5.0.
License requirements: routing_hvac (“Routing HVAC”)
-------------------------------------Setter Method
Signature
ParentDuctParameters: parentDuct ( NXOpen.Routing.Stock) –New in version NX8.5.0.
License requirements: routing_hvac (“Routing HVAC”)
ReverseWindDirection¶
-
WindCatcherBuilder.ReverseWindDirection¶ Returns or sets the flag that indicates whether the wind direction is reversed from its normal direction.
** The normal direction for the wind either matches the flow direction, if the parent stock ** is part of a Run, or matches the parent stock’s segment direction from the start control point ** to the end control point.
-------------------------------------Getter Method
Signature
ReverseWindDirectionReturns: Return type: bool New in version NX8.5.0.
License requirements: routing_hvac (“Routing HVAC”)
-------------------------------------Setter Method
Signature
ReverseWindDirectionParameters: windDirection (bool) – New in version NX8.5.0.
License requirements: routing_hvac (“Routing HVAC”)
TrimToParentDuct¶
-
WindCatcherBuilder.TrimToParentDuct¶ Returns or sets the flag that indicates whether the Wind Catcher’s duct should be trimmed back to the top of the parent duct.
-------------------------------------Getter Method
Signature
TrimToParentDuctReturns: Return type: bool New in version NX8.5.0.
License requirements: routing_hvac (“Routing HVAC”)
-------------------------------------Setter Method
Signature
TrimToParentDuctParameters: trim (bool) – New in version NX8.5.0.
License requirements: routing_hvac (“Routing HVAC”)
Type¶
-
WindCatcherBuilder.Type¶ Returns or sets the type of Wind Catcher.
-------------------------------------Getter Method
Signature
TypeReturns: Return type: NXOpen.Routing.WindCatcherBuilderWindCatcherTypeNew in version NX8.5.0.
License requirements: routing_hvac (“Routing HVAC”)
-------------------------------------Setter Method
Signature
TypeParameters: windCatcherType ( NXOpen.Routing.WindCatcherBuilderWindCatcherType) –New in version NX8.5.0.
License requirements: routing_hvac (“Routing HVAC”)
WindCatcherDuct¶
-
WindCatcherBuilder.WindCatcherDuct¶ Returns or sets the duct on which the Wind Catcher attaches.
-------------------------------------Getter Method
Signature
WindCatcherDuctReturns: Return type: NXOpen.Routing.StockNew in version NX8.5.0.
License requirements: routing_hvac (“Routing HVAC”)
-------------------------------------Setter Method
Signature
WindCatcherDuctParameters: windCatcherDuct ( NXOpen.Routing.Stock) –New in version NX8.5.0.
License requirements: routing_hvac (“Routing HVAC”)
Method Detail¶
GetClosestParentDuctSegment¶
-
WindCatcherBuilder.GetClosestParentDuctSegment¶ Returns the linear segment under the Parent Duct that is closest to the Wind Catcher.
Signature
GetClosestParentDuctSegment()Returns: Return type: NXOpen.Routing.LineSegmentNew in version NX8.5.0.
License requirements: routing_hvac (“Routing HVAC”)
Validate¶
-
WindCatcherBuilder.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.