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

#include <ClimateZones.hpp>

+ Inheritance diagram for openstudio::model::ClimateZones:

Public Member Functions

Constructors and Destructors
virtual ~ClimateZones ()=default
 
 ClimateZones (const ClimateZones &other)=default
 
 ClimateZones (ClimateZones &&other)=default
 
ClimateZonesoperator= (const ClimateZones &)=default
 
ClimateZonesoperator= (ClimateZones &&)=default
 
Getters
boost::optional< Sitesite () const
 Site parents the unique ClimateZones object. More...
 
std::vector< ClimateZoneclimateZones () const
 Return the individual climate zone definitions, with each one wrapped up as a ClimateZone ModelExtensibleGroup. More...
 
ClimateZone getClimateZone (unsigned index) const
 Return the ClimateZone definition at extensible group index. More...
 
ClimateZone getClimateZone (const std::string &institution, unsigned year) const
 Return the ClimateZone definition for institution and year. More...
 
std::vector< ClimateZonegetClimateZones (const std::string &institution) const
 Return the ClimateZone defintions for institution (e.g. More...
 
Setters
bool clear ()
 Clear all ClimateZone definitions. More...
 
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. More...
 
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. More...
 
ClimateZone appendClimateZone (const std::string &institution)
 Creates and returns a new climate zone definition for institution. More...
 
ClimateZone appendClimateZone (const std::string &institution, const std::string &value)
 Creates and returns a new climate zone definition for institution, with value. More...
 
ClimateZone appendClimateZone (const std::string &institution, unsigned year, const std::string &value)
 Creates and returns a new climate zone definition. More...
 
ClimateZone appendClimateZone (const std::string &institution, const std::string documentName, unsigned year, const std::string &value)
 Creates and returns a new climate zone definition. More...
 
Queries
unsigned numClimateZones () const
 Returns the number of climate zone designations registered with this object. More...
 
- 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 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 ()
 

Related Functions

(Note that these are not member functions.)

using OptionalClimateZones = boost::optional< ClimateZones >
 

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

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

virtual openstudio::model::ClimateZones::~ClimateZones ( )
virtualdefault
openstudio::model::ClimateZones::ClimateZones ( const ClimateZones other)
default
openstudio::model::ClimateZones::ClimateZones ( ClimateZones &&  other)
default

Member Function Documentation

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 unsigned openstudio::model::ClimateZones::ashraeDefaultYear ( )
static
static std::string openstudio::model::ClimateZones::ashraeDocumentName ( )
static
static std::string openstudio::model::ClimateZones::ashraeInstitutionName ( )
static
static unsigned openstudio::model::ClimateZones::cecDefaultYear ( )
static
static std::string openstudio::model::ClimateZones::cecDocumentName ( )
static
static std::string openstudio::model::ClimateZones::cecInstitutionName ( )
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 std::string openstudio::model::ClimateZones::getDefaultDocumentName ( const std::string &  institution)
static
static unsigned openstudio::model::ClimateZones::getDefaultYear ( const std::string &  institution)
static
static IddObjectType openstudio::model::ClimateZones::iddObjectType ( )
static
unsigned openstudio::model::ClimateZones::numClimateZones ( ) const

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

ClimateZones& openstudio::model::ClimateZones::operator= ( const ClimateZones )
default
ClimateZones& openstudio::model::ClimateZones::operator= ( ClimateZones &&  )
default
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 std::vector<std::string> openstudio::model::ClimateZones::validClimateZoneValues ( const std::string &  institution,
unsigned  year 
)
static

Friends And Related Function Documentation

using OptionalClimateZones = boost::optional<ClimateZones>
related