OpenStudio:model
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Static Public Member Functions | Related Functions | List of all members
openstudio::model::AirTerminalDualDuctVAVOutdoorAir Class Reference

#include <AirTerminalDualDuctVAVOutdoorAir.hpp>

+ Inheritance diagram for openstudio::model::AirTerminalDualDuctVAVOutdoorAir:

Public Member Functions

Constructors and Destructors
 AirTerminalDualDuctVAVOutdoorAir (const Model &model)
 
virtual ~AirTerminalDualDuctVAVOutdoorAir ()
 
Getters
Schedule availabilitySchedule () const
 
boost::optional< double > maximumTerminalAirFlowRate () const
 
bool isMaximumTerminalAirFlowRateAutosized () const
 
std::string perPersonVentilationRateMode () const
 
Setters
bool setAvailabilitySchedule (Schedule &schedule)
 
bool setMaximumTerminalAirFlowRate (double maximumTerminalAirFlowRate)
 
void autosizeMaximumTerminalAirFlowRate ()
 
bool controlForOutdoorAir () const
 If true, OpenStudio will attach the DesignSpecificationOutdoorAir object associated with the terminal's zone on export to EnergyPlus idf format. More...
 
bool setControlForOutdoorAir (bool controlForOutdoorAir)
 
bool setPerPersonVentilationRateMode (const std::string &perPersonVentilationRateMode)
 
boost::optional< NodeoutdoorAirInletNode () const
 This corresponds to Mixer::inletModelObject(0), as well as the system's branch 0 (ie. More...
 
boost::optional< NoderecirculatedAirInletNode () const
 This corresponds to Mixer::inletModelObject(1), as well as the system's branch 1 (ie. More...
 
Other
boost::optional< double > autosizedMaximumTerminalAirFlowRate () const
 
- Public Member Functions inherited from openstudio::model::Mixer
virtual unsigned branchIndexForInletModelObject (ModelObject modelObject) const
 Returns the branch index for the ModelObject specified by modelObject. More...
 
virtual boost::optional
< ModelObject
inletModelObject (unsigned branchIndex) const
 Returns the optional ModelObject connected to the branch designated by branchIndex. More...
 
virtual std::vector< ModelObjectinletModelObjects () const
 Returns a vector of all objects connected to the mixer's inlet ports. More...
 
virtual unsigned inletPort (unsigned branchIndex) const
 Returns the inlet port for branchIndex. More...
 
bool isRemovable () const
 
virtual boost::optional
< ModelObject
lastInletModelObject () const
 Returns the optional ModelObject connected to the last branch of the mixer. More...
 
virtual unsigned newInletPortAfterBranch (unsigned branchIndex)
 Returns a new port after the branch specified by branchIndex. More...
 
virtual unsigned nextBranchIndex () const
 Returns the index of the next available branch. More...
 
virtual unsigned nextInletPort () const
 Returns the next available inlet port. More...
 
virtual boost::optional
< ModelObject
outletModelObject () const
 Returns the optional ModelObject connected to the outlet port. More...
 
virtual unsigned outletPort () const
 Returns the outlet port to the zone mixer. More...
 
virtual void removePortForBranch (unsigned branchIndex)
 Effectively disconnects anything connected to the inlet port at the specified branch index. More...
 
virtual ~Mixer ()
 
- 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< AirLoopHVACairLoopHVAC () 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< HVACComponentcontainingHVACComponent () 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< Looploop () const
 Returns the optional Loop object that the HVAC component is attached to. More...
 
boost::optional< PlantLoopplantLoop () 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< ModelObjectchildren () 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< ParentObjectparent () const
 Return this object's parent in the hierarchy, if it has one. More...
 
