#include <ClimateZones.hpp>

Inheritance diagram for openstudio::model::ClimateZones:

Public Member Functions
Constructors and Destructors
virtual	~ClimateZones () override=default

	ClimateZones (const ClimateZones &other)=default

	ClimateZones (ClimateZones &&other)=default

ClimateZones &	operator= (const ClimateZones &)=default

ClimateZones &	operator= (ClimateZones &&)=default

Getters
boost::optional< Site >	site () const
	Site parents the unique ClimateZones object.

std::vector< ClimateZone >	climateZones () const
	Return the individual climate zone definitions, with each one wrapped up as a ClimateZone ModelExtensibleGroup.

ClimateZone	getClimateZone (unsigned index) const
	Return the ClimateZone definition at extensible group index.

ClimateZone	getClimateZone (const std::string &institution, unsigned year) const
	Return the ClimateZone definition for institution and year.

std::vector< ClimateZone >	getClimateZones (const std::string &institution) const
	Return the ClimateZone defintions for institution (e.g.

Setters
bool	clear ()
	Clear all ClimateZone definitions.

ClimateZone	setClimateZone (const std::string &institution, const std::string &value)
	Sets the ClimateZone definition for institution to value and returns the modified (or created) ClimateZone.

ClimateZone	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.

ClimateZone	appendClimateZone (const std::string &institution)
	Creates and returns a new climate zone definition for institution.

ClimateZone	appendClimateZone (const std::string &institution, const std::string &value)
	Creates and returns a new climate zone definition for institution, with value.

ClimateZone	appendClimateZone (const std::string &institution, unsigned year, const std::string &value)
	Creates and returns a new climate zone definition.

ClimateZone	appendClimateZone (const std::string &institution, const std::string documentName, unsigned year, const std::string &value)
	Creates and returns a new climate zone definition.

Public Member Functions inherited from openstudio::model::ModelObject
virtual	~ModelObject () override=default

	ModelObject (const ModelObject &other)=default

	ModelObject (ModelObject &&other)=default

ModelObject &	operator= (const ModelObject &)=default

ModelObject &	operator= (ModelObject &&)=default

ModelObject	clone () const
	Creates a deep copy of this object, placing it in this object's model().

ModelObject	clone (Model model) const
	Creates a deep copy of this object, placing it in model.

Component	createComponent () const
	Method for creating sharable Model snippets.

Model	model () const
	Returns the Model that contains this object.

boost::optional< ParentObject >	parent () const
	Return this object's parent in the hierarchy, if it has one.

std::vector< ResourceObject >	resources () const
	Get the resources directly used by this ModelObject.

template<typename T >
std::vector< T >	getModelObjectSources () const
	Get all objects of type T that point to this object.

template<typename T >
std::vector< T >	getModelObjectSources (IddObjectType iddObjectType) const
	Get all objects of type T that point to this object.

template<typename T >
boost::optional< T >	getModelObjectTarget (unsigned index) const
	Get the object of type T pointed to by this object from field index.

template<typename T >
std::vector< T >	getModelObjectTargets () const
	Get all objects of type T to which this object points.

const std::vector< std::string > &	outputVariableNames () const
	Get all output variables names that could be associated with this object.

std::vector< OutputVariable >	outputVariables () const
	Get all output variables associated with this object, must run simulation to generate data.

boost::optional< openstudio::TimeSeries >	getData (const OutputVariable &variable, const std::string &envPeriod) const
	Get data associated with this output variable and this object.

std::vector< LifeCycleCost >	lifeCycleCosts () const
	Returns the list of all LifeCycleCosts that refer to this object.

std::vector< IdfObject >	removeLifeCycleCosts ()
	Removes all LifeCycleCosts that refer to this object.

IddObjectType	iddObjectType () const
	This is a virtual function that will tell you the type of iddObject you are dealing with.

AdditionalProperties	additionalProperties () const
	Returns this object's additional properties, constructing a new object if necessary.

bool	hasAdditionalProperties () const
	Returns true if this object has additional properties.

std::vector< IdfObject >	removeAdditionalProperties ()
	Removes all additional properties that refer to this object.

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

bool	operator< (const ModelObject &right) const

bool	operator== (const ModelObject &other) const
	equality test

bool	operator!= (const ModelObject &other) const
	inequality test

std::vector< ScheduleTypeKey >	getScheduleTypeKeys (const Schedule &schedule) const
	Return the ScheduleTypeKeys indicating how schedule is used in this object.

boost::optional< double >	getAutosizedValue (const std::string &valueName, const std::string &units) const
	Gets the autosized component value from the sql file.

virtual std::vector< EMSActuatorNames >	emsActuatorNames () const
	Return the names of the available ems actuators.

virtual std::vector< std::string >	emsInternalVariableNames () const
	Return the names of the available ems internal variables.

boost::optional< ModelObject >	connectedObject (unsigned port) const

boost::optional< unsigned >	connectedObjectPort (unsigned port) const

Public Member Functions inherited from openstudio::WorkspaceObject
bool	canBeSource () const

bool	canBeSource () const

bool	canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const

bool	canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const

std::vector< std::string >	canBeTarget () const

std::vector< std::string >	canBeTarget () const

std::vector< unsigned >	getSourceIndices (const Handle &targetHandle) const

std::vector< unsigned >	getSourceIndices (const Handle &targetHandle) const

std::vector< WorkspaceObject >	getSources (IddObjectType type) const

std::vector< WorkspaceObject >	getSources (IddObjectType type) const

boost::optional< WorkspaceObject >	getTarget (unsigned index) const

boost::optional< WorkspaceObject >	getTarget (unsigned index) const

IdfObject	idfObject ()

IdfObject	idfObject () const

bool	initialized () const

bool	initialized () const

bool	isSource () const

bool	isSource () const

bool	isTarget () const

bool	isTarget () const

unsigned	numSources () const

unsigned	numSources () const

bool	objectListFieldsEqual (const WorkspaceObject &other) const

bool	objectListFieldsEqual (const WorkspaceObject &other) const

bool	objectListFieldsNonConflicting (const WorkspaceObject &other) const

bool	objectListFieldsNonConflicting (const WorkspaceObject &other) const

bool	operator< (const WorkspaceObject &right) const

bool	operator< (const WorkspaceObject &right) const

std::ostream &	operator<< (std::ostream &os, const WorkspaceObject &workspaceObject)

WorkspaceObject &	operator= (const WorkspaceObject &)=default

WorkspaceObject &	operator= (const WorkspaceObject &)=default

WorkspaceObject &	operator= (WorkspaceObject &&)=default

WorkspaceObject &	operator= (WorkspaceObject &&)=default

std::vector< openstudio::IdfObject >	remove ()

std::vector< openstudio::IdfObject >	remove ()

bool	setPointer (unsigned index, const Handle &targetHandle)

bool	setPointer (unsigned index, const Handle &targetHandle)

std::vector< WorkspaceObject >	sources () const

std::vector< WorkspaceObject >	sources () const

std::vector< WorkspaceObject >	targets () const

std::vector< WorkspaceObject >	targets () const

Workspace	workspace () const

Workspace	workspace () const

	WorkspaceObject (const WorkspaceObject &other)=default

	WorkspaceObject (const WorkspaceObject &other)=default

	WorkspaceObject (WorkspaceObject &&other)=default

	WorkspaceObject (WorkspaceObject &&other)=default

virtual	~WorkspaceObject () override=default

virtual	~WorkspaceObject () override=default

Public Member Functions inherited from openstudio::IdfObject
std::string	briefDescription () const

std::string	briefDescription () const

T	cast () const

std::vector< T >	castVector (const std::vector< U > &objects)

std::vector< std::vector< std::string > >	clearExtensibleGroups ()

std::vector< std::vector< std::string > >	clearExtensibleGroups ()

IdfObject	clone (bool keepHandle=false) const

IdfObject	clone (bool keepHandle=false) const

std::string	comment () const

std::string	comment () const

boost::optional< std::string >	createName (bool overwrite=true)

boost::optional< std::string >	createName (bool overwrite=true)

std::vector< unsigned >	dataFields () const

std::vector< unsigned >	dataFields () const

bool	dataFieldsEqual (const IdfObject &other) const

bool	dataFieldsEqual (const IdfObject &other) const

std::vector< std::string >	eraseExtensibleGroup (unsigned groupIndex)

std::vector< std::string >	eraseExtensibleGroup (unsigned groupIndex)

std::vector< IdfExtensibleGroup >	extensibleGroups () const

std::vector< IdfExtensibleGroup >	extensibleGroups () const

boost::optional< std::string >	fieldComment (unsigned index, bool returnDefault=false) const

boost::optional< std::string >	fieldComment (unsigned index, bool returnDefault=false) const

boost::optional< double >	getDouble (unsigned index, bool returnDefault=false) const

boost::optional< double >	getDouble (unsigned index, bool returnDefault=false) const

IdfExtensibleGroup	getExtensibleGroup (unsigned groupIndex) const

IdfExtensibleGroup	getExtensibleGroup (unsigned groupIndex) const

boost::optional< std::string >	getField (unsigned index, bool returnDefault=false) const

boost::optional< std::string >	getField (unsigned index, bool returnDefault=false) const

std::vector< Handle >	getHandles (const std::vector< T > &objects)

boost::optional< int >	getInt (unsigned index, bool returnDefault=false) const

boost::optional< int >	getInt (unsigned index, bool returnDefault=false) const

OSOptionalQuantity	getQuantity (unsigned index, bool returnDefault=false, bool returnIP=false) const

OSOptionalQuantity	getQuantity (unsigned index, bool returnDefault=false, bool returnIP=false) const

boost::optional< std::string >	getString (unsigned index, bool returnDefault=false, bool returnUninitializedEmpty=false) const

boost::optional< std::string >	getString (unsigned index, bool returnDefault=false, bool returnUninitializedEmpty=false) const

boost::optional< unsigned >	getUnsigned (unsigned index, bool returnDefault=false) const

boost::optional< unsigned >	getUnsigned (unsigned index, bool returnDefault=false) const

Handle	handle () const

Handle	handle () const

IddObject	iddObject () const

IddObject	iddObject () const

	IdfObject (const IddObject &, bool fastName=false)

	IdfObject (const IddObject &, bool fastName=false)

	IdfObject (const IdfObject &other)

	IdfObject (const IdfObject &other)

	IdfObject (IddObjectType type, bool fastName=false)

	IdfObject (IddObjectType type, bool fastName=false)

	IdfObject (IdfObject &&other) noexcept

	IdfObject (IdfObject &&other) noexcept

void	initializeFields (bool fill_default=false)

void	initializeFields (bool fill_default=false)

IdfExtensibleGroup	insertExtensibleGroup (unsigned groupIndex)

IdfExtensibleGroup	insertExtensibleGroup (unsigned groupIndex)

IdfExtensibleGroup	insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values)

IdfExtensibleGroup	insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values)

bool	isDataField (unsigned index) const

bool	isDataField (unsigned index) const

bool	isEmpty (unsigned index) const

bool	isEmpty (unsigned index) const

bool	isObjectListField (unsigned index) const

bool	isObjectListField (unsigned index) const

bool	isValid (StrictnessLevel level, bool checkNames=false) const

bool	isValid (StrictnessLevel level, bool checkNames=false) const

boost::optional< unsigned >	maxExtensibleGroups () const

boost::optional< unsigned >	maxExtensibleGroups () const

boost::optional< unsigned >	maxFields () const

boost::optional< unsigned >	maxFields () const

unsigned	minExtensibleGroups () const

unsigned	minExtensibleGroups () const

unsigned	minFields () const

unsigned	minFields () const

boost::optional< std::string >	name (bool returnDefault=false) const

boost::optional< std::string >	name (bool returnDefault=false) const

std::string	nameString (bool returnDefault=false) const

std::string	nameString (bool returnDefault=false) const

unsigned	numExtensibleGroups () const

unsigned	numExtensibleGroups () const

unsigned	numFields () const

unsigned	numFields () const

unsigned	numNonextensibleFields () const

unsigned	numNonextensibleFields () const

std::vector< unsigned >	objectListFields () const

