ClimateZone Class Reference

#include "ClimateZones.hpp"

Inheritance diagram for openstudio::model::ClimateZone:

Public Member Functions
std::string	institution () const
std::string	documentName () const
unsigned	year () const
std::string	value () const
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)

Related Functions
typedef std::vector< ClimateZone >	ClimateZoneVector

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

typedef std::vector<ClimateZone> ClimateZoneVector

related