openstudio::TimeDependentValuationFile Class Reference

#include <TimeDependentValuationFile.hpp>

Public Member Functions
Getters
openstudio::path	path () const
std::string	name () const
std::string	description () const
boost::optional< double >	nominalCommercialCostOfEnergy () const
	Cost of energy for commercial buildings associated with this file, in $/J. More...
boost::optional< double >	nominalResidentialCostOfEnergy () const
	Cost of energy for residential buildings associated with this file, in $/J. More...
std::string	checksum () const
FuelType	fuelType (unsigned columnIndex) const
BuildingSector	buildingSector (unsigned columnIndex) const
std::string	units (unsigned columnIndex) const
std::vector< double >	values (unsigned columnIndex) const
std::vector< Quantity >	quantities (unsigned columnIndex) const
Setters
boost::optional < TimeDependentValuationFile >	convertUnits (UnitSystem targetSystem=UnitSystem::SI) const
	Returns a TimeDependentValuationFile with system() == targetSystem, if possible. More...
Queries
unsigned	numColumns () const
UnitSystem	system () const

Related Functions
(Note that these are not member functions.)
typedef boost::optional < TimeDependentValuationFile >	OptionalTimeDependentValuationFile

Serialization
bool	save (const openstudio::path &p, bool overwrite=false)
static boost::optional < TimeDependentValuationFile >	load (const openstudio::path &p)
	Load file from path. More...

Member Function Documentation

BuildingSector openstudio::TimeDependentValuationFile::buildingSector

(

unsigned

columnIndex

)

const

std::string openstudio::TimeDependentValuationFile::checksum

(

)

const

boost::optional<TimeDependentValuationFile> openstudio::TimeDependentValuationFile::convertUnits

(

UnitSystem

targetSystem = UnitSystem::SI

)

const

Returns a TimeDependentValuationFile with system() == targetSystem, if possible.

If the file is already in the given system, returns a copy of this object. Otherwise, creates a new file with empty path(). Save the new file to populate its path.

std::string openstudio::TimeDependentValuationFile::description

(

)

const

FuelType openstudio::TimeDependentValuationFile::fuelType

(

unsigned

columnIndex

)

const

static boost::optional<TimeDependentValuationFile> openstudio::TimeDependentValuationFile::load ( const openstudio::path &  p )

static

Load file from path.

Only successful if file opens, name can be located, and each data column can be identified with a fuel type, a building sector, units, and 8760 real values. Does not check for existence/validity of nominal cost of energy. If that is not present or parsable, the ModelObject will always return boost::none for cost-based TDV values.

std::string openstudio::TimeDependentValuationFile::name

(

)

const

boost::optional<double> openstudio::TimeDependentValuationFile::nominalCommercialCostOfEnergy

(

)

const

Cost of energy for commercial buildings associated with this file, in $/J.

boost::optional<double> openstudio::TimeDependentValuationFile::nominalResidentialCostOfEnergy

(

)

const

Cost of energy for residential buildings associated with this file, in $/J.

unsigned openstudio::TimeDependentValuationFile::numColumns

(

)

const

openstudio::path openstudio::TimeDependentValuationFile::path

(

)

const

std::vector<Quantity> openstudio::TimeDependentValuationFile::quantities

(

unsigned

columnIndex

)

const

bool openstudio::TimeDependentValuationFile::save	(	const openstudio::path &	p,
		bool	overwrite = false
	)

UnitSystem openstudio::TimeDependentValuationFile::system

(

)

const

std::string openstudio::TimeDependentValuationFile::units

(

unsigned

columnIndex

)

const

std::vector<double> openstudio::TimeDependentValuationFile::values

(

unsigned

columnIndex

)

const

Friends And Related Function Documentation

typedef boost::optional<TimeDependentValuationFile> OptionalTimeDependentValuationFile

related