std::vector< unsigned >	objectListFields () const

bool	objectListFieldsEqual (const IdfObject &other) const

bool	objectListFieldsEqual (const IdfObject &other) const

bool	objectListFieldsNonConflicting (const IdfObject &other) const

bool	objectListFieldsNonConflicting (const IdfObject &other) const

bool	operator!= (const IdfObject &other) const

bool	operator!= (const IdfObject &other) const

std::ostream &	operator<< (std::ostream &os, const IdfObject &IdfObject)

IdfObject &	operator= (const IdfObject &other)

IdfObject &	operator= (const IdfObject &other)

IdfObject &	operator= (IdfObject &&other) noexcept

IdfObject &	operator= (IdfObject &&other) noexcept

bool	operator== (const IdfObject &other) const

bool	operator== (const IdfObject &other) const

boost::optional< T >	optionalCast () const

std::vector< std::string >	popExtensibleGroup ()

std::vector< std::string >	popExtensibleGroup ()

std::ostream &	print (std::ostream &os) const

std::ostream &	printField (std::ostream &os, unsigned index, bool isLastField=false) const

std::ostream &	printName (std::ostream &os, bool hasFields=true) const

IdfExtensibleGroup	pushExtensibleGroup ()

IdfExtensibleGroup	pushExtensibleGroup ()

