|
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...
|
| |
|
| | OutputMeter (const Model &model) |
| |
| virtual | ~OutputMeter () |
| |
|
| 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...
|
| |
|
| bool | setName (std::string name) |
| |
| bool | setReportingFrequency (const std::string &reportingFrequency) |
| |
| void | resetReportingFrequency () |
| |
| void | setMeterFileOnly (bool meterFileOnly) |
| |
| void | resetMeterFileOnly () |
| |
| void | 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 () |
| |
| 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...
|
| |
| std::vector< std::string > | relationshipNames () const |
| | Return all valid relationship names. More...
|
| |
| std::vector< Relationship > | relationships () const |
| | Return all relationships for this ModelObject. More...
|
| |
| boost::optional< Relationship > | getRelationship (const std::string &name) const |
| | Get the relationship named name, if it exists. More...
|
| |
| bool | setRelationship (const std::string &name, boost::optional< ModelObject > relatedModelObject) |
| | Set this ModelObject's relationship name to point to relatedModelObject (or clear the relationship if relatedModelObject == boost::none). More...
|
| |
| bool | setRelationship (const std::string &name, const Component &component) |
| | Inserts component into this model and sets this ModelObject's relationship name to point to component.primaryObject(). More...
|
| |
| std::vector< std::string > | attributeNames () const |
| | Return all valid attribute names. More...
|
| |
std::vector
< openstudio::Attribute > | attributes () const |
| | Return all Attributes for this ModelObject. More...
|
| |
boost::optional
< openstudio::Attribute > | getAttribute (const std::string &name) const |
| | Get the attribute named name, if it exists. More...
|
| |
| bool | isSettableAttribute (const std::string &name) const |
| | Is the named attribute settable. More...
|
| |
| bool | isOptionalAttribute (const std::string &name) const |
| | Is the named attribute optional. More...
|
| |
| bool | setAttribute (const std::string &name, bool value) |
| | Set the attribute named name, if it exists. More...
|
| |
| bool | setAttribute (const std::string &name, int value) |
| |
| bool | setAttribute (const std::string &name, unsigned value) |
| |
| bool | setAttribute (const std::string &name, double value) |
| |
| bool | setAttribute (const std::string &name, const Quantity &value) |
| |
| bool | setAttribute (const std::string &name, const std::string &value) |
| |
| bool | setAttribute (const std::string &name, const char *value) |
| |
| bool | resetAttribute (const std::string &name) |
| | Reset the attribute named name. 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...
|
| |
| 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< ModelObject > | connectedObject (unsigned port) const |
| |
| boost::optional< unsigned > | connectedObjectPort (unsigned port) const |
| |
| 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 () |
| |
| 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) 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=true) const |
| |
| virtual | ~IdfObject () |
| |
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.
Inheritance diagram for openstudio::model::OutputMeter: