Builder class for Wind Catcher feature. More...
Public Types | |
| enum | WindCatcherType { WindCatcherTypeArc, WindCatcherTypeTriangle } |
| Specifies the type of Wind Catcher. More... | |
Public Member Functions | |
| NXOpen::Expression * | EndAngleExpression () |
| Returns the angle in degrees between the wind direction vector and the open face of the Wind Catcher. More... | |
| NXOpen::Routing::LineSegment * | GetClosestParentDuctSegment () |
| Returns the linear segment under the Parent Duct that is closest to the Wind Catcher. More... | |
| NXOpen::Routing::Stock * | ParentDuct () |
| Returns the duct from which the Wind Catcher derives the wind direction. More... | |
| bool | ReverseWindDirection () |
| Returns the flag that indicates whether the wind direction is reversed from its normal direction. More... | |
| void | SetParentDuct (NXOpen::Routing::Stock *parentDuct) |
| Sets the duct from which the Wind Catcher derives the wind direction. More... | |
| void | SetReverseWindDirection (bool windDirection) |
| Sets the flag that indicates whether the wind direction is reversed from its normal direction. More... | |
| void | SetTrimToParentDuct (bool trim) |
| Sets the flag that indicates whether the Wind Catcher's duct should be trimmed back to the top of the parent duct. More... | |
| void | SetType (NXOpen::Routing::WindCatcherBuilder::WindCatcherType windCatcherType) |
| Sets the type of Wind Catcher. More... | |
| void | SetWindCatcherDuct (NXOpen::Routing::Stock *windCatcherDuct) |
| Sets the duct on which the Wind Catcher attaches. More... | |
| bool | TrimToParentDuct () |
| Returns the flag that indicates whether the Wind Catcher's duct should be trimmed back to the top of the parent duct. More... | |
| NXOpen::Routing::WindCatcherBuilder::WindCatcherType | Type () |
| Returns the type of Wind Catcher. More... | |
| NXOpen::Routing::Stock * | WindCatcherDuct () |
| Returns the duct on which the Wind Catcher attaches. More... | |
 Public Member Functions inherited from NXOpen::Builder | |
| NXOpen::NXObject * | Commit () |
| 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::NXObject * | GetObject () |
| 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 class for Wind Catcher feature.
See NXOpen::Routing::WindCatcher for the Wind Catcher class documentation.
To create a new instance of this class, use NXOpen::Routing::RouteManager::CreateWindCatcherBuilder
Created in NX8.5.0.
Member Enumeration Documentation
Member Function Documentation
| NXOpen::Expression* NXOpen::Routing::WindCatcherBuilder::EndAngleExpression | ( | ) |
Returns the angle in degrees between the wind direction vector and the open face of the Wind Catcher.
Created in NX8.5.0.
License requirements : routing_hvac ("Routing HVAC")
| NXOpen::Routing::LineSegment* NXOpen::Routing::WindCatcherBuilder::GetClosestParentDuctSegment | ( | ) |
Returns the linear segment under the Parent Duct that is closest to the Wind Catcher.
- Returns
Created in NX8.5.0.
License requirements : routing_hvac ("Routing HVAC")
| NXOpen::Routing::Stock* NXOpen::Routing::WindCatcherBuilder::ParentDuct | ( | ) |
Returns the duct from which the Wind Catcher derives the wind direction.
Created in NX8.5.0.
License requirements : routing_hvac ("Routing HVAC")
| bool NXOpen::Routing::WindCatcherBuilder::ReverseWindDirection | ( | ) |
Returns 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.
Created in NX8.5.0.
License requirements : routing_hvac ("Routing HVAC")
| void NXOpen::Routing::WindCatcherBuilder::SetParentDuct | ( | NXOpen::Routing::Stock * | parentDuct | ) |
Sets the duct from which the Wind Catcher derives the wind direction.
Created in NX8.5.0.
License requirements : routing_hvac ("Routing HVAC")
- Parameters
-
parentDuct parentduct
| void NXOpen::Routing::WindCatcherBuilder::SetReverseWindDirection | ( | bool | windDirection | ) |
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.
Created in NX8.5.0.
License requirements : routing_hvac ("Routing HVAC")
- Parameters
-
windDirection winddirection
| void NXOpen::Routing::WindCatcherBuilder::SetTrimToParentDuct | ( | bool | trim | ) |
Sets the flag that indicates whether the Wind Catcher's duct should be trimmed back to the top of the parent duct.
Created in NX8.5.0.
License requirements : routing_hvac ("Routing HVAC")
- Parameters
-
trim trim
| void NXOpen::Routing::WindCatcherBuilder::SetType | ( | NXOpen::Routing::WindCatcherBuilder::WindCatcherType | windCatcherType | ) |
Sets the type of Wind Catcher.
Created in NX8.5.0.
License requirements : routing_hvac ("Routing HVAC")
- Parameters
-
windCatcherType windcatchertype
| void NXOpen::Routing::WindCatcherBuilder::SetWindCatcherDuct | ( | NXOpen::Routing::Stock * | windCatcherDuct | ) |
Sets the duct on which the Wind Catcher attaches.
Created in NX8.5.0.
License requirements : routing_hvac ("Routing HVAC")
- Parameters
-
windCatcherDuct windcatcherduct
| bool NXOpen::Routing::WindCatcherBuilder::TrimToParentDuct | ( | ) |
Returns the flag that indicates whether the Wind Catcher's duct should be trimmed back to the top of the parent duct.
Created in NX8.5.0.
License requirements : routing_hvac ("Routing HVAC")
| NXOpen::Routing::WindCatcherBuilder::WindCatcherType NXOpen::Routing::WindCatcherBuilder::Type | ( | ) |
Returns the type of Wind Catcher.
Created in NX8.5.0.
License requirements : routing_hvac ("Routing HVAC")
| NXOpen::Routing::Stock* NXOpen::Routing::WindCatcherBuilder::WindCatcherDuct | ( | ) |
Returns the duct on which the Wind Catcher attaches.
Created in NX8.5.0.
License requirements : routing_hvac ("Routing HVAC")
The documentation for this class was generated from the following file:
- Routing_WindCatcherBuilder.hxx