std::vector< ResourceObjectresources () 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< OutputVariableoutputVariables () 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< LifeCycleCostlifeCycleCosts () 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< ScheduleTypeKeygetScheduleTypeKeys (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< ModelObjectconnectedObject (unsigned port) const
 
boost::optional< unsigned > connectedObjectPort (unsigned port) const
 

Static Public Member Functions

static IddObjectType iddObjectType ()
 
static std::vector< std::string > perPersonVentilationRateModeValues ()
 

Related Functions

(Note that these are not member functions.)

typedef std::vector
< AirTerminalDualDuctVAVOutdoorAir
AirTerminalDualDuctVAVOutdoorAirVector
 
typedef boost::optional
< AirTerminalDualDuctVAVOutdoorAir
OptionalAirTerminalDualDuctVAVOutdoorAir
 

Additional Inherited Members

- Protected Types inherited from openstudio::model::Mixer
typedef detail::Mixer_Impl ImplType
 
- 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 Member Functions inherited from openstudio::model::Mixer
 Mixer (IddObjectType type, const Model &model)
 
 Mixer (std::shared_ptr< ImplType > impl)
 
- Protected Member Functions inherited from openstudio::model::HVACComponent
virtual std::vector< ModelObjectchildren () 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)
 

Detailed Description

AirTerminalDualDuctVAVOutdoorAir is a Mixer that wraps the OpenStudio IDD object 'OS:AirTerminal:DualDuct:VAV:OutdoorAir'.

Constructor & Destructor Documentation

openstudio::model::AirTerminalDualDuctVAVOutdoorAir::AirTerminalDualDuctVAVOutdoorAir ( const Model model)
explicit
virtual openstudio::model::AirTerminalDualDuctVAVOutdoorAir::~AirTerminalDualDuctVAVOutdoorAir ( )
inlinevirtual

Member Function Documentation

boost::optional<double> openstudio::model::AirTerminalDualDuctVAVOutdoorAir::autosizedMaximumTerminalAirFlowRate ( ) const
void openstudio::model::AirTerminalDualDuctVAVOutdoorAir::autosizeMaximumTerminalAirFlowRate ( )
Schedule openstudio::model::AirTerminalDualDuctVAVOutdoorAir::availabilitySchedule ( ) const
bool openstudio::model::AirTerminalDualDuctVAVOutdoorAir::controlForOutdoorAir ( ) const

If true, OpenStudio will attach the DesignSpecificationOutdoorAir object associated with the terminal's zone on export to EnergyPlus idf format.

This field replaces the functionality of the EnergyPlus field: Design Specification Outdoor Air Object Name.

static IddObjectType openstudio::model::AirTerminalDualDuctVAVOutdoorAir::iddObjectType ( )
static
bool openstudio::model::AirTerminalDualDuctVAVOutdoorAir::isMaximumTerminalAirFlowRateAutosized ( ) const
boost::optional<double> openstudio::model::AirTerminalDualDuctVAVOutdoorAir::maximumTerminalAirFlowRate ( ) const
boost::optional<Node> openstudio::model::AirTerminalDualDuctVAVOutdoorAir::outdoorAirInletNode ( ) const

This corresponds to Mixer::inletModelObject(0), as well as the system's branch 0 (ie.

AirLoopHVAC::demandInletNodes()[0] and AirLoopHVAC::supplyOutletNodes()[0]) In OpenStudio we avoid using hot / cold nomenclature in the dual duct system api, but here in the terminal interface we use the language for transparency with the idf.

std::string openstudio::model::AirTerminalDualDuctVAVOutdoorAir::perPersonVentilationRateMode ( ) const
static std::vector<std::string> openstudio::model::AirTerminalDualDuctVAVOutdoorAir::perPersonVentilationRateModeValues ( )
static
boost::optional<Node> openstudio::model::AirTerminalDualDuctVAVOutdoorAir::recirculatedAirInletNode ( ) const

This corresponds to Mixer::inletModelObject(1), as well as the system's branch 1 (ie.

AirLoopHVAC::demandInletNodes()[1] and AirLoopHVAC::supplyOutletNodes()[1])

bool openstudio::model::AirTerminalDualDuctVAVOutdoorAir::setAvailabilitySchedule ( Schedule schedule)
bool openstudio::model::AirTerminalDualDuctVAVOutdoorAir::setControlForOutdoorAir ( bool  controlForOutdoorAir)
bool openstudio::model::AirTerminalDualDuctVAVOutdoorAir::setMaximumTerminalAirFlowRate ( double  maximumTerminalAirFlowRate)
bool openstudio::model::AirTerminalDualDuctVAVOutdoorAir::setPerPersonVentilationRateMode ( const std::string &  perPersonVentilationRateMode)

Friends And Related Function Documentation