 |
OpenStudioCore:model |
|
OpenStudioCore:model |
#include <TimeDependentValuation.hpp>
Inheritance diagram for openstudio::model::TimeDependentValuation:Public Member Functions | |
Getters | |
| boost::optional < TimeDependentValuationFile > | file (const openstudio::path &dir=openstudio::path()) const |
| Load from disk or return cached TDV file. More... | |
| boost::optional < TimeDependentValuationFile > | fileInSIUnits () const |
| Convert file() to SI units, or return cached converted file. More... | |
| boost::optional< Site > | site () const |
| Get the Site, if it exists. More... | |
| boost::optional< std::string > | url () const |
| Get the url string, if it exists. More... | |
| boost::optional< openstudio::path > | path () const |
| Get the path, if it exists. More... | |
| BuildingSector | activeBuildingSector () const |
| Time dependent valuation files specify different weightings for Commercial and Residential buildings. More... | |
| std::vector< FuelType > | availableFuelTypes () const |
| Return the FuelTypes for which time dependent valuations for activeBuildingSector() are available. More... | |
Setters | |
| bool | makeUrlRelative (const openstudio::path &basePath=openstudio::path()) |
| Save the url as relative to basePath, or just keep the file name and extension if basePath.empty(). More... | |
| bool | makeUrlAbsolute (const openstudio::path &searchDirectory) |
| Search for file and save the absolute url if successful. More... | |
| void | setActiveBuildingSector (const BuildingSector §or) |
| Set the active building sector. More... | |
Queries | |
| boost::optional< double > | energyTimeDependentValuation (const std::string &environmentPeriod=std::string()) const |
| Get the total energy time dependent valuation (J). More... | |
| boost::optional< double > | costTimeDependentValuation (const std::string &environmentPeriod=std::string()) const |
| Get the total cost time dependent valuation (J). More... | |
| boost::optional< double > | getEnergyTimeDependentValuation (const FuelType &fuelType, const std::string &environmentPeriod=std::string()) const |
| Get the energy time dependent valuation for fuelType (J). More... | |
| boost::optional< double > | getCostTimeDependentValuation (const FuelType &fuelType, const std::string &environmentPeriod=std::string()) const |
| Get the cost time dependent valuation for fuelType ($). 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... | |
| 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 |
| 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) 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 |
| 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 (const std::vector< std::string > &values) |
| IdfExtensibleGroup | pushExtensibleGroup () |
| 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 () |
Static Public Member Functions | |
Static Methods | |
| 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 < TimeDependentValuation > | OptionalTimeDependentValuation |
| 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... | |
Constructors and Destructors | |
| static TimeDependentValuation | setTimeDependentValuation (Model &model, const TimeDependentValuationFile &tdvFile) |
| virtual | ~TimeDependentValuation () |
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) | |
TimeDependentValuation is a unique ModelObject that wraps OpenStudio IDD object 'OS:TimeDependentValuation'.
TimeDependentValuation is statically constructed from a TimeDependentValuationFile (see the core utilities documentation), and provides custom weightings of a building's energy use (total or by fuel type) on an 8760 basis. The file format is based on the California Energy Commission's time dependent valuation files.
|
inlinevirtual |
| BuildingSector openstudio::model::TimeDependentValuation::activeBuildingSector | ( | ) | const |
Time dependent valuation files specify different weightings for Commercial and Residential buildings.
Active building sector defines which set of weightings are used to compute energyTimeDependentValuation, etc.
| std::vector<FuelType> openstudio::model::TimeDependentValuation::availableFuelTypes | ( | ) | const |
Return the FuelTypes for which time dependent valuations for activeBuildingSector() are available.
| boost::optional<double> openstudio::model::TimeDependentValuation::costTimeDependentValuation | ( | const std::string & | environmentPeriod = std::string() | ) | const |
| boost::optional<double> openstudio::model::TimeDependentValuation::energyTimeDependentValuation | ( | const std::string & | environmentPeriod = std::string() | ) | const |
| boost::optional<TimeDependentValuationFile> openstudio::model::TimeDependentValuation::file | ( | const openstudio::path & | dir = openstudio::path() | ) | const |
Load from disk or return cached TDV file.
Caches on successful load.
| boost::optional<TimeDependentValuationFile> openstudio::model::TimeDependentValuation::fileInSIUnits | ( | ) | const |
Convert file() to SI units, or return cached converted file.
Caches on successful conversion.
| boost::optional<double> openstudio::model::TimeDependentValuation::getCostTimeDependentValuation | ( | const FuelType & | fuelType, |
| const std::string & | environmentPeriod = std::string() |
||
| ) | const |
| boost::optional<double> openstudio::model::TimeDependentValuation::getEnergyTimeDependentValuation | ( | const FuelType & | fuelType, |
| const std::string & | environmentPeriod = std::string() |
||
| ) | const |
|
static |
| bool openstudio::model::TimeDependentValuation::makeUrlAbsolute | ( | const openstudio::path & | searchDirectory | ) |
Search for file and save the absolute url if successful.
| bool openstudio::model::TimeDependentValuation::makeUrlRelative | ( | const openstudio::path & | basePath = openstudio::path() | ) |
Save the url as relative to basePath, or just keep the file name and extension if basePath.empty().
| boost::optional<openstudio::path> openstudio::model::TimeDependentValuation::path | ( | ) | const |
Get the path, if it exists.
| void openstudio::model::TimeDependentValuation::setActiveBuildingSector | ( | const BuildingSector & | sector | ) |
Set the active building sector.
Time dependent valuation files specify different weightings for Commercial and Residential buildings. Active building sector defines which set of weightings are used to compute energyTimeDependentValuation, etc.
|
static |
| boost::optional<Site> openstudio::model::TimeDependentValuation::site | ( | ) | const |
Get the Site, if it exists.
| boost::optional<std::string> openstudio::model::TimeDependentValuation::url | ( | ) | const |
Get the url string, if it exists.
|
related |