IdfExtensibleGroup	pushExtensibleGroup (const std::vector< std::string > &values)

IdfExtensibleGroup	pushExtensibleGroup (const std::vector< std::string > &values)

std::vector< unsigned >	requiredFields () const

std::vector< unsigned >	requiredFields () const

void	setComment (const std::string &msg)

void	setComment (const std::string &msg)

bool	setDouble (unsigned index, double value)

bool	setDouble (unsigned index, double value)

bool	setFieldComment (unsigned index, const std::string &cmnt)

bool	setFieldComment (unsigned index, const std::string &cmnt)

bool	setInt (unsigned index, int value)

bool	setInt (unsigned index, int value)

boost::optional< std::string >	setName (const std::string &newName)

boost::optional< std::string >	setName (const std::string &newName)

bool	setQuantity (unsigned index, const Quantity &q)

bool	setQuantity (unsigned index, const Quantity &q)

bool	setString (unsigned index, const std::string &value)

bool	setString (unsigned index, const std::string &value)

bool	setUnsigned (unsigned index, unsigned value)

bool	setUnsigned (unsigned index, unsigned value)

std::vector< T >	subsetCastVector (const std::vector< U > &original)

ValidityReport	validityReport (StrictnessLevel level, bool checkNames=false) const

ValidityReport	validityReport (StrictnessLevel level, bool checkNames=false) const

virtual	~IdfObject ()=default

virtual	~IdfObject ()=default

Static Public Member Functions
Static Methods
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 ()

Static Public Member Functions inherited from openstudio::IdfObject
static boost::optional< IdfObject >	load (const std::string &text)

static boost::optional< IdfObject >	load (const std::string &text, const IddObject &iddObject)

static int	printedFieldSpace ()

Related Symbols
(Note that these are not member symbols.)
using	OptionalClimateZones = boost::optional<ClimateZones>

Related Symbols inherited from openstudio::model::ModelObject
std::vector< ResourceObject >	getRecursiveResources (const ModelObject &object)
	Returns all ResourceObjects accessible by recursively calling .resources() starting from object.

Queries
unsigned	numClimateZones () const
	Returns the number of climate zone designations registered with this object.

Additional Inherited Members
Public Types inherited from openstudio::WorkspaceObject
typedef boost::optional< WorkspaceObject >	OptionalWorkspaceObject

typedef std::vector< WorkspaceObject >	WorkspaceObjectVector

Public Types inherited from openstudio::IdfObject
typedef std::pair< IdfObject, IdfObject >	IdfObjectPair

typedef std::vector< IdfObject >	IdfObjectVector

typedef boost::optional< IdfObject >	OptionalIdfObject

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

Protected Types inherited from openstudio::WorkspaceObject
typedef detail::WorkspaceObject_Impl	ImplType

Protected Types inherited from openstudio::IdfObject
typedef detail::IdfObject_Impl	ImplType

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)

Protected Member Functions inherited from openstudio::WorkspaceObject
	WorkspaceObject (std::shared_ptr< detail::WorkspaceObject_Impl > impl)

Protected Member Functions inherited from openstudio::IdfObject
	IdfObject (std::shared_ptr< detail::IdfObject_Impl > impl)

Detailed Description

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.

Todo: Provide methods for setting the ClimateZones for a model based on the data in Site and/or WeatherFile, and for checking whether the ClimateZones object is consistent with the geospatial location(s) called out in Site and/or WeatherFile.

Constructor & Destructor Documentation

◆ ~ClimateZones()

virtual openstudio::model::ClimateZones::~ClimateZones ( )

overridevirtualdefault

◆ ClimateZones() [1/2]

