openstudio::contam::CvFile Class Reference

#include <ForwardTranslator.hpp>

Public Member Functions
void	addTimeSeries (std::string name, TimeSeries series)
	Add a time series to the data contained in the object. More...
void	clear ()
	Clear the object and make it empty. More...
	CvFile ()
	Construct a new, empty object. More...
Date	end () const
	Returns the end date of the data that will be written. More...
bool	isEmpty ()
	Returns true if the object has no time series. More...
void	setEnd (Date date)
	Set the end date of the data that will be written. More...
void	setStart (Date date)
	Set the start date of the data that will be written. More...
Date	start () const
	Returns the start date of the data that will be written. More...
bool	write (openstudio::path filepath)
	Write out CVF-formatted data to the specified path. More...

Detailed Description

CvFile is a container for data that is to be written to a CONTAM CVF.

CvFile contains time series data that is to be written to a CONTAM Continuous Values File, which is documented here:

www.bfrl.nist.gov/IAQanalysis/CONTAM/manual/Content/html/IDH_UsingControls_CVF.htm

Data is input as TimeSeries that should cover the entire time period to be simulated. TimeSeries with Celcius units will be converted to Kelvin on output. All other TimeSeries should be in the units CONTAM expects.

Constructor & Destructor Documentation

openstudio::contam::CvFile::CvFile

(

)

Construct a new, empty object.

Member Function Documentation

void openstudio::contam::CvFile::addTimeSeries	(	std::string	name,
		TimeSeries	series
	)

Add a time series to the data contained in the object.

void openstudio::contam::CvFile::clear

(

)

Clear the object and make it empty.

Date openstudio::contam::CvFile::end ( ) const

inline

Returns the end date of the data that will be written.

bool openstudio::contam::CvFile::isEmpty ( )

inline

Returns true if the object has no time series.

void openstudio::contam::CvFile::setEnd ( Date  date )

inline

Set the end date of the data that will be written.

void openstudio::contam::CvFile::setStart ( Date  date )

inline

Set the start date of the data that will be written.

Date openstudio::contam::CvFile::start ( ) const

inline

Returns the start date of the data that will be written.

bool openstudio::contam::CvFile::write

(

openstudio::path

filepath

)

Write out CVF-formatted data to the specified path.