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 te::da::DataSourceInfogetDataSourceInfo () const
 It returns information about the DataSource from which the DataSet comes. More...
 
int getGeomPropIdx () const
 It returns the index of the DataSet property that contains the location of the time series. More...
 
std::string getId () const
 It returns the time series id that this DataSet contains. More...
 
int getIdPropIdx () const
 It returns the index of the DataSet property that contains the identification of each time series. More...
 
const ObservationDataSetInfogetObservationDataSetInfo () const
 It returns information about the DataSet that contians the time series observations. More...
 
const std::vector< int > & getTimePropIdxs () const
 It returns the indexes of the DataSet properties that contains the times associated to the time series. More...
 
const std::vector< int > & getValuePropIdxs () const
 It returns the indexes of the DataSet properties that contains the values associated to the time series. More...
 
 TimeSeriesDataSetInfo (const te::da::DataSourceInfo &dsinfo, const std::string &dsName, int tPropIdx, int vPropIdx, int gPropIdx, int idPropIdx, const std::string &id)
 Constructor. More...
 
 TimeSeriesDataSetInfo (const te::da::DataSourceInfo &dsinfo, const std::string &dsName, int tPropIdx, const std::vector< int > &vPropIdxs, int gPropIdx, int idPropIdx, const std::string &id)
 Constructor. More...
 
 TimeSeriesDataSetInfo (const ObservationDataSetInfo &info, int idPropIdx, const std::string &id)
 Constructor. More...
 
virtual ~TimeSeriesDataSetInfo ()
 Virtual destructor. More...
 

Protected Attributes

std::string m_id
 The time series id that this DataSet contains. More...
 
int m_idPropIdx
 The property index that contains the identification of each time series. More...
 
ObservationDataSetInfo m_obsDsInfo
 Infos about the DataSource and DataSet that contains the time series observations. More...
 
std::vector< int > m_vlPropIdxs
 The indexes 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,
int  tPropIdx,
int  vPropIdx,
int  gPropIdx,
int  idPropIdx,
const std::string &  id 
)

Constructor.

Parameters
dsinfoInfos about the DataSource.
dsNameThe DataSet name.
tPropIdxThe property index that contains the times associated to the time series.
vPropIdxThe property index that contains the attribute values associated to the time series.
gPropIdxThe property index that contains the geometry associated to the time series.
idPropIdxThe property index that contains the identification of each time series.
idThe identification of the time series that this DataSet contains.

Definition at line 33 of file TimeSeriesDataSetInfo.cpp.

te::st::TimeSeriesDataSetInfo::TimeSeriesDataSetInfo ( const te::da::DataSourceInfo dsinfo,
const std::string &  dsName,
int  tPropIdx,
const std::vector< int > &  vPropIdxs,
int  gPropIdx,
int  idPropIdx,
const std::string &  id 
)

Constructor.

Parameters
dsinfoInfos about the DataSource.
dsNameThe DataSet name.
tPropIdxThe property index that contains the times associated to the time series.
vPropIdxsThe property indexes that contain the attribute values associated to the time series.
gPropIdxThe property index that contains the geometry associated to the time series.
idPropIdxThe property index that contains the identification of each time series.
idThe identification of the time series that this DataSet contains.

Definition at line 43 of file TimeSeriesDataSetInfo.cpp.

te::st::TimeSeriesDataSetInfo::TimeSeriesDataSetInfo ( const ObservationDataSetInfo info,
int  idPropIdx,
const std::string &  id 
)

Constructor.

Parameters
infoInfos about the DataSource and DataSet that contains the trajectory observations
idPropIdxThe property index that contains the identification of each trajectory.
idThe identification of the trajectory hat this DataSet contains.

Definition at line 54 of file TimeSeriesDataSetInfo.cpp.

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

Virtual destructor.

Definition at line 102 of file TimeSeriesDataSetInfo.cpp.

Member Function Documentation

const te::da::DataSourceInfo & te::st::TimeSeriesDataSetInfo::getDataSourceInfo ( ) const

It returns information about the DataSource from which the DataSet comes.

Returns
A reference to the internal DataSourceInfo.

Definition at line 70 of file TimeSeriesDataSetInfo.cpp.

Referenced by te::st::STDataLoaderFromDS::getDataSet(), te::st::STDataLoaderFromMemDS::getDataSet(), te::st::STDataLoader::getDataSet(), te::st::STDataLoader::getInfo(), te::st::STDataLoaderFromMemDS::getTemporalExtent(), and te::st::STDataLoader::getTemporalExtent().

int te::st::TimeSeriesDataSetInfo::getGeomPropIdx ( ) const

It returns the index of the DataSet property that contains the location of the time series.

Returns
The index of the DataSet property that contains the location of the time series.

Definition at line 87 of file TimeSeriesDataSetInfo.cpp.

std::string te::st::TimeSeriesDataSetInfo::getId ( ) const

It returns the time series id that this DataSet contains.

Returns
The time series id.

Definition at line 97 of file TimeSeriesDataSetInfo.cpp.

Referenced by te::st::GetType().

int te::st::TimeSeriesDataSetInfo::getIdPropIdx ( ) const

It returns the index of the DataSet property that contains the identification of each time series.

Returns
The index of the DataSet property that contains the identification of each time series.

Definition at line 92 of file TimeSeriesDataSetInfo.cpp.

Referenced by te::st::GetType().

const te::st::ObservationDataSetInfo & te::st::TimeSeriesDataSetInfo::getObservationDataSetInfo ( ) const

It returns information about the DataSet that contians the time series observations.

Returns
A reference to the internal ObservationDataSetInfo.

Definition at line 64 of file TimeSeriesDataSetInfo.cpp.

Referenced by te::st::STDataLoaderFromDS::getDataSet(), te::st::STDataLoaderFromMemDS::getDataSet(), te::st::STDataLoaderFromMemDS::getTemporalExtent(), and te::st::GetType().

const std::vector< int > & te::st::TimeSeriesDataSetInfo::getTimePropIdxs ( ) const

It returns the indexes of the DataSet properties that contains the times associated to the time series.

Returns
The indexes of the DataSet properties that contains the time.

Definition at line 76 of file TimeSeriesDataSetInfo.cpp.

const std::vector< int > & te::st::TimeSeriesDataSetInfo::getValuePropIdxs ( ) const

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

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

Definition at line 82 of file TimeSeriesDataSetInfo.cpp.

Referenced by te::st::GetType().

Member Data Documentation

std::string te::st::TimeSeriesDataSetInfo::m_id
protected

The time series id that this DataSet contains.

Definition at line 163 of file TimeSeriesDataSetInfo.h.

int te::st::TimeSeriesDataSetInfo::m_idPropIdx
protected

The property index that contains the identification of each time series.

Definition at line 162 of file TimeSeriesDataSetInfo.h.

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

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

Definition at line 160 of file TimeSeriesDataSetInfo.h.

std::vector<int> te::st::TimeSeriesDataSetInfo::m_vlPropIdxs
protected

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

Definition at line 161 of file TimeSeriesDataSetInfo.h.


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