openstudio::model::ClimateZones::ClimateZones ( const ClimateZones & other )

default

◆ ClimateZones() [2/2]

openstudio::model::ClimateZones::ClimateZones ( ClimateZones && other )

default

Member Function Documentation

◆ appendClimateZone() [1/4]

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.

◆ appendClimateZone() [2/4]

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.

◆ appendClimateZone() [3/4]

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.

◆ appendClimateZone() [4/4]

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.

◆ ashraeDefaultYear()

static unsigned openstudio::model::ClimateZones::ashraeDefaultYear ( )

static

◆ ashraeDocumentName()

static std::string openstudio::model::ClimateZones::ashraeDocumentName ( )

static

◆ ashraeInstitutionName()

static std::string openstudio::model::ClimateZones::ashraeInstitutionName ( )

static

◆ cecDefaultYear()

static unsigned openstudio::model::ClimateZones::cecDefaultYear ( )

static

◆ cecDocumentName()

static std::string openstudio::model::ClimateZones::cecDocumentName ( )

static

◆ cecInstitutionName()

static std::string openstudio::model::ClimateZones::cecInstitutionName ( )

static

◆ clear()

bool openstudio::model::ClimateZones::clear ( )

Clear all ClimateZone definitions.

◆ climateZones()

std::vector< ClimateZone > openstudio::model::ClimateZones::climateZones ( ) const

Return the individual climate zone definitions, with each one wrapped up as a ClimateZone ModelExtensibleGroup.

◆ getClimateZone() [1/2]

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.

◆ getClimateZone() [2/2]

ClimateZone openstudio::model::ClimateZones::getClimateZone ( unsigned index ) const

Return the ClimateZone definition at extensible group index.

◆ getClimateZones()

std::vector< ClimateZone > openstudio::model::ClimateZones::getClimateZones ( const std::string & institution ) const

Return the ClimateZone defintions for institution (e.g.

"ASHRAE" or "CEC").

◆ getDefaultDocumentName()

static std::string openstudio::model::ClimateZones::getDefaultDocumentName ( const std::string & institution )

static

◆ getDefaultYear()

static unsigned openstudio::model::ClimateZones::getDefaultYear ( const std::string & institution )

static

◆ iddObjectType()

static IddObjectType openstudio::model::ClimateZones::iddObjectType ( )

static

◆ numClimateZones()

unsigned openstudio::model::ClimateZones::numClimateZones ( ) const

Returns the number of climate zone designations registered with this object.

◆ operator=() [1/2]

ClimateZones & openstudio::model::ClimateZones::operator= ( ClimateZones && )

default

◆ operator=() [2/2]

ClimateZones & openstudio::model::ClimateZones::operator= ( const ClimateZones & )

default

◆ setClimateZone() [1/2]

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.

◆ setClimateZone() [2/2]

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).

◆ site()

boost::optional< Site > openstudio::model::ClimateZones::site ( ) const

Site parents the unique ClimateZones object.

◆ validClimateZoneValues()

static std::vector< std::string > openstudio::model::ClimateZones::validClimateZoneValues	(	const std::string &	institution,
		unsigned	year )

static

Friends And Related Symbol Documentation

◆ OptionalClimateZones

using OptionalClimateZones = boost::optional<ClimateZones>

Public Member Functions

Static Public Member Functions

Related Symbols

Queries

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~ClimateZones()

◆ ClimateZones() [1/2]

◆ ClimateZones() [2/2]

Member Function Documentation

◆ appendClimateZone() [1/4]

◆ appendClimateZone() [2/4]

◆ appendClimateZone() [3/4]

◆ appendClimateZone() [4/4]

◆ ashraeDefaultYear()

◆ ashraeDocumentName()

◆ ashraeInstitutionName()

◆ cecDefaultYear()

◆ cecDocumentName()

◆ cecInstitutionName()

◆ clear()

◆ climateZones()

◆ getClimateZone() [1/2]

◆ getClimateZone() [2/2]

◆ getClimateZones()

◆ getDefaultDocumentName()

◆ getDefaultYear()

◆ iddObjectType()

◆ numClimateZones()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ setClimateZone() [1/2]

◆ setClimateZone() [2/2]

◆ site()

◆ validClimateZoneValues()

Friends And Related Symbol Documentation

◆ OptionalClimateZones