All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
te::st::TimeSeriesDataSetInfo Class Reference

A class that contains infos about a DataSet that contains observations of one or more time series. More...

#include <TimeSeriesDataSetInfo.h>

Public Member Functions

const ObservationDataSetInfogetObservationDataSetInfo () const
 It returns information about the DataSet that contains the time series observations. More...
 
const std::vector< std::string > & getValuePropNames () const
 It returns the names of the DataSet properties that contains the values associated to the time series. More...
 
 TimeSeriesDataSetInfo (const te::da::DataSourceInfo &dsinfo, const std::string &dsName, const std::string &tPropName, const std::string &vPropName, const std::string &gPropName, const std::string &idPropName, const std::string &id)
 Constructor. More...
 
 TimeSeriesDataSetInfo (const te::da::DataSourceInfo &dsinfo, const std::string &dsName, const std::string &tPropName, const std::vector< std::string > &vPropNames, const std::string &gPropName, const std::string &idPropName, const std::string &id)
 Constructor. More...
 
 TimeSeriesDataSetInfo (const ObservationDataSetInfo &info, const std::vector< std::string > &valPropNames)
 Constructor. More...
 
virtual ~TimeSeriesDataSetInfo ()
 Virtual destructor. More...
 

Protected Attributes

ObservationDataSetInfo m_obsDsInfo
 Infos about the DataSource and DataSet that contains the time series observations. More...
 
std::vector< std::string > m_vlPropNames
 The names of the properties that contain the time series values. More...
 

Detailed Description

A class that contains infos about a DataSet that contains observations of one or more time series.

Time series: Geometry, Time -> Value.

This class contains information about a DataSet that contains observations of one or more time series. This information includes: (1) the DataSource which it is from and the DataSet name (2) the DataSet properties that contain the time and the observed attribute values (it can be one or more observed attributes) and the identity of each time series.

See also
ObservationDataSetInfo

Definition at line 60 of file TimeSeriesDataSetInfo.h.

Constructor & Destructor Documentation

te::st::TimeSeriesDataSetInfo::TimeSeriesDataSetInfo ( const te::da::DataSourceInfo dsinfo,
const std::string &  dsName,
const std::string &  tPropName,
const std::string &  vPropName,
const std::string &  gPropName,
const std::string &  idPropName,
const std::string &  id 
)

Constructor.

Parameters
dsinfoInfos about the DataSource.
dsNameThe DataSet name.
tPropNameThe property name that contains the times associated to the time series.
vPropNameThe property name that contains the attribute values associated to the time series.
gPropNameThe property name that contains the geometry associated to the time series.
idPropNameThe property name that contains the identification of each time series.
idThe identification of the time series that this DataSet contains.

Definition at line 36 of file TimeSeriesDataSetInfo.cpp.

References m_obsDsInfo, m_vlPropNames, te::st::ObservationDataSetInfo::setGeomPropInfo(), te::st::ObservationDataSetInfo::setId(), te::st::ObservationDataSetInfo::setIdPropInfo(), te::st::ObservationDataSetInfo::setObsPropInfo(), and te::st::ObservationDataSetInfo::setTimePropInfo().

te::st::TimeSeriesDataSetInfo::TimeSeriesDataSetInfo ( const te::da::DataSourceInfo dsinfo,
const std::string &  dsName,
const std::string &  tPropName,
const std::vector< std::string > &  vPropNames,
const std::string &  gPropName,
const std::string &  idPropName,
const std::string &  id 
)

Constructor.

Parameters
dsinfoInfos about the DataSource.
dsNameThe DataSet name.
tPropNameThe property name that contains the times associated to the time series.
vPropNameThe property name that contains the attribute values associated to the time series.
gPropNameThe property name that contains the geometry associated to the time series.
idPropNameThe property name that contains the identification of each time series.
idThe identification of the time series that this DataSet contains.

Definition at line 60 of file TimeSeriesDataSetInfo.cpp.

References m_obsDsInfo, te::st::ObservationDataSetInfo::setGeomPropInfo(), te::st::ObservationDataSetInfo::setId(), te::st::ObservationDataSetInfo::setIdPropInfo(), te::st::ObservationDataSetInfo::setObsPropInfo(), and te::st::ObservationDataSetInfo::setTimePropInfo().

te::st::TimeSeriesDataSetInfo::TimeSeriesDataSetInfo ( const ObservationDataSetInfo info,
const std::vector< std::string > &  valPropNames 
)

Constructor.

Parameters
infoInfos about the DataSource and DataSet that contains the time series observations
valPropNamesThe property names that contains the time series values.

Definition at line 81 of file TimeSeriesDataSetInfo.cpp.

te::st::TimeSeriesDataSetInfo::~TimeSeriesDataSetInfo ( )
virtual

Virtual destructor.

Definition at line 100 of file TimeSeriesDataSetInfo.cpp.

Member Function Documentation

const std::vector< std::string > & te::st::TimeSeriesDataSetInfo::getValuePropNames ( ) const

It returns the names of the DataSet properties that contains the values associated to the time series.

Returns
The names of the DataSet properties that contains the observed values.

Definition at line 95 of file TimeSeriesDataSetInfo.cpp.

Referenced by te::st::STDataLoaderFromDS::buildDataSet(), and te::st::STDataLoaderFromMemDS::buildDataSet().

Member Data Documentation

ObservationDataSetInfo te::st::TimeSeriesDataSetInfo::m_obsDsInfo
protected

Infos about the DataSource and DataSet that contains the time series observations.

Definition at line 121 of file TimeSeriesDataSetInfo.h.

Referenced by TimeSeriesDataSetInfo().

std::vector<std::string> te::st::TimeSeriesDataSetInfo::m_vlPropNames
protected

The names of the properties that contain the time series values.

Definition at line 122 of file TimeSeriesDataSetInfo.h.

Referenced by TimeSeriesDataSetInfo().


The documentation for this class was generated from the following files: