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

#include <AvailabilityManagerHybridVentilation.hpp>

+ Inheritance diagram for openstudio::model::AvailabilityManagerHybridVentilation:

Public Member Functions

Constructors and Destructors
 AvailabilityManagerHybridVentilation (const Model &model)
 
 AvailabilityManagerHybridVentilation (const Model &model, Schedule &ventilationControlModeSchedule, Schedule &minimumOutdoorVentilationAirSchedule)
 
virtual ~AvailabilityManagerHybridVentilation ()=default
 
 AvailabilityManagerHybridVentilation (const AvailabilityManagerHybridVentilation &other)=default
 
 AvailabilityManagerHybridVentilation (AvailabilityManagerHybridVentilation &&other)=default
 
AvailabilityManagerHybridVentilationoperator= (const AvailabilityManagerHybridVentilation &)=default
 
AvailabilityManagerHybridVentilationoperator= (AvailabilityManagerHybridVentilation &&)=default
 
Getters
boost::optional< ThermalZonecontrolledZone () const
 
Schedule ventilationControlModeSchedule () const
 
bool useWeatherFileRainIndicators () const
 
double maximumWindSpeed () const
 
double minimumOutdoorTemperature () const
 
double maximumOutdoorTemperature () const
 
double minimumOutdoorEnthalpy () const
 
double maximumOutdoorEnthalpy () const
 
double minimumOutdoorDewpoint () const
 
double maximumOutdoorDewpoint () const
 
double minimumHVACOperationTime () const
 
double minimumVentilationTime () const
 
Schedule minimumOutdoorVentilationAirSchedule () const
 
boost::optional< CurveopeningFactorFunctionofWindSpeedCurve () const
 
boost::optional< ScheduleairflowNetworkControlTypeSchedule () const
 
boost::optional< SchedulesimpleAirflowControlTypeSchedule () const
 
boost::optional< ModelObjectzoneVentilationObject () const
 
Setters
bool setControlledZone (const ThermalZone &thermalZone)
 
void resetControlledZone ()
 
bool setVentilationControlModeSchedule (Schedule &schedule)
 
bool setUseWeatherFileRainIndicators (bool useWeatherFileRainIndicators)
 
bool setMaximumWindSpeed (double maximumWindSpeed)
 
bool setMinimumOutdoorTemperature (double minimumOutdoorTemperature)
 
bool setMaximumOutdoorTemperature (double maximumOutdoorTemperature)
 
bool setMinimumOutdoorEnthalpy (double minimumOutdoorEnthalpy)
 
bool setMaximumOutdoorEnthalpy (double maximumOutdoorEnthalpy)
 
bool setMinimumOutdoorDewpoint (double minimumOutdoorDewpoint)
 
bool setMaximumOutdoorDewpoint (double maximumOutdoorDewpoint)
 
bool setMinimumOutdoorVentilationAirSchedule (Schedule &schedule)
 
bool setOpeningFactorFunctionofWindSpeedCurve (const Curve &curve)
 
void resetOpeningFactorFunctionofWindSpeedCurve ()
 
bool setMinimumHVACOperationTime (double minimumHVACOperationTime)
 
bool setMinimumVentilationTime (double minimumVentilationTime)
 
bool setAirflowNetworkControlTypeSchedule (Schedule &schedule)
 
void resetAirflowNetworkControlTypeSchedule ()
 
bool setSimpleAirflowControlTypeSchedule (Schedule &schedule)
 
void resetSimpleAirflowControlTypeSchedule ()
 
bool setZoneVentilationObject (const ModelObject &zv)
 
void resetZoneVentilationObject ()
 
- Public Member Functions inherited from openstudio::model::AvailabilityManager
 AvailabilityManager (IddObjectType type, const Model &model)
 
 AvailabilityManager (const AvailabilityManager &other)=default
 
 AvailabilityManager (AvailabilityManager &&other)=default
 
boost::optional< Looploop () const
 
AvailabilityManageroperator= (const AvailabilityManager &)=default
 
AvailabilityManageroperator= (AvailabilityManager &&)=default
 
virtual ~AvailabilityManager ()=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 ()
 

Related Functions

(Note that these are not member functions.)

using AvailabilityManagerHybridVentilationVector = std::vector< AvailabilityManagerHybridVentilation >
 
using OptionalAvailabilityManagerHybridVentilation = boost::optional< AvailabilityManagerHybridVentilation >
 

Additional Inherited Members

- Protected Types inherited from openstudio::model::ModelObject
using ImplType = detail::ModelObject_Impl
 
- 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

AvailabilityManagerHybridVentilation is a ModelObject that wraps the OpenStudio IDD object 'OS:AvailabilityManager:HybridVentilation'.

Constructor & Destructor Documentation

openstudio::model::AvailabilityManagerHybridVentilation::AvailabilityManagerHybridVentilation ( const Model model)
explicit
openstudio::model::AvailabilityManagerHybridVentilation::AvailabilityManagerHybridVentilation ( const Model model,
Schedule ventilationControlModeSchedule,
Schedule minimumOutdoorVentilationAirSchedule 
)
explicit
virtual openstudio::model::AvailabilityManagerHybridVentilation::~AvailabilityManagerHybridVentilation ( )
virtualdefault
openstudio::model::AvailabilityManagerHybridVentilation::AvailabilityManagerHybridVentilation ( const AvailabilityManagerHybridVentilation other)
default
openstudio::model::AvailabilityManagerHybridVentilation::AvailabilityManagerHybridVentilation ( AvailabilityManagerHybridVentilation &&  other)
default

