#include "ClimateZones.hpp"
Public Member Functions | |
virtual | ~ClimateZones () |
boost::optional< Site > | site () const |
std::vector< ClimateZone > | climateZones () const |
ClimateZone | getClimateZone (unsigned index) const |
ClimateZone | getClimateZone (const std::string &institution, unsigned year) const |
std::vector< ClimateZone > | getClimateZones (const std::string &institution) const |
bool | clear () |
ClimateZone | setClimateZone (const std::string &institution, const std::string &value) |
ClimateZone | setClimateZone (const std::string &institution, unsigned year, const std::string &value) |
ClimateZone | appendClimateZone (const std::string &institution) |
ClimateZone | appendClimateZone (const std::string &institution, const std::string &value) |
ClimateZone | appendClimateZone (const std::string &institution, unsigned year, const std::string &value) |
ClimateZone | appendClimateZone (const std::string &institution, const std::string documentName, unsigned year, const std::string &value) |
unsigned | numClimateZones () const |
Static Public Member Functions | |
static std::string | ashraeInstitutionName () |
static std::string | ashraeDocumentName () |
static unsigned | ashraeDefaultYear () |
static std::string | cecInstitutionName () |
static std::string | cecDocumentName () |
static unsigned | cecDefaultYear () |
static std::string | getDefaultDocumentName (const std::string &institution) |
static unsigned | getDefaultYear (const std::string &institution) |
static std::vector< std::string > | validClimateZoneValues (const std::string &institution, unsigned year) |
static IddObjectType | iddObjectType () |
Related Functions | |
typedef boost::optional < ClimateZones > | OptionalClimateZones |
ClimateZones is a unque ModelObject that wraps the OpenStudio IDD object 'OS:ClimateZones'.
As a location identifier, it is a child of Site. ClimateZones was added to support building energy standards like Title 24 and ASHRAE 90.1, which list different requirements based on the climate zone locations of buildings. Since a given building may be evaluated against multiple standards, multiple climate zones may be specified for a given model.
|
inlinevirtual |
ClimateZone openstudio::model::ClimateZones::appendClimateZone | ( | const std::string & | institution | ) |
Creates and returns a new climate zone definition for institution.
Attempts to provide a default document name and year, leaves the value blank.
ClimateZone openstudio::model::ClimateZones::appendClimateZone | ( | const std::string & | institution, |
const std::string & | value | ||
) |
Creates and returns a new climate zone definition for institution, with value.
Attempts to provide a default document name and year.
ClimateZone openstudio::model::ClimateZones::appendClimateZone | ( | const std::string & | institution, |
unsigned | year, | ||
const std::string & | value | ||
) |
Creates and returns a new climate zone definition.
Attempts to provide a default document name.
ClimateZone openstudio::model::ClimateZones::appendClimateZone | ( | const std::string & | institution, |
const std::string | documentName, | ||
unsigned | year, | ||
const std::string & | value | ||
) |
Creates and returns a new climate zone definition.
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
bool openstudio::model::ClimateZones::clear | ( | ) |
Clear all ClimateZone definitions.
std::vector<ClimateZone> openstudio::model::ClimateZones::climateZones | ( | ) | const |
Return the individual climate zone definitions, with each one wrapped up as a ClimateZone ModelExtensibleGroup.
ClimateZone openstudio::model::ClimateZones::getClimateZone | ( | unsigned | index | ) | const |
Return the ClimateZone definition at extensible group index.
ClimateZone openstudio::model::ClimateZones::getClimateZone | ( | const std::string & | institution, |
unsigned | year | ||
) | const |
Return the ClimateZone definition for institution and year.
The return value will be .empty() if no such ClimateZone is found.
std::vector<ClimateZone> openstudio::model::ClimateZones::getClimateZones | ( | const std::string & | institution | ) | const |
Return the ClimateZone defintions for institution (e.g.
"ASHRAE" or "CEC").
|
static |
|
static |
|
static |
unsigned openstudio::model::ClimateZones::numClimateZones | ( | ) | const |
Returns the number of climate zone designations registered with this object.
ClimateZone openstudio::model::ClimateZones::setClimateZone | ( | const std::string & | institution, |
const std::string & | value | ||
) |
Sets the ClimateZone definition for institution to value and returns the modified (or created) ClimateZone.
If there are no definitions for institution, this method is equivalent to appendClimateZone(institution,value). If there are multiple definitions for institution, the return value is .empty() and a warning is logged.
ClimateZone openstudio::model::ClimateZones::setClimateZone | ( | const std::string & | institution, |
unsigned | year, | ||
const std::string & | value | ||
) |
Sets the ClimateZone definition for institution, year to value and returns the modified (or created) ClimateZone.
If there are no definitions for the given combination of institution and year, this method is equivalent to appendClimateZone(institution,year,value).
boost::optional<Site> openstudio::model::ClimateZones::site | ( | ) | const |
Site parents the unique ClimateZones object.
|
static |
|
related |