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

#include <ClimateZones.hpp>

+ Inheritance diagram for openstudio::model::ClimateZone:

Public Member Functions

Getters
std::string institution () const
 The institution that defines this climate zone designation. More...
 
std::string documentName () const
 The name of the document that defines this climate zone designation. More...
 
unsigned year () const
 The year of the document. More...
 
std::string value () const
 The actual climate zone designation. More...
 
Setters
bool setValue (const std::string &value)
 
bool setType (const std::string &institution, const std::string &documentName, unsigned year)
 
bool setTypeAndValue (const std::string &institution, const std::string &documentName, unsigned year, const std::string &value)
 
- Public Member Functions inherited from openstudio::model::ModelExtensibleGroup
 ModelExtensibleGroup (const ModelExtensibleGroup &other)=default
 
 ModelExtensibleGroup (ModelExtensibleGroup &&other)=default
 
ModelExtensibleGroupoperator= (const ModelExtensibleGroup &)=default
 
ModelExtensibleGroupoperator= (ModelExtensibleGroup &&)=default
 
virtual ~ModelExtensibleGroup ()=default
 
template<typename T >
boost::optional< T > getModelObjectTarget (unsigned fieldIndex) const
 Get the ModelObject of type T pointed to from fieldIndex of this extensible group, if possible. More...
 
template<typename T >
std::vector< T > getModelObjectTargets () const
 Get all the ModelObjects of type T pointed to from this extensible group. More...
 
bool setSchedule (unsigned index, const std::string &className, const std::string &scheduleDisplayName, Schedule &schedule)
 Sets index to point to schedule if schedule's ScheduleTypeLimits are compatible with the ScheduleType in the ScheduleTypeRegistry for (className,scheduleDisplayName), or if schedule's ScheduleTypeLimits have not yet been set (in which case the ScheduleTypeRegistry is used to retrieve or create an appropriate one). More...
 

Related Functions

(Note that these are not member functions.)

using ClimateZoneVector = std::vector< ClimateZone >
 

Detailed Description

ClimateZone is a ModelExtensibleGroup that represents a single climate zone definition contained in the unique ClimateZones ModelObject.

Member Function Documentation

std::string openstudio::model::ClimateZone::documentName ( ) const

The name of the document that defines this climate zone designation.

"Standard 169", etc.

std::string openstudio::model::ClimateZone::institution ( ) const

The institution that defines this climate zone designation.

Typically this is "ASHRAE" or "CEC".

bool openstudio::model::ClimateZone::setType ( const std::string &  institution,
const std::string &  documentName,
unsigned  year 
)
bool openstudio::model::ClimateZone::setTypeAndValue ( const std::string &  institution,
const std::string &  documentName,
unsigned  year,
const std::string &  value 
)
bool openstudio::model::ClimateZone::setValue ( const std::string &  value)
std::string openstudio::model::ClimateZone::value ( ) const

The actual climate zone designation.

"4C", "15", etc.

unsigned openstudio::model::ClimateZone::year ( ) const

The year of the document.

Together with institution and documentName, this provides a fairly complete citation, which implicitly defines the allowable values.

Friends And Related Function Documentation

using ClimateZoneVector = std::vector<ClimateZone>
related