#include <ClimateZones.hpp>
Public Member Functions | |
Constructors and Destructors | |
virtual | ~ClimateZones () |
Getters | |
boost::optional< Site > | site () const |
Site parents the unique ClimateZones object. More... | |
std::vector< ClimateZone > | climateZones () 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< ClimateZone > | getClimateZones (const std::string &institution) const |
Return the ClimateZone defintions for institution (e.g. More... | |
Setters | |
Return the active ClimateZone definition. If no ClimateZone is designated as active, the return value will be .empty(). The active climate zone is the one that will be accessed by the standardsinterface::OpenStudioStandardsInterface, perhaps in the course of applying a ruleset::StandardsRuleset using a rulesengine::OpenStudioRulesEngine. Return the active ClimateZone value. If no ClimateZone is designated as active, the return value will be .empty(). The active climate zone is the one that will be accessed by the standardsinterface::OpenStudioStandardsInterface, perhaps in the course of applying a ruleset::StandardsRuleset using a rulesengine::OpenStudioRulesEngine. | |
bool | clear () |
Clear all ClimateZone definitions. More... | |
ClimateZone | setClimateZone (const std::string &institution, const std::string &value) |
Sets the active ClimateZone to be one defined by institution. 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 () |
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< ParentObject > | parent () const |
Return this object's parent in the hierarchy, if it has one. More... | |
std::vector< ResourceObject > | resources () 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< OutputVariable > | outputVariables () 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< LifeCycleCost > | lifeCycleCosts () 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... | |
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< ScheduleTypeKey > | getScheduleTypeKeys (const Schedule &schedule) const |
Return the ScheduleTypeKeys indicating how schedule is used in this object. More... | |
boost::optional< double > | getAutosizedValue (std::string valueName, std::string unitString) 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< ModelObject > | connectedObject (unsigned port) const |
boost::optional< unsigned > | connectedObjectPort (unsigned port) const |
Public Member Functions inherited from openstudio::WorkspaceObject | |
bool | canBeSource () const |
bool | canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const |
std::vector< std::string > | canBeTarget () const |
std::vector< unsigned > | getSourceIndices (const Handle &targetHandle) const |
std::vector< WorkspaceObject > | getSources (IddObjectType type) const |
boost::optional< WorkspaceObject > | getTarget (unsigned index) const |
IdfObject | idfObject () |
IdfObject | idfObject () const |
bool | initialized () const |
bool | isSource () const |
bool | isTarget () const |
unsigned | numSources () const |
bool | objectListFieldsEqual (const WorkspaceObject &other) const |
bool | objectListFieldsNonConflicting (const WorkspaceObject &other) const |
bool | operator< (const WorkspaceObject &right) const |
std::ostream & | operator<< (std::ostream &os, const WorkspaceObject &workspaceObject) |
std::vector < openstudio::IdfObject > | remove () |
bool | setPointer (unsigned index, const Handle &targetHandle) |
std::vector< WorkspaceObject > | sources () const |
std::vector< WorkspaceObject > | targets () const |
Workspace | workspace () const |
virtual | ~WorkspaceObject () |
Public Member Functions inherited from openstudio::IdfObject | |
std::string | briefDescription () const |
T | cast () const |
std::vector< T > | castVector (const std::vector< U > &objects) |
std::vector< std::vector < std::string > > | clearExtensibleGroups () |
IdfObject | clone (bool keepHandle=false) const |
std::string | comment () const |
boost::optional< std::string > | createName (bool overwrite=true) |
std::vector< unsigned > | dataFields () const |
bool | dataFieldsEqual (const IdfObject &other) const |
std::vector< std::string > | eraseExtensibleGroup (unsigned groupIndex) |
std::vector< IdfExtensibleGroup > | extensibleGroups () const |
boost::optional< std::string > | fieldComment (unsigned index, bool returnDefault=false) const |
boost::optional< double > | getDouble (unsigned index, bool returnDefault=false) const |
IdfExtensibleGroup | getExtensibleGroup (unsigned groupIndex) const |
std::vector< Handle > | getHandles (const std::vector< T > &objects) |
boost::optional< int > | getInt (unsigned index, bool returnDefault=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< unsigned > | getUnsigned (unsigned index, bool returnDefault=false) const |
boost::optional< QUrl > | getURL (unsigned index, bool returnDefault=false) const |
Handle | handle () const |
IddObject | iddObject () const |
IdfObject (IddObjectType type, bool fastName=false) | |
IdfObject (const IddObject &, bool fastName=false) | |
IdfObject (const IdfObject &other) | |
IdfExtensibleGroup | insertExtensibleGroup (unsigned groupIndex) |
IdfExtensibleGroup | insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values) |
bool | isDataField (unsigned index) const |
bool | isEmpty (unsigned index) const |
bool | isObjectListField (unsigned index) const |
bool | isValid (StrictnessLevel level, bool checkNames=false) const |
boost::optional< unsigned > | maxExtensibleGroups () const |
boost::optional< unsigned > | maxFields () const |
unsigned | minExtensibleGroups () const |
unsigned | minFields () const |
boost::optional< std::string > | name (bool returnDefault=false) const |
std::string | nameString (bool returnDefault=false) const |
unsigned | numExtensibleGroups () const |
unsigned | numFields () const |
unsigned | numNonextensibleFields () const |
std::vector< unsigned > | objectListFields () const |
bool | objectListFieldsEqual (const IdfObject &other) const |
bool | objectListFieldsNonConflicting (const IdfObject &other) const |
bool | operator!= (const IdfObject &other) const |
std::ostream & | operator<< (std::ostream &os, const IdfObject &IdfObject) |
bool | operator== (const IdfObject &other) const |
boost::optional< T > | optionalCast () const |
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 (const std::vector< std::string > &values) |
std::vector< unsigned > | requiredFields () const |
void | setComment (const std::string &msg) |
bool | setDouble (unsigned index, double value) |
bool | setFieldComment (unsigned index, const std::string &cmnt) |
bool | setInt (unsigned index, int value) |
boost::optional< std::string > | setName (const std::string &newName) |
bool | setQuantity (unsigned index, const Quantity &q) |
bool | setString (unsigned index, const std::string &value) |
bool | setUnsigned (unsigned index, unsigned value) |
std::vector< T > | subsetCastVector (const std::vector< U > &original) |
ValidityReport | validityReport (StrictnessLevel level, bool checkNames=false) const |
virtual | ~IdfObject () |
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 Functions | |
(Note that these are not member functions.) | |
typedef boost::optional < ClimateZones > | OptionalClimateZones |
Related Functions inherited from openstudio::model::ModelObject | |
std::vector< ResourceObject > | getRecursiveResources (const ModelObject &object) |
Returns all ResourceObjects accessible by recursively calling .resources() starting from object. More... | |
typedef std::pair< std::string, std::string > | ScheduleTypeKey |
Typedef for ScheduleTypeRegistry key. More... | |
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 | |
typedef detail::ModelObject_Impl | ImplType |
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) | |
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 active ClimateZone to be one defined by institution.
If there are no such definitions, this method is equivalent to appendClimateZone(institution). If there are multiple climate zones associated with institution, the first one is set as active and a warning is logged. The return value of this method should never be .empty(). Sets the active ClimateZone to be one defined by institution and year. If there are no such definitions, this method is equivalent to appendClimateZone(institution,year). The return value of this method should never be .empty(). 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 |