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

#include <ControllerOutdoorAir.hpp>

+ Inheritance diagram for openstudio::model::ControllerOutdoorAir:

Public Member Functions

boost::optional
< AirflowNetworkOutdoorAirflow
airflowNetworkOutdoorAirflow () const
 
boost::optional
< AirLoopHVACOutdoorAirSystem
airLoopHVACOutdoorAirSystem () const
 
void applySizingValues ()
 
void autosize ()
 
boost::optional< double > autosizedMaximumOutdoorAirFlowRate () const
 
boost::optional< double > autosizedMinimumOutdoorAirFlowRate () const
 
void autosizeMaximumOutdoorAirFlowRate ()
 
void autosizeMinimumOutdoorAirFlowRate ()
 
ControllerMechanicalVentilation controllerMechanicalVentilation () const
 
 ControllerOutdoorAir (const Model &model)
 
 ControllerOutdoorAir (const ControllerOutdoorAir &other)=default
 
 ControllerOutdoorAir (ControllerOutdoorAir &&other)=default
 
AirflowNetworkOutdoorAirflow getAirflowNetworkOutdoorAirflow (const AirflowNetworkCrack &crack)
 
boost::optional< bool > getControlHighIndoorHumidityBasedOnOutdoorHumidityRatio () const
 
std::string getEconomizerControlActionType () const
 
std::string getEconomizerControlType () const
 
boost::optional< double > getEconomizerMaximumLimitDewpointTemperature () const
 
boost::optional< double > getEconomizerMaximumLimitDryBulbTemperature () const
 
boost::optional< double > getEconomizerMaximumLimitEnthalpy () const
 
boost::optional< double > getEconomizerMinimumLimitDryBulbTemperature () const
 
boost::optional< std::string > getHeatRecoveryBypassControlType () const
 
boost::optional< bool > getHighHumidityControl () const
 
boost::optional< double > getHighHumidityOutdoorAirFlowRatio () const
 
std::string getLockoutType () const
 
std::string getMinimumLimitType () const
 
bool isMaximumOutdoorAirFlowRateAutosized () const
 
bool isMinimumOutdoorAirFlowRateAutosized () const
 
boost::optional< SchedulemaximumFractionofOutdoorAirSchedule () const
 
boost::optional< double > maximumOutdoorAirFlowRate () const
 
boost::optional< ScheduleminimumFractionofOutdoorAirSchedule () const
 
boost::optional< double > minimumOutdoorAirFlowRate () const
 
boost::optional< ScheduleminimumOutdoorAirSchedule () const
 
ControllerOutdoorAiroperator= (const ControllerOutdoorAir &)=default
 
ControllerOutdoorAiroperator= (ControllerOutdoorAir &&)=default
 
virtual std::vector
< openstudio::IdfObject > 
remove ()
 
void resetEconomizerMaximumLimitDewpointTemperature ()
 
void resetEconomizerMaximumLimitDryBulbTemperature ()
 
void resetEconomizerMaximumLimitEnthalpy ()
 
void resetEconomizerMinimumLimitDryBulbTemperature ()
 
void resetMaximumFractionofOutdoorAirSchedule ()
 
void resetMinimumFractionofOutdoorAirSchedule ()
 
void resetMinimumOutdoorAirSchedule ()
 
void resetTimeofDayEconomizerControlSchedule ()
 
bool setControlHighIndoorHumidityBasedOnOutdoorHumidityRatio (bool v)
 
bool setControllerMechanicalVentilation (const ControllerMechanicalVentilation &controllerMechanicalVentilation)
 
bool setEconomizerControlActionType (const std::string &value)
 
bool setEconomizerControlType (const std::string &value)
 
bool setEconomizerMaximumLimitDewpointTemperature (double value)
 
bool setEconomizerMaximumLimitDryBulbTemperature (double value)
 
bool setEconomizerMaximumLimitEnthalpy (double value)
 
bool setEconomizerMinimumLimitDryBulbTemperature (double value)
 
bool setHeatRecoveryBypassControlType (const std::string &v)
 
bool setHighHumidityControl (bool val)
 
bool setHighHumidityOutdoorAirFlowRatio (double v)
 
bool setLockoutType (const std::string &value)
 
bool setMaximumFractionofOutdoorAirSchedule (Schedule &schedule)
 
bool setMaximumOutdoorAirFlowRate (double maximumOutdoorAirFlowRate)
 
bool setMinimumFractionofOutdoorAirSchedule (Schedule &schedule)
 
bool setMinimumLimitType (const std::string &value)
 
bool setMinimumOutdoorAirFlowRate (double minimumOutdoorAirFlowRate)
 
bool setMinimumOutdoorAirSchedule (Schedule &schedule)
 
bool setTimeofDayEconomizerControlSchedule (Schedule &schedule)
 
boost::optional< ScheduletimeofDayEconomizerControlSchedule () const
 
