A class that contains complemental information about a DataSet that holds observations of a time series. More...

#include <TimeSeriesDataSetType.h>

Public Member Functions
int	getBeginTimePropIdx () const
	It returns the property index that contains the begin time associated to the time series. More...

int	getEndTimePropIdx () const
	It returns the property index that contains the final time associated to the time series. More...

int	getGeomPropIdx () const
	It returns the property index that contains the time series location. More...

std::string	getId () const
	It returns the time series id. More...

int	getIdPropIdx () const
	It returns the property index that contains the time series identifications. More...

int	getTimePropIdx () const
	It returns the property index that contains the times associated to the time series. More...

const ObservationDataSetType &	getType () const
	It returns the observation data set type. More...

const std::vector< int > &	getValuePropIdx () const
	It returns the indexes of the properties that contains the values associated to the time series. More...

void	setId (const std::string &id)
	It sets the time series id. More...

void	setIdPropIdx (int idx)
	It sets the property index that contains the time series identifications. More...

	TimeSeriesDataSetType (int tPropIdx, int vPropIdx, int gPropIdx, int idPropIdx, const std::string &id)
	Constructor. More...

	TimeSeriesDataSetType (const std::vector< int > &tPropIdxs, const std::vector< int > &vPropIdxs, int gPropIdx, int idPropIdx, const std::string &id)
	Constructor. More...

	TimeSeriesDataSetType (const ObservationDataSetType &type, const std::vector< int > &vPropIdxs, int idPropIdx, const std::string &id)
	Constructor. More...

virtual	~TimeSeriesDataSetType ()
	Virtual destructor. More...

Protected Attributes
std::string	m_id
	The time series id. More...

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

ObservationDataSetType	m_obsType
	The internal observation data set type. More...

std::vector< int >	m_vlPropIdxs
	The indexes of the properties that contain the time series values. More...

Detailed Description

A class that contains complemental information about a DataSet that holds observations of a time series.

A time series represents the variation of the values of a property over time.

See also: ObservationDataSet ObservationDataSetType

Definition at line 50 of file TimeSeriesDataSetType.h.

Constructor & Destructor Documentation

te::st::TimeSeriesDataSetType::TimeSeriesDataSetType	(	int	tPropIdx,
		int	vPropIdx,
		int	gPropIdx,
		int	idPropIdx,
		const std::string &	id
	)

Constructor.

Parameters

tPropIdx	The index of the property that contains the times of a time series.
vPropIdx	The index of the property that contains the values of the time series.
gPropIdx	The index of the property that contains the location of the time series.
idPropIdx	The index of the property that contains the identity of the time series.
id	The trajectory id.

Definition at line 30 of file TimeSeriesDataSetType.cpp.

te::st::TimeSeriesDataSetType::TimeSeriesDataSetType	(	const std::vector< int > &	tPropIdxs,
		const std::vector< int > &	vPropIdxs,
		int	gPropIdx,
		int	idPropIdx,
		const std::string &	id
	)

Constructor.

Parameters

tPropIdxs	The indexes of the properties that contains the beginning and final times of a time series.
vPropIdxs	The indexes of the properties that contains the values of a time series.
gPropIdx	The index of the property that contains the geometries of a time series.
idPropIdx	The index of the property that contains the identity of the time series.
id	The trajectory id.

Definition at line 39 of file TimeSeriesDataSetType.cpp.

te::st::TimeSeriesDataSetType::TimeSeriesDataSetType	(	const ObservationDataSetType &	type,
		const std::vector< int > &	vPropIdxs,
		int	idPropIdx,
		const std::string &	id
	)

Constructor.

Parameters

type	The ObservationSetType
vPropIdxs	The indexes of the properties that contains the values of a time series.
idPropIdx	The property index that contains the time series identification.
id	The time series id.

Note: idPropIdx equal to "-1" means that the DataSet contains observations of only one time series.

Definition at line 49 of file TimeSeriesDataSetType.cpp.

te::st::TimeSeriesDataSetType::~TimeSeriesDataSetType ( )

virtual

Virtual destructor.

Definition at line 111 of file TimeSeriesDataSetType.cpp.

Member Function Documentation

int te::st::TimeSeriesDataSetType::getBeginTimePropIdx ( ) const

It returns the property index that contains the begin time associated to the time series.

Returns: The property index that contains the begin times associated to the time series.

Definition at line 70 of file TimeSeriesDataSetType.cpp.

int te::st::TimeSeriesDataSetType::getEndTimePropIdx ( ) const

It returns the property index that contains the final time associated to the time series.

Returns: The property index that contains the end time associated to the time series.

Definition at line 75 of file TimeSeriesDataSetType.cpp.

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

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

Returns: The property index that contains the time series location.

Definition at line 86 of file TimeSeriesDataSetType.cpp.

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

It returns the time series id.

Returns: The time series id.

Definition at line 101 of file TimeSeriesDataSetType.cpp.

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

It returns the property index that contains the time series identifications.

Returns: The property index that contains the time series identifications.

Definition at line 91 of file TimeSeriesDataSetType.cpp.

int te::st::TimeSeriesDataSetType::getTimePropIdx ( ) const

It returns the property index that contains the times associated to the time series.

Returns: The property index that contains the times associated to the time series.

Definition at line 65 of file TimeSeriesDataSetType.cpp.

const te::st::ObservationDataSetType & te::st::TimeSeriesDataSetType::getType ( ) const

It returns the observation data set type.

Returns: The observation set type.

Definition at line 60 of file TimeSeriesDataSetType.cpp.

const std::vector< int > & te::st::TimeSeriesDataSetType::getValuePropIdx ( ) const

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

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

Definition at line 81 of file TimeSeriesDataSetType.cpp.

void te::st::TimeSeriesDataSetType::setId ( const std::string & id )

It sets the time series id.

Parameters

id	The time series id.

Definition at line 106 of file TimeSeriesDataSetType.cpp.

void te::st::TimeSeriesDataSetType::setIdPropIdx ( int idx )

It sets the property index that contains the time series identifications.

Parameters

idx	The property index that contains the time series identifications.

Definition at line 96 of file TimeSeriesDataSetType.cpp.

Member Data Documentation

std::string te::st::TimeSeriesDataSetType::m_id

protected

The time series id.

Definition at line 169 of file TimeSeriesDataSetType.h.

int te::st::TimeSeriesDataSetType::m_idPropIdx

protected

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

Definition at line 168 of file TimeSeriesDataSetType.h.

ObservationDataSetType te::st::TimeSeriesDataSetType::m_obsType

protected

The internal observation data set type.

Definition at line 166 of file TimeSeriesDataSetType.h.

std::vector<int> te::st::TimeSeriesDataSetType::m_vlPropIdxs

protected

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

Definition at line 167 of file TimeSeriesDataSetType.h.

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

C:/BB_TL5/terralib5/src/terralib/st/core/timeseries/TimeSeriesDataSetType.h
C:/BB_TL5/terralib5/src/terralib/st/core/timeseries/TimeSeriesDataSetType.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation