openstudio::SqlFileTimeSeriesQuery Class Reference

#include <SqlFileTimeSeriesQuery.hpp>

Public Member Functions
Constructors
	SqlFileTimeSeriesQuery (const boost::optional< openstudio::EnvironmentIdentifier > &oEnvId=boost::none, const boost::optional< openstudio::ReportingFrequency > &oRF=boost::none, const boost::optional< openstudio::TimeSeriesIdentifier > &oTsId=boost::none, const boost::optional< openstudio::KeyValueIdentifier > &oKvId=boost::none)
	Constructor from optionals.
	SqlFileTimeSeriesQuery (const EnvironmentIdentifier &envId)
	Constructor from EnvironmentIdentifier.
	SqlFileTimeSeriesQuery (const std::string &environmentPeriod, const openstudio::ReportingFrequency &reportingFrequency, const std::string &timeSeriesName, const std::string &keyValue)
	Construct from fully specified query.
Getters
boost::optional< openstudio::EnvironmentIdentifier >	environment () const
	Get the EnvironmentIdentifier.
boost::optional< openstudio::ReportingFrequency >	reportingFrequency () const
	Get the ReportingFrequency.
boost::optional< openstudio::TimeSeriesIdentifier >	timeSeries () const
	Get the time series identifier.
boost::optional< openstudio::KeyValueIdentifier >	keyValues () const
	Get the key value identifier.
bool	vetted () const
	Returns true if this query has been vetted (expended) by a SqlFile.

Setters
bool	m_vetted
void	setEnvironment (const EnvironmentIdentifier &envId)
	Set the EnvironmentIdentifier.
void	setReportingFrequency (const openstudio::ReportingFrequency &rf)
	Set the ReportingFrequency.
void	setTimeSeries (const TimeSeriesIdentifier &tsId)
	Set the TimeSeries NameIdentifier.
void	setKeyValues (const KeyValueIdentifier &kvId)
	Set the KeyValues NameIdentifier.
void	clearEnvironment ()
	Remove any EnvironmentIdentifier.
void	clearReportingFrequency ()
	Remove any ReportingFrequency.
void	clearTimeSeries ()
	Remove any TimeSeries.
void	clearKeyValues ()
	Remove any KeyValues.

Detailed Description

Class to hold information about one or more SqlFile time series of interest.

The query is limited to one ReportingFrequency so that the resulting TimeSeries.values() Vectors are of the same length. This class is intended to serve as a way to streamline the SqlFile interface, and also as data storage for classes like analysis::SqlTimeSeriesVariableAccessor.

Constructor & Destructor Documentation

SqlFileTimeSeriesQuery() [1/3]

openstudio::SqlFileTimeSeriesQuery::SqlFileTimeSeriesQuery	(	const boost::optional< openstudio::EnvironmentIdentifier > &	oEnvId = boost::none,
		const boost::optional< openstudio::ReportingFrequency > &	oRF = boost::none,
		const boost::optional< openstudio::TimeSeriesIdentifier > &	oTsId = boost::none,
		const boost::optional< openstudio::KeyValueIdentifier > &	oKvId = boost::none )

Constructor from optionals.

Environment period, reporting frequency, time series, and key values can all be specified (or not).

SqlFileTimeSeriesQuery() [2/3]

openstudio::SqlFileTimeSeriesQuery::SqlFileTimeSeriesQuery

(

const EnvironmentIdentifier &

envId

)

Constructor from EnvironmentIdentifier.

SqlFileTimeSeriesQuery() [3/3]

openstudio::SqlFileTimeSeriesQuery::SqlFileTimeSeriesQuery	(	const std::string &	environmentPeriod,
		const openstudio::ReportingFrequency &	reportingFrequency,
		const std::string &	timeSeriesName,
		const std::string &	keyValue )

Construct from fully specified query.

Member Function Documentation

clearEnvironment()

void openstudio::SqlFileTimeSeriesQuery::clearEnvironment

(

)

Remove any EnvironmentIdentifier.

clearKeyValues()

void openstudio::SqlFileTimeSeriesQuery::clearKeyValues

(

)

Remove any KeyValues.

clearReportingFrequency()

void openstudio::SqlFileTimeSeriesQuery::clearReportingFrequency

(

)

Remove any ReportingFrequency.

clearTimeSeries()

void openstudio::SqlFileTimeSeriesQuery::clearTimeSeries

(

)

Remove any TimeSeries.

environment()

boost::optional< openstudio::EnvironmentIdentifier > openstudio::SqlFileTimeSeriesQuery::environment

(

)

const

Get the EnvironmentIdentifier.

keyValues()

boost::optional< openstudio::KeyValueIdentifier > openstudio::SqlFileTimeSeriesQuery::keyValues

(

)

const

Get the key value identifier.

reportingFrequency()

boost::optional< openstudio::ReportingFrequency > openstudio::SqlFileTimeSeriesQuery::reportingFrequency

(

)

const

Get the ReportingFrequency.

setEnvironment()

void openstudio::SqlFileTimeSeriesQuery::setEnvironment

(

const EnvironmentIdentifier &

envId

)

Set the EnvironmentIdentifier.

setKeyValues()

void openstudio::SqlFileTimeSeriesQuery::setKeyValues

(

const KeyValueIdentifier &

kvId

)

Set the KeyValues NameIdentifier.

setReportingFrequency()

void openstudio::SqlFileTimeSeriesQuery::setReportingFrequency

(

const openstudio::ReportingFrequency &

rf

)

Set the ReportingFrequency.

setTimeSeries()

void openstudio::SqlFileTimeSeriesQuery::setTimeSeries

(

const TimeSeriesIdentifier &

tsId

)

Set the TimeSeries NameIdentifier.

timeSeries()

boost::optional< openstudio::TimeSeriesIdentifier > openstudio::SqlFileTimeSeriesQuery::timeSeries

(

)

const

Get the time series identifier.

vetted()

bool openstudio::SqlFileTimeSeriesQuery::vetted

(

)

const

Returns true if this query has been vetted (expended) by a SqlFile.

Member Data Documentation

m_vetted

bool openstudio::SqlFileTimeSeriesQuery::m_vetted

protected