virtual ~ControllerOutdoorAir ()=default
 
- 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...
 
ParentObjectoperator= (const ParentObject &)=default
 
ParentObjectoperator= (ParentObject &&)=default
 
 ParentObject (const ParentObject &other)=default
 
 ParentObject (ParentObject &&other)=default
 
virtual ~ParentObject ()=default
 
- Public Member Functions inherited from openstudio::model::ModelObject
virtual ~ModelObject ()=default
 
 ModelObject (const ModelObject &other)=default
 
 ModelObject (ModelObject &&other)=default
 
ModelObjectoperator= (const ModelObject &)=default
 
ModelObjectoperator= (ModelObject &&)=default
 
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...
 
boost::optional< std::string > cadObjectId () const
 
bool setCADObjectId (const std::string &cadObjectId)
 
boost::optional< std::string > gbXMLId () const
 
bool setGBXMLId (const std::string &gbXMLId)
 
boost::optional< std::string > displayName () const
 
bool setDisplayName (const std::string &displayName)
 
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 (const std::string &valueName, const std::string &units) 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 ()
 

Protected Types

using ImplType = detail::ControllerOutdoorAir_Impl
 
- Protected Types inherited from openstudio::model::ModelObject
using ImplType = detail::ModelObject_Impl
 

Protected Member Functions

 ControllerOutdoorAir (std::shared_ptr< detail::ControllerOutdoorAir_Impl > 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)
 

Additional Inherited Members

Member Typedef Documentation

using openstudio::model::ControllerOutdoorAir::ImplType = detail::ControllerOutdoorAir_Impl
protected

Constructor & Destructor Documentation

openstudio::model::ControllerOutdoorAir::ControllerOutdoorAir ( const Model model)
explicit
virtual openstudio::model::ControllerOutdoorAir::~ControllerOutdoorAir ( )
virtualdefault
openstudio::model::ControllerOutdoorAir::ControllerOutdoorAir ( const ControllerOutdoorAir other)
default
openstudio::model::ControllerOutdoorAir::ControllerOutdoorAir ( ControllerOutdoorAir &&  other)
default
openstudio::model::ControllerOutdoorAir::ControllerOutdoorAir ( std::shared_ptr< detail::ControllerOutdoorAir_Impl >  impl)
explicitprotected

Member Function Documentation

boost::optional<AirflowNetworkOutdoorAirflow> openstudio::model::ControllerOutdoorAir::airflowNetworkOutdoorAirflow ( ) const
boost::optional<AirLoopHVACOutdoorAirSystem> openstudio::model::ControllerOutdoorAir::airLoopHVACOutdoorAirSystem ( ) const
void openstudio::model::ControllerOutdoorAir::applySizingValues ( )
void openstudio::model::ControllerOutdoorAir::autosize ( )
boost::optional<double> openstudio::model::ControllerOutdoorAir::autosizedMaximumOutdoorAirFlowRate ( ) const
boost::optional<double> openstudio::model::ControllerOutdoorAir::autosizedMinimumOutdoorAirFlowRate ( ) const
void openstudio::model::ControllerOutdoorAir::autosizeMaximumOutdoorAirFlowRate ( )
void openstudio::model::ControllerOutdoorAir::autosizeMinimumOutdoorAirFlowRate ( )
ControllerMechanicalVentilation openstudio::model::ControllerOutdoorAir::controllerMechanicalVentilation ( ) const
AirflowNetworkOutdoorAirflow openstudio::model::ControllerOutdoorAir::getAirflowNetworkOutdoorAirflow ( const AirflowNetworkCrack crack)
boost::optional<bool> openstudio::model::ControllerOutdoorAir::getControlHighIndoorHumidityBasedOnOutdoorHumidityRatio ( ) const
std::string openstudio::model::ControllerOutdoorAir::getEconomizerControlActionType ( ) const
std::string openstudio::model::ControllerOutdoorAir::getEconomizerControlType ( ) const
boost::optional<double> openstudio::model::ControllerOutdoorAir::getEconomizerMaximumLimitDewpointTemperature ( ) const
boost::optional<double> openstudio::model::ControllerOutdoorAir::getEconomizerMaximumLimitDryBulbTemperature ( ) const
boost::optional<double> openstudio::model::ControllerOutdoorAir::getEconomizerMaximumLimitEnthalpy ( ) const
boost::optional<double> openstudio::model::ControllerOutdoorAir::getEconomizerMinimumLimitDryBulbTemperature ( ) const
boost::optional<std::string> openstudio::model::ControllerOutdoorAir::getHeatRecoveryBypassControlType ( ) const
boost::optional<bool> openstudio::model::ControllerOutdoorAir::getHighHumidityControl ( ) const
boost::optional<double> openstudio::model::ControllerOutdoorAir::getHighHumidityOutdoorAirFlowRatio ( ) const
std::string openstudio::model::ControllerOutdoorAir::getLockoutType ( ) const
std::string openstudio::model::ControllerOutdoorAir::getMinimumLimitType ( ) const
static IddObjectType openstudio::model::ControllerOutdoorAir::iddObjectType ( )
static
bool openstudio::model::ControllerOutdoorAir::isMaximumOutdoorAirFlowRateAutosized ( ) const
bool openstudio::model::ControllerOutdoorAir::isMinimumOutdoorAirFlowRateAutosized ( ) const
boost::optional<Schedule> openstudio::model::ControllerOutdoorAir::maximumFractionofOutdoorAirSchedule ( ) const
boost::optional<double> openstudio::model::ControllerOutdoorAir::maximumOutdoorAirFlowRate ( ) const
boost::optional<Schedule> openstudio::model::ControllerOutdoorAir::minimumFractionofOutdoorAirSchedule ( ) const
boost::optional<double> openstudio::model::ControllerOutdoorAir::minimumOutdoorAirFlowRate ( ) const
boost::optional<Schedule> openstudio::model::ControllerOutdoorAir::minimumOutdoorAirSchedule ( ) const
ControllerOutdoorAir& openstudio::model::ControllerOutdoorAir::operator= ( const ControllerOutdoorAir )
default
ControllerOutdoorAir& openstudio::model::ControllerOutdoorAir::operator= ( ControllerOutdoorAir &&  )
default
virtual std::vector<openstudio::IdfObject> openstudio::model::ControllerOutdoorAir::remove ( )
virtual
void openstudio::model::ControllerOutdoorAir::resetEconomizerMaximumLimitDewpointTemperature ( )
void openstudio::model::ControllerOutdoorAir::resetEconomizerMaximumLimitDryBulbTemperature ( )
void openstudio::model::ControllerOutdoorAir::resetEconomizerMaximumLimitEnthalpy ( )
void openstudio::model::ControllerOutdoorAir::resetEconomizerMinimumLimitDryBulbTemperature ( )
void openstudio::model::ControllerOutdoorAir::resetMaximumFractionofOutdoorAirSchedule ( )
void openstudio::model::ControllerOutdoorAir::resetMinimumFractionofOutdoorAirSchedule ( )
void openstudio::model::ControllerOutdoorAir::resetMinimumOutdoorAirSchedule ( )
void openstudio::model::ControllerOutdoorAir::resetTimeofDayEconomizerControlSchedule ( )
bool openstudio::model::ControllerOutdoorAir::setControlHighIndoorHumidityBasedOnOutdoorHumidityRatio ( bool  v)
bool openstudio::model::ControllerOutdoorAir::setControllerMechanicalVentilation ( const ControllerMechanicalVentilation controllerMechanicalVentilation)
bool openstudio::model::ControllerOutdoorAir::setEconomizerControlActionType ( const std::string &  value)
bool openstudio::model::ControllerOutdoorAir::setEconomizerControlType ( const std::string &  value)
bool openstudio::model::ControllerOutdoorAir::setEconomizerMaximumLimitDewpointTemperature ( double  value)
bool openstudio::model::ControllerOutdoorAir::setEconomizerMaximumLimitDryBulbTemperature ( double  value)
bool openstudio::model::ControllerOutdoorAir::setEconomizerMaximumLimitEnthalpy ( double  value)
bool openstudio::model::ControllerOutdoorAir::setEconomizerMinimumLimitDryBulbTemperature ( double  value)
bool openstudio::model::ControllerOutdoorAir::setHeatRecoveryBypassControlType ( const std::string &  v)
bool openstudio::model::ControllerOutdoorAir::setHighHumidityControl ( bool  val)
bool openstudio::model::ControllerOutdoorAir::setHighHumidityOutdoorAirFlowRatio ( double  v)
bool openstudio::model::ControllerOutdoorAir::setLockoutType ( const std::string &  value)
bool openstudio::model::ControllerOutdoorAir::setMaximumFractionofOutdoorAirSchedule ( Schedule schedule)
bool openstudio::model::ControllerOutdoorAir::setMaximumOutdoorAirFlowRate ( double  maximumOutdoorAirFlowRate)
bool openstudio::model::ControllerOutdoorAir::setMinimumFractionofOutdoorAirSchedule ( Schedule schedule)
bool openstudio::model::ControllerOutdoorAir::setMinimumLimitType ( const std::string &  value)
bool openstudio::model::ControllerOutdoorAir::setMinimumOutdoorAirFlowRate ( double  minimumOutdoorAirFlowRate)
bool openstudio::model::ControllerOutdoorAir::setMinimumOutdoorAirSchedule ( Schedule schedule)
bool openstudio::model::ControllerOutdoorAir::setTimeofDayEconomizerControlSchedule ( Schedule schedule)
boost::optional<Schedule> openstudio::model::ControllerOutdoorAir::timeofDayEconomizerControlSchedule ( ) const