 |
OpenStudioCore:model |
|
OpenStudioCore:model |
#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 | |
| virtual | ~ModelExtensibleGroup () |
| 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... | |
| Public Member Functions inherited from openstudio::WorkspaceExtensibleGroup | |
| bool | canBeSource () const |
| std::vector< unsigned > | getSourceFieldIndices (const Handle &targetHandle) const |
| boost::optional< WorkspaceObject > | getTarget (unsigned fieldIndex) const |
| std::vector< WorkspaceObject > | getTargets () const |
| bool | isSource () const |
| bool | setPointer (unsigned fieldIndex, const Handle &targetHandle) |
| virtual | ~WorkspaceExtensibleGroup () |
| Public Member Functions inherited from openstudio::IdfExtensibleGroup | |
| T | cast () const |
| std::vector< unsigned > | dataFields () const |
| bool | empty () const |
| boost::optional< std::string > | fieldComment (unsigned fieldIndex, bool returnDefault=false) const |
| std::vector< std::string > | fieldComments (bool returnDefault=false) const |
| std::vector< std::string > | fields (bool returnDefault=false) const |
| boost::optional< double > | getDouble (unsigned fieldIndex, bool returnDefault=false) const |
| boost::optional< int > | getInt (unsigned fieldIndex, bool returnDefault=false) const |
| T | getObject () const |
| boost::optional< T > | getOptionalObject () const |
| boost::optional< std::string > | getString (unsigned fieldIndex, bool returnDefault=false) const |
| boost::optional< unsigned > | getUnsigned (unsigned fieldIndex, bool returnDefault=false) const |
| unsigned | groupIndex () const |
| IdfExtensibleGroup | insertClone (unsigned groupIndex) const |
| bool | isEmpty (unsigned fieldIndex) const |
| bool | isValid (unsigned fieldIndex) const |
| unsigned | numFields () const |
| std::vector< unsigned > | objectListFields () const |
| bool | operator!= (const IdfExtensibleGroup &other) const |
| bool | operator== (const IdfExtensibleGroup &other) const |
| boost::optional< T > | optionalCast () const |
| IdfExtensibleGroup | pushClone () const |
| std::vector< unsigned > | requiredFields () const |
| bool | setDouble (unsigned fieldIndex, double value) |
| bool | setFieldComment (unsigned fieldIndex, const std::string &cmnt) |
| bool | setFields (const std::vector< std::string > &values) |
| bool | setInt (unsigned fieldIndex, int value) |
| bool | setString (unsigned fieldIndex, const std::string &value, bool checkValidity) |
| bool | setString (unsigned fieldIndex, const std::string &value) |
| bool | setUnsigned (unsigned fieldIndex, unsigned value) |
| virtual | ~IdfExtensibleGroup () |
Related Functions | |
(Note that these are not member functions.) | |
| typedef std::vector< ClimateZone > | ClimateZoneVector |
Additional Inherited Members | |
| Public Types inherited from openstudio::IdfExtensibleGroup | |
| typedef std::vector < IdfExtensibleGroup > | IdfExtensibleGroupVector |
| Protected Types inherited from openstudio::WorkspaceExtensibleGroup | |
| typedef detail::WorkspaceObject_Impl | ImplType |
| Protected Member Functions inherited from openstudio::WorkspaceExtensibleGroup | |
| WorkspaceExtensibleGroup (std::shared_ptr< detail::WorkspaceObject_Impl > impl, unsigned index) | |
ClimateZone is a ModelExtensibleGroup that represents a single climate zone definition contained in the unique ClimateZones ModelObject.
| 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.
|
related |