Member Function Documentation

boost::optional<Schedule> openstudio::model::AvailabilityManagerHybridVentilation::airflowNetworkControlTypeSchedule ( ) const
boost::optional<ThermalZone> openstudio::model::AvailabilityManagerHybridVentilation::controlledZone ( ) const
static IddObjectType openstudio::model::AvailabilityManagerHybridVentilation::iddObjectType ( )
static
double openstudio::model::AvailabilityManagerHybridVentilation::maximumOutdoorDewpoint ( ) const
double openstudio::model::AvailabilityManagerHybridVentilation::maximumOutdoorEnthalpy ( ) const
double openstudio::model::AvailabilityManagerHybridVentilation::maximumOutdoorTemperature ( ) const
double openstudio::model::AvailabilityManagerHybridVentilation::maximumWindSpeed ( ) const
double openstudio::model::AvailabilityManagerHybridVentilation::minimumHVACOperationTime ( ) const
double openstudio::model::AvailabilityManagerHybridVentilation::minimumOutdoorDewpoint ( ) const
double openstudio::model::AvailabilityManagerHybridVentilation::minimumOutdoorEnthalpy ( ) const
double openstudio::model::AvailabilityManagerHybridVentilation::minimumOutdoorTemperature ( ) const
Schedule openstudio::model::AvailabilityManagerHybridVentilation::minimumOutdoorVentilationAirSchedule ( ) const
double openstudio::model::AvailabilityManagerHybridVentilation::minimumVentilationTime ( ) const
boost::optional<Curve> openstudio::model::AvailabilityManagerHybridVentilation::openingFactorFunctionofWindSpeedCurve ( ) const
AvailabilityManagerHybridVentilation& openstudio::model::AvailabilityManagerHybridVentilation::operator= ( const AvailabilityManagerHybridVentilation )
default
AvailabilityManagerHybridVentilation& openstudio::model::AvailabilityManagerHybridVentilation::operator= ( AvailabilityManagerHybridVentilation &&  )
default
void openstudio::model::AvailabilityManagerHybridVentilation::resetAirflowNetworkControlTypeSchedule ( )
void openstudio::model::AvailabilityManagerHybridVentilation::resetControlledZone ( )
void openstudio::model::AvailabilityManagerHybridVentilation::resetOpeningFactorFunctionofWindSpeedCurve ( )
void openstudio::model::AvailabilityManagerHybridVentilation::resetSimpleAirflowControlTypeSchedule ( )
void openstudio::model::AvailabilityManagerHybridVentilation::resetZoneVentilationObject ( )
bool openstudio::model::AvailabilityManagerHybridVentilation::setAirflowNetworkControlTypeSchedule ( Schedule schedule)
bool openstudio::model::AvailabilityManagerHybridVentilation::setControlledZone ( const ThermalZone thermalZone)
bool openstudio::model::AvailabilityManagerHybridVentilation::setMaximumOutdoorDewpoint ( double  maximumOutdoorDewpoint)
bool openstudio::model::AvailabilityManagerHybridVentilation::setMaximumOutdoorEnthalpy ( double  maximumOutdoorEnthalpy)
bool openstudio::model::AvailabilityManagerHybridVentilation::setMaximumOutdoorTemperature ( double  maximumOutdoorTemperature)
bool openstudio::model::AvailabilityManagerHybridVentilation::setMaximumWindSpeed ( double  maximumWindSpeed)
bool openstudio::model::AvailabilityManagerHybridVentilation::setMinimumHVACOperationTime ( double  minimumHVACOperationTime)
bool openstudio::model::AvailabilityManagerHybridVentilation::setMinimumOutdoorDewpoint ( double  minimumOutdoorDewpoint)
bool openstudio::model::AvailabilityManagerHybridVentilation::setMinimumOutdoorEnthalpy ( double  minimumOutdoorEnthalpy)
bool openstudio::model::AvailabilityManagerHybridVentilation::setMinimumOutdoorTemperature ( double  minimumOutdoorTemperature)
bool openstudio::model::AvailabilityManagerHybridVentilation::setMinimumOutdoorVentilationAirSchedule ( Schedule schedule)
bool openstudio::model::AvailabilityManagerHybridVentilation::setMinimumVentilationTime ( double  minimumVentilationTime)
bool openstudio::model::AvailabilityManagerHybridVentilation::setOpeningFactorFunctionofWindSpeedCurve ( const Curve curve)
bool openstudio::model::AvailabilityManagerHybridVentilation::setSimpleAirflowControlTypeSchedule ( Schedule schedule)
bool openstudio::model::AvailabilityManagerHybridVentilation::setUseWeatherFileRainIndicators ( bool  useWeatherFileRainIndicators)
bool openstudio::model::AvailabilityManagerHybridVentilation::setVentilationControlModeSchedule ( Schedule schedule)
bool openstudio::model::AvailabilityManagerHybridVentilation::setZoneVentilationObject ( const ModelObject zv)
boost::optional<Schedule> openstudio::model::AvailabilityManagerHybridVentilation::simpleAirflowControlTypeSchedule ( ) const
bool openstudio::model::AvailabilityManagerHybridVentilation::useWeatherFileRainIndicators ( ) const
Schedule openstudio::model::AvailabilityManagerHybridVentilation::ventilationControlModeSchedule ( ) const
boost::optional<ModelObject> openstudio::model::AvailabilityManagerHybridVentilation::zoneVentilationObject ( ) const

Friends And Related Function Documentation