 |
OpenStudio:model |
|
OpenStudio:model |
#include <AirLoopHVACOutdoorAirSystem.hpp>
Inheritance diagram for openstudio::model::AirLoopHVACOutdoorAirSystem:Public Member Functions | |
| virtual bool | addToNode (Node &node) |
| boost::optional < AirflowNetworkDistributionNode > | airflowNetworkDistributionNode () const |
| boost::optional< AirLoopHVAC > | airLoop () const |
| Reimplemented from HVACComponent. More... | |
| AirLoopHVACOutdoorAirSystem (Model &model, const ControllerOutdoorAir &controller) | |
| Constructs a new AirLoopHVACOutdoorAirSystem object and places it inside the model. More... | |
| virtual ModelObject | clone (Model model) const |
| boost::optional< ModelObject > | component (openstudio::Handle handle) |
| Returns the optional ModelObject with the Handle given. More... | |
| std::vector< ModelObject > | components () const |
| Returns a vector that is the concatenation of oaComponents() and reliefComponents(). More... | |
| AirflowNetworkDistributionNode | getAirflowNetworkDistributionNode () |
| ControllerOutdoorAir | getControllerOutdoorAir () const |
| Returns the ControllerOutdoorAir object associated with the AirLoopHVACOutdoorAirSystem. More... | |
| boost::optional< ModelObject > | mixedAirModelObject () |
| Returns the optional ModelObject attached to the mixer air port. More... | |
| unsigned | mixedAirPort () const |
| Returns the mixed air port. More... | |
| boost::optional< ModelObject > | oaComponent (openstudio::Handle handle) |
| Returns the optional ModelObject with the Handle given. More... | |
| std::vector< ModelObject > | oaComponents () const |
| Returns a vector of model objects that are on the path of the incoming outdoor air stream. More... | |
| boost::optional< Node > | outboardOANode () const |
| Returns the most outboard outdoor air Node. More... | |
| boost::optional< Node > | outboardReliefNode () const |
| Returns the most outboard relief air Node. More... | |
| boost::optional< ModelObject > | outdoorAirModelObject () |
| Returns the optional ModelObject attached to the outdoor air port. More... | |
| unsigned | outdoorAirPort () const |
| Returns the outdoor air port of the outdoor air mixer. More... | |
| boost::optional< ModelObject > | reliefAirModelObject () |
| Returns the optional ModelObject attached to the relief air port. More... | |
| unsigned | reliefAirPort () const |
| Returns the outdoor air port of the outdoor air system. More... | |
| boost::optional< ModelObject > | reliefComponent (openstudio::Handle handle) |
| Returns the optional ModelObject with the Handle given. More... | |
| std::vector< ModelObject > | reliefComponents () const |
| Returns a vector of model objects that are on the path of the outgoing relief air stream. More... | |
| virtual std::vector < openstudio::IdfObject > | remove () |
| boost::optional< ModelObject > | returnAirModelObject () |
| Returns the optional ModelObject attached to the return air port. More... | |
| unsigned | returnAirPort () const |
| Returns the return air port of the outdoor air system. More... | |
| bool | setControllerOutdoorAir (const ControllerOutdoorAir &controllerOutdoorAir) |
| Sets the ControllerOutdoorAir object associated with the AirLoopHVACOutdoorAirSystem. More... | |
| virtual | ~AirLoopHVACOutdoorAirSystem () |
| Public Member Functions inherited from openstudio::model::HVACComponent | |
| bool | addToNode (Node &node) |
| Adds this object to a new system node and returns a boolean indicating if the addition was successful. More... | |
| bool | addToSplitter (Splitter &splitter) |
| Adds this object to a splitter by creating a new branch. More... | |
| boost::optional< AirLoopHVAC > | airLoopHVAC () const |
| Returns the optional AirLoopHVAC object that the HVAC component is attached to. More... | |
| boost::optional < AirLoopHVACOutdoorAirSystem > | airLoopHVACOutdoorAirSystem () const |
| Returns the optional AirLoopHVACOutdoorAirSystem that the HVAC component is attached to. More... | |
| void | applySizingValues () |
| void | autosize () |
| Returns the optional ModelObject connected to this object's port. More... | |
| boost::optional< HVACComponent > | containingHVACComponent () const |
| EnergyPlus unitary equipment and air terminals are typically composed of other HVAC components. More... | |
| boost::optional < StraightComponent > | containingStraightComponent () const |
| boost::optional < ZoneHVACComponent > | containingZoneHVACComponent () const |
| Returns any ZoneHVACComponent that contains this HVACComponent. More... | |
| void | disconnect () |
| Removes all connections to other HVACComponent objects. More... | |
| bool | isRemovable () const |
| Indicates if the HVACComponent can be removed from the model. More... | |
| boost::optional< Loop > | loop () const |
| Returns the optional Loop object that the HVAC component is attached to. More... | |
| boost::optional< PlantLoop > | plantLoop () const |
| Returns the optional PlantLoop object that the HVAC component is attached to. More... | |
| std::vector< IdfObject > | remove () |
| Removes the HVACComponent from the model only if isRemovable() return true. More... | |
| virtual | ~HVACComponent () |
| Public Member Functions inherited from openstudio::model::ParentObject | |
| std::vector< IddObjectType > | allowableChildTypes () const |
| Returns a vector of allowable children types. More... | |
| std::vector< ModelObject > | children () const |
| Return direct child objects in the Model. More... | |
| virtual | ~ParentObject () |
| Public Member Functions inherited from openstudio::model::ModelObject | |
| virtual | ~ModelObject () |
| ModelObject | clone () const |
| Creates a deep copy of this object, placing it in this object's model(). More... | |
| ModelObject | clone (Model model) const |
| Creates a deep copy of this object, placing it in model. More... | |
| Component | createComponent () const |
| Method for creating sharable Model snippets. More... | |
| Model | model () const |
| Returns the Model that contains this object. More... | |
| boost::optional< ParentObject > | parent () const |
| Return this object's parent in the hierarchy, if it has one. More... | |
| std::vector< ResourceObject > | resources () const |
| Get the resources directly used by this ModelObject. More... | |
| template<typename T > | |
| std::vector< T > | getModelObjectSources () const |
| Get all objects of type T that point to this object. More... | |
| template<typename T > | |
| std::vector< T > | getModelObjectSources (IddObjectType iddObjectType) const |
| Get all objects of type T that point to this object. More... | |
| template<typename T > | |
| boost::optional< T > | getModelObjectTarget (unsigned index) const |
| Get the object of type T pointed to by this object from field index. More... | |
| template<typename T > | |
| std::vector< T > | getModelObjectTargets () const |
| Get all objects of type T to which this object points. More... | |
| const std::vector< std::string > & | outputVariableNames () const |
| Get all output variables names that could be associated with this object. More... | |
| std::vector< OutputVariable > | outputVariables () const |
| Get all output variables associated with this object, must run simulation to generate data. More... | |
| boost::optional < openstudio::TimeSeries > | getData (const OutputVariable &variable, const std::string &envPeriod) const |
| Get data associated with this output variable and this object. More... | |
| std::vector< LifeCycleCost > | lifeCycleCosts () const |
| Returns the list of all LifeCycleCosts that refer to this object. More... | |
| std::vector< IdfObject > | removeLifeCycleCosts () |
| Removes all LifeCycleCosts that refer to this object. More... | |
| IddObjectType | iddObjectType () const |
| This is a virtual function that will tell you the type of iddObject you are dealing with. More... | |
| AdditionalProperties | additionalProperties () const |
| Returns this object's additional properties, constructing a new object if necessary. More... | |
| bool | hasAdditionalProperties () const |
| Returns true if this object has additional properties. More... | |
| std::vector< IdfObject > | removeAdditionalProperties () |
| Removes all additional properties that refer to this object. More... | |
| bool | setParent (ParentObject &newParent) |
| set the parent, child may have to call non-const methods on the parent More... | |
| bool | operator< (const ModelObject &right) const |
| bool | operator== (const ModelObject &other) const |
| equality test More... | |
| bool | operator!= (const ModelObject &other) const |
| inequality test More... | |
| std::vector< ScheduleTypeKey > | getScheduleTypeKeys (const Schedule &schedule) const |
| Return the ScheduleTypeKeys indicating how schedule is used in this object. More... | |
| boost::optional< double > | getAutosizedValue (std::string valueName, std::string unitString) const |
| Gets the autosized component value from the sql file. More... | |
| virtual std::vector < EMSActuatorNames > | emsActuatorNames () const |
| Return the names of the available ems actuators. More... | |
| virtual std::vector< std::string > | emsInternalVariableNames () const |
| Return the names of the available ems internal variables. More... | |
| boost::optional< ModelObject > | connectedObject (unsigned port) const |
| boost::optional< unsigned > | connectedObjectPort (unsigned port) const |
| Public Member Functions inherited from openstudio::WorkspaceObject | |
| bool | canBeSource () const |
| bool | canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const |
| std::vector< std::string > | canBeTarget () const |
| std::vector< unsigned > | getSourceIndices (const Handle &targetHandle) const |
| std::vector< WorkspaceObject > | getSources (IddObjectType type) const |
| boost::optional< WorkspaceObject > | getTarget (unsigned index) const |
| IdfObject | idfObject () |
| IdfObject | idfObject () const |
| bool | initialized () const |
| bool | isSource () const |
| bool | isTarget () const |
| unsigned | numSources () const |
| bool | objectListFieldsEqual (const WorkspaceObject &other) const |
| bool | objectListFieldsNonConflicting (const WorkspaceObject &other) const |
| bool | operator< (const WorkspaceObject &right) const |
| std::ostream & | operator<< (std::ostream &os, const WorkspaceObject &workspaceObject) |
| std::vector < openstudio::IdfObject > | remove () |
| bool | setPointer (unsigned index, const Handle &targetHandle) |
| std::vector< WorkspaceObject > | sources () const |
| std::vector< WorkspaceObject > | targets () const |
| Workspace | workspace () const |
| virtual | ~WorkspaceObject () |
| Public Member Functions inherited from openstudio::IdfObject | |
| std::string | briefDescription () const |
| T | cast () const |
| std::vector< T > | castVector (const std::vector< U > &objects) |
| std::vector< std::vector < std::string > > | clearExtensibleGroups () |
| IdfObject | clone (bool keepHandle=false) const |
| std::string | comment () const |
| boost::optional< std::string > | createName (bool overwrite=true) |
| std::vector< unsigned > | dataFields () const |
| bool | dataFieldsEqual (const IdfObject &other) const |
| std::vector< std::string > | eraseExtensibleGroup (unsigned groupIndex) |
| std::vector< IdfExtensibleGroup > | extensibleGroups () const |
| boost::optional< std::string > | fieldComment (unsigned index, bool returnDefault=false) const |
| boost::optional< double > | getDouble (unsigned index, bool returnDefault=false) const |
| IdfExtensibleGroup | getExtensibleGroup (unsigned groupIndex) const |
| std::vector< Handle > | getHandles (const std::vector< T > &objects) |
| boost::optional< int > | getInt (unsigned index, bool returnDefault=false) const |
| OSOptionalQuantity | getQuantity (unsigned index, bool returnDefault=false, bool returnIP=false) const |
| boost::optional< std::string > | getString (unsigned index, bool returnDefault=false, bool returnUninitializedEmpty=false) const |
| boost::optional< unsigned > | getUnsigned (unsigned index, bool returnDefault=false) const |
| boost::optional< QUrl > | getURL (unsigned index, bool returnDefault=false) const |
| Handle | handle () const |
| IddObject | iddObject () const |
| IdfObject (IddObjectType type, bool fastName=false) | |
| IdfObject (const IddObject &, bool fastName=false) | |
| IdfObject (const IdfObject &other) | |
| IdfExtensibleGroup | insertExtensibleGroup (unsigned groupIndex) |
| IdfExtensibleGroup | insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values) |
| bool | isDataField (unsigned index) const |
| bool | isEmpty (unsigned index) const |
| bool | isObjectListField (unsigned index) const |
| bool | isValid (StrictnessLevel level, bool checkNames=false) const |
| boost::optional< unsigned > | maxExtensibleGroups () const |
| boost::optional< unsigned > | maxFields () const |
| unsigned | minExtensibleGroups () const |
| unsigned | minFields () const |
| boost::optional< std::string > | name (bool returnDefault=false) const |
| std::string | nameString (bool returnDefault=false) const |
| unsigned | numExtensibleGroups () const |
| unsigned | numFields () const |
| unsigned | numNonextensibleFields () const |
| std::vector< unsigned > | objectListFields () const |
| bool | objectListFieldsEqual (const IdfObject &other) const |
| bool | objectListFieldsNonConflicting (const IdfObject &other) const |
| bool | operator!= (const IdfObject &other) const |
| std::ostream & | operator<< (std::ostream &os, const IdfObject &IdfObject) |
| bool | operator== (const IdfObject &other) const |
| boost::optional< T > | optionalCast () const |
| std::vector< std::string > | popExtensibleGroup () |
| std::ostream & | print (std::ostream &os) const |
| std::ostream & | printField (std::ostream &os, unsigned index, bool isLastField=false) const |
| std::ostream & | printName (std::ostream &os, bool hasFields=true) const |
| IdfExtensibleGroup | pushExtensibleGroup () |
| IdfExtensibleGroup | pushExtensibleGroup (const std::vector< std::string > &values) |
| std::vector< unsigned > | requiredFields () const |
| void | setComment (const std::string &msg) |
| bool | setDouble (unsigned index, double value) |
| bool | setFieldComment (unsigned index, const std::string &cmnt) |
| bool | setInt (unsigned index, int value) |
| boost::optional< std::string > | setName (const std::string &newName) |
| bool | setQuantity (unsigned index, const Quantity &q) |
| bool | setString (unsigned index, const std::string &value) |
| bool | setUnsigned (unsigned index, unsigned value) |
| std::vector< T > | subsetCastVector (const std::vector< U > &original) |
| ValidityReport | validityReport (StrictnessLevel level, bool checkNames=false) const |
| virtual | ~IdfObject () |
Static Public Member Functions | |
| static IddObjectType | iddObjectType () |
| Static Public Member Functions inherited from openstudio::IdfObject | |
| static boost::optional< IdfObject > | load (const std::string &text) |
| static boost::optional< IdfObject > | load (const std::string &text, const IddObject &iddObject) |
| static int | printedFieldSpace () |
Related Functions | |
(Note that these are not member functions.) | |
| typedef std::vector < AirLoopHVACOutdoorAirSystem > | AirLoopHVACOutdoorAirSystemVector |
| typedef boost::optional < AirLoopHVACOutdoorAirSystem > | OptionalAirLoopHVACOutdoorAirSystem |
| Related Functions inherited from openstudio::model::ParentObject | |
| std::vector< ModelObject > | getRecursiveChildren (const ParentObject &object, bool includeLifeCycleCostsAndAdditionalProperties=false) |
| Returns object and all other objects accessible by calling children() on encountered ParentObjects . More... | |
| std::vector< ModelObject > | getRecursiveChildrenAndResources (const ModelObject &object) |
| Returns object and all other objects accessible by calling children() and resources() on encountered ModelObjects . More... | |
| Related Functions inherited from openstudio::model::ModelObject | |
| std::vector< ResourceObject > | getRecursiveResources (const ModelObject &object) |
| Returns all ResourceObjects accessible by recursively calling .resources() starting from object. More... | |
| typedef std::pair< std::string, std::string > | ScheduleTypeKey |
| Typedef for ScheduleTypeRegistry key. More... | |
Additional Inherited Members | |
| Public Types inherited from openstudio::WorkspaceObject | |
| typedef boost::optional < WorkspaceObject > | OptionalWorkspaceObject |
| typedef std::vector < WorkspaceObject > | WorkspaceObjectVector |
| Public Types inherited from openstudio::IdfObject | |
| typedef std::pair< IdfObject, IdfObject > | IdfObjectPair |
| typedef std::vector< IdfObject > | IdfObjectVector |
| typedef boost::optional < IdfObject > | OptionalIdfObject |
| Protected Types inherited from openstudio::model::HVACComponent | |
| typedef detail::HVACComponent_Impl | ImplType |
| Protected Types inherited from openstudio::model::ModelObject | |
| typedef detail::ModelObject_Impl | ImplType |
| Protected Types inherited from openstudio::WorkspaceObject | |
| typedef detail::WorkspaceObject_Impl | ImplType |
| Protected Types inherited from openstudio::IdfObject | |
| typedef detail::IdfObject_Impl | ImplType |
| Protected Member Functions inherited from openstudio::model::HVACComponent | |
| virtual std::vector< ModelObject > | children () const |
| HVACComponent (IddObjectType type, const Model &model) | |
| HVACComponent (std::shared_ptr< ImplType > impl) | |
| Protected Member Functions inherited from openstudio::model::ParentObject | |
| ParentObject (IddObjectType type, const Model &model) | |
| Constructs a new ParentObject object in the model. More... | |
| Protected Member Functions inherited from openstudio::model::ModelObject | |
| ModelObject (IddObjectType type, const Model &model, bool fastName=false) | |
| ModelObject (std::shared_ptr< detail::ModelObject_Impl > impl) | |
| Protected Member Functions inherited from openstudio::WorkspaceObject | |
| WorkspaceObject (std::shared_ptr< detail::WorkspaceObject_Impl > impl) | |
| Protected Member Functions inherited from openstudio::IdfObject | |
| IdfObject (std::shared_ptr< detail::IdfObject_Impl > impl) | |
AirLoopHVACOutdoorAirSystem is an HVACComponent that wraps the IDD object named "OS:AirLoopHVAC:OutdoorAirSystem".
The purpose of this class is to simplify the construction and manipulation of the EnergyPlus AirLoopHVAC:OutdoorAirSystem object.
|
explicit |
Constructs a new AirLoopHVACOutdoorAirSystem object and places it inside the model.
|
inlinevirtual |
|
virtual |
| boost::optional<AirflowNetworkDistributionNode> openstudio::model::AirLoopHVACOutdoorAirSystem::airflowNetworkDistributionNode | ( | ) | const |
| boost::optional<AirLoopHVAC> openstudio::model::AirLoopHVACOutdoorAirSystem::airLoop | ( | ) | const |
Reimplemented from HVACComponent.
|
virtual |
| boost::optional<ModelObject> openstudio::model::AirLoopHVACOutdoorAirSystem::component | ( | openstudio::Handle | handle | ) |
Returns the optional ModelObject with the Handle given.
The optional will be false if the given handle does not correspond to the a ModelObject that is not part of the outdoor air system.
| std::vector<ModelObject> openstudio::model::AirLoopHVACOutdoorAirSystem::components | ( | ) | const |
Returns a vector that is the concatenation of oaComponents() and reliefComponents().
| AirflowNetworkDistributionNode openstudio::model::AirLoopHVACOutdoorAirSystem::getAirflowNetworkDistributionNode | ( | ) |
| ControllerOutdoorAir openstudio::model::AirLoopHVACOutdoorAirSystem::getControllerOutdoorAir | ( | ) | const |
Returns the ControllerOutdoorAir object associated with the AirLoopHVACOutdoorAirSystem.
|
static |
| boost::optional<ModelObject> openstudio::model::AirLoopHVACOutdoorAirSystem::mixedAirModelObject | ( | ) |
Returns the optional ModelObject attached to the mixer air port.
| unsigned openstudio::model::AirLoopHVACOutdoorAirSystem::mixedAirPort | ( | ) | const |
Returns the mixed air port.
| boost::optional<ModelObject> openstudio::model::AirLoopHVACOutdoorAirSystem::oaComponent | ( | openstudio::Handle | handle | ) |
Returns the optional ModelObject with the Handle given.
The optional will be false if the given handle does not correspond to the a ModelObject that is not part of the supply side of the outdoor air system.
| std::vector<ModelObject> openstudio::model::AirLoopHVACOutdoorAirSystem::oaComponents | ( | ) | const |
Returns a vector of model objects that are on the path of the incoming outdoor air stream.
| boost::optional<Node> openstudio::model::AirLoopHVACOutdoorAirSystem::outboardOANode | ( | ) | const |
Returns the most outboard outdoor air Node.
| boost::optional<Node> openstudio::model::AirLoopHVACOutdoorAirSystem::outboardReliefNode | ( | ) | const |
Returns the most outboard relief air Node.
| boost::optional<ModelObject> openstudio::model::AirLoopHVACOutdoorAirSystem::outdoorAirModelObject | ( | ) |
Returns the optional ModelObject attached to the outdoor air port.
| unsigned openstudio::model::AirLoopHVACOutdoorAirSystem::outdoorAirPort | ( | ) | const |
Returns the outdoor air port of the outdoor air mixer.
This is not the most outboard air node of the outdoor air system, rather it is the port directly attached to the mixer. There can be additional components between this port and the most outboard port.
| boost::optional<ModelObject> openstudio::model::AirLoopHVACOutdoorAirSystem::reliefAirModelObject | ( | ) |
Returns the optional ModelObject attached to the relief air port.
| unsigned openstudio::model::AirLoopHVACOutdoorAirSystem::reliefAirPort | ( | ) | const |
Returns the outdoor air port of the outdoor air system.
This is not the most outboard air node of the outdoor air system, rather it is the port directly attached to the mixer. There can be additional components between this port and the most outboard port.
| boost::optional<ModelObject> openstudio::model::AirLoopHVACOutdoorAirSystem::reliefComponent | ( | openstudio::Handle | handle | ) |
Returns the optional ModelObject with the Handle given.
The optional will be false if the given handle does not correspond to the a ModelObject that is not part of the supply side of the outdoor air system.
| std::vector<ModelObject> openstudio::model::AirLoopHVACOutdoorAirSystem::reliefComponents | ( | ) | const |
Returns a vector of model objects that are on the path of the outgoing relief air stream.
|
virtual |
| boost::optional<ModelObject> openstudio::model::AirLoopHVACOutdoorAirSystem::returnAirModelObject | ( | ) |
Returns the optional ModelObject attached to the return air port.
| unsigned openstudio::model::AirLoopHVACOutdoorAirSystem::returnAirPort | ( | ) | const |
Returns the return air port of the outdoor air system.
| bool openstudio::model::AirLoopHVACOutdoorAirSystem::setControllerOutdoorAir | ( | const ControllerOutdoorAir & | controllerOutdoorAir | ) |
Sets the ControllerOutdoorAir object associated with the AirLoopHVACOutdoorAirSystem.
|
related |
|
related |