 |
OpenStudio:model |
#include <OutputMeter.hpp>
Inheritance diagram for openstudio::model::OutputMeter:Public Member Functions | |
| boost::optional < openstudio::TimeSeries > | getData (const std::string &envPeriod) const |
| Returns TimeSeries data for this Meter. Requires EnergyPlus simulation data. More... | |
| boost::optional < openstudio::TimeSeries > | getData (const std::string &envPeriod, const boost::optional< std::string > &specificInstallLocation) const |
| Returns TimeSeries data for this Meter, using given specificInstallLocation instead of this->specificInstallLocation. More... | |
Constructors and Destructors | |
| OutputMeter (const Model &model) | |
| virtual | ~OutputMeter ()=default |
| OutputMeter (const OutputMeter &other)=default | |
| OutputMeter (OutputMeter &&other)=default | |
| OutputMeter & | operator= (const OutputMeter &)=default |
| OutputMeter & | operator= (OutputMeter &&)=default |
| virtual std::vector < openstudio::IdfObject > | remove () |
Getters | |
| std::string | name () const |
| std::string | reportingFrequency () const |
| bool | isReportingFrequencyDefaulted () const |
| bool | meterFileOnly () const |
| bool | isMeterFileOnlyDefaulted () const |
| bool | cumulative () const |
| bool | isCumulativeDefaulted () const |
| boost::optional< std::string > | specificEndUse () const |
| Returns the specific end use category to meter from the name field. More... | |
| boost::optional< EndUseType > | endUseType () const |
| Returns the end use type to meter from the name field. More... | |
| boost::optional< FuelType > | fuelType () const |
| Returns the fuel type to meter from the name field. More... | |
| boost::optional < InstallLocationType > | installLocationType () const |
| Returns the location the meter is installed at from the name field. More... | |
| boost::optional< std::string > | specificInstallLocation () const |
| Returns the specific location the meter is installed at from the name field. More... | |
Setters | |
| bool | setReportingFrequency (const std::string &reportingFrequency) |
| void | resetReportingFrequency () |
| bool | setMeterFileOnly (bool meterFileOnly) |
| void | resetMeterFileOnly () |
| bool | setCumulative (bool cumulative) |
| void | resetCumulative () |
| bool | setSpecificEndUse (const std::string &specifcEndUse) |
| Sets the specific end use category to meter in the name field. More... | |
| bool | resetSpecificEndUse () |
| bool | setEndUseType (EndUseType type) |
| Sets the end use type to meter in the name field. More... | |
| bool | resetEndUseType () |
| bool | setFuelType (FuelType type) |
| Sets the fuel type to meter in the name field. More... | |
| bool | resetFuelType () |
| bool | setInstallLocationType (InstallLocationType type) |
| Sets the location the meter is installed at from the name field. More... | |
| bool | resetInstallLocationType () |
| bool | setSpecificInstallLocation (const std::string &locationName) |
| Sets the specific location the meter is installed at from the name field. More... | |
| bool | resetSpecificInstallLocation () |
| Public Member Functions inherited from openstudio::model::ModelObject | |
| virtual | ~ModelObject ()=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(). 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... | |
| 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< ScheduleTypeKey > | getScheduleTypeKeys (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< ModelObject > | connectedObject (unsigned port) const |
| boost::optional< unsigned > | connectedObjectPort (unsigned port) const |
Static Public Member Functions | |
Static Methods | |
| static IddObjectType | iddObjectType () |
| static boost::regex | meterRegex () |
| Returns the regular expression used to parse the name field. More... | |
| static std::string | getName (const boost::optional< std::string > &specificEndUseType, const boost::optional< EndUseType > &endUseType, const boost::optional< FuelType > &fuelType, const boost::optional< InstallLocationType > &installLocationType, const boost::optional< std::string > &specificInstallLocation) |
| Returns the Meter name for a set of inputs. More... | |
Related Functions | |
(Note that these are not member functions.) | |
| bool | MeterFuelTypeEquals (const OutputMeter &meter, const FuelType &ft) |
| Predicate for finding OutputMeters with fuelType() ft. More... | |
| using | OptionalOutputMeter = boost::optional< OutputMeter > |
| using | OutputMeterVector = std::vector< OutputMeter > |
| 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... | |
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) | |
OutputMeter is a ModelObject that wraps the OpenStudio IDD object 'OS_Output_Meter'.
A OutputMeter is a virtual instrument measuring energy use of some fuel type at a particular location. OutputMeter objects may be associated with various classes in the building model hierarchy (e.g. Facility, Building, Zone, Plant, etc). A OutputMeter can be used to request output data as well as access it from the EnergyPlus SQLite output. If the user wants to access measured data from a particular OutputMeter, they must ensure that input objects are present to trigger EnergyPlus to output the desired data. This is similar to needing to instrument a real building during field measurements.
|
explicit |
|
virtualdefault |
|
default |
|
default |
| bool openstudio::model::OutputMeter::cumulative | ( | ) | const |
| boost::optional<EndUseType> openstudio::model::OutputMeter::endUseType | ( | ) | const |
Returns the end use type to meter from the name field.
For example, to meter all Lights the end use type would be "InteriorLights" and the Meter name would be "InteriorLights:Electricity:Facility".
| boost::optional<FuelType> openstudio::model::OutputMeter::fuelType | ( | ) | const |
Returns the fuel type to meter from the name field.
For example, to meter all electricity use the fuel type would be "Electricity" and the Meter name would be "Electricity:Facility".
| boost::optional<openstudio::TimeSeries> openstudio::model::OutputMeter::getData | ( | const std::string & | envPeriod | ) | const |
Returns TimeSeries data for this Meter. Requires EnergyPlus simulation data.
| boost::optional<openstudio::TimeSeries> openstudio::model::OutputMeter::getData | ( | const std::string & | envPeriod, |
| const boost::optional< std::string > & | specificInstallLocation | ||
| ) | const |
Returns TimeSeries data for this Meter, using given specificInstallLocation instead of this->specificInstallLocation.
Useful if this->specificInstallLocation is '*'. Requires EnergyPlus simulation data.
|
static |
Returns the Meter name for a set of inputs.
|
static |
| boost::optional<InstallLocationType> openstudio::model::OutputMeter::installLocationType | ( | ) | const |
Returns the location the meter is installed at from the name field.
For example, to meter all electricity at the Facility level the install location would be "Facility" and the Meter name would be "Electricity:Facility".
| bool openstudio::model::OutputMeter::isCumulativeDefaulted | ( | ) | const |
| bool openstudio::model::OutputMeter::isMeterFileOnlyDefaulted | ( | ) | const |
| bool openstudio::model::OutputMeter::isReportingFrequencyDefaulted | ( | ) | const |
| bool openstudio::model::OutputMeter::meterFileOnly | ( | ) | const |
|
static |
Returns the regular expression used to parse the name field.
matches[1], specific end use type matches[2], end use type matches[3], fuel type matches[4], install location type matches[5], install location name
| std::string openstudio::model::OutputMeter::name | ( | ) | const |
|
default |
|
default |
|
virtual |
| std::string openstudio::model::OutputMeter::reportingFrequency | ( | ) | const |
| void openstudio::model::OutputMeter::resetCumulative | ( | ) |
| bool openstudio::model::OutputMeter::resetEndUseType | ( | ) |
| bool openstudio::model::OutputMeter::resetFuelType | ( | ) |
| bool openstudio::model::OutputMeter::resetInstallLocationType | ( | ) |
| void openstudio::model::OutputMeter::resetMeterFileOnly | ( | ) |
| void openstudio::model::OutputMeter::resetReportingFrequency | ( | ) |
| bool openstudio::model::OutputMeter::resetSpecificEndUse | ( | ) |
| bool openstudio::model::OutputMeter::resetSpecificInstallLocation | ( | ) |
| bool openstudio::model::OutputMeter::setCumulative | ( | bool | cumulative | ) |
| bool openstudio::model::OutputMeter::setEndUseType | ( | EndUseType | type | ) |
Sets the end use type to meter in the name field.
For example, to meter all Lights the end use type would be "InteriorLights" and the Meter name would be "InteriorLights:Electricity:Facility".
| bool openstudio::model::OutputMeter::setFuelType | ( | FuelType | type | ) |
Sets the fuel type to meter in the name field.
For example, to meter all electricity use the fuel type would be "Electricity" and the Meter name would be "Electricity:Facility".
| bool openstudio::model::OutputMeter::setInstallLocationType | ( | InstallLocationType | type | ) |
Sets the location the meter is installed at from the name field.
For example, to meter all electricity at the Facility level the install location would be "Facility" and the Meter name would be "Electricity:Facility".
| bool openstudio::model::OutputMeter::setMeterFileOnly | ( | bool | meterFileOnly | ) |
| bool openstudio::model::OutputMeter::setReportingFrequency | ( | const std::string & | reportingFrequency | ) |
| bool openstudio::model::OutputMeter::setSpecificEndUse | ( | const std::string & | specifcEndUse | ) |
Sets the specific end use category to meter in the name field.
For example, to meter all Lights with endUseSubcategory set to "General" the specific end use would be "General" and the Meter name would be "General:InteriorLights:Electricity:Facility". Passing an empty string will unset the value.
| bool openstudio::model::OutputMeter::setSpecificInstallLocation | ( | const std::string & | locationName | ) |
Sets the specific location the meter is installed at from the name field.
For example, to meter all electricity in a Zone named "Zone1" the specific install location would be "Zone1" and the Meter name would be "Electricity:Zone:Zone1". Passing an empty string will unset the value, '*' indicates reporting for all locations.
| boost::optional<std::string> openstudio::model::OutputMeter::specificEndUse | ( | ) | const |
Returns the specific end use category to meter from the name field.
For example, to meter all Lights with endUseSubcategory set to "General" the specific end use would be "General" and the Meter name would be "General:InteriorLights:Electricity".
| boost::optional<std::string> openstudio::model::OutputMeter::specificInstallLocation | ( | ) | const |
Returns the specific location the meter is installed at from the name field.
For example, to meter all electricity in a Zone named "Zone1" the specific install location would be "Zone1" and the Meter name would be "Electricity:Zone:Zone1". The value '*' indicates reporting for all locations.
|
related |
Predicate for finding OutputMeters with fuelType() ft.
|
related |
|
related |