A class to represent a time series data set. More...

#include <TimeSeriesDataSet.h>

Inheritance diagram for te::st::TimeSeriesDataSet:

Public Member Functions
std::string	getId () const
	It returns the identifier associated to the time series. More...

ObservationDataSet *	getObservationSet () const
	It returns the data set that contains the time series observations. More...

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

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

void	setValuePropNames (const std::vector< std::string > &n)
	It sets the names of the DataSet properties that contains the values associated to the time series. More...

std::size_t	size () const
	It returns the size of the time series observation set. More...

	TimeSeriesDataSet (ObservationDataSet *obs, const std::vector< std::string > &propNames, const std::string &id)
	Constructor. More...

	TimeSeriesDataSet (te::da::DataSet *ds, const ObservationDataSetType &type, const std::vector< std::string > &propNames)
	Constructor. More...

	TimeSeriesDataSet (te::da::DataSet *ds, const ObservationDataSetType &type, const std::vector< std::string > &propNames, const std::string &id)
	Constructor. More...

Methods to traverse the trajectory observations and to check the
internal cursor pointer
bool	moveNext ()

bool	movePrevious ()

bool	moveFirst ()

bool	moveBeforeFirst ()

bool	moveLast ()

bool	isAtBegin () const

bool	isBeforeBegin () const

bool	isAtEnd () const

bool	isAfterEnd () const

Friends
class	TimeSeriesDataSetLayer

Methods to get values pointed by the internal cursor.
std::unique_ptr< ObservationDataSet >	m_obsDs
	The data set that contains the trajectory observations. More...

std::vector< std::string >	m_vlPropNames
	The names of the properties that contain the time series values. More...

std::string	m_id
	The time series identification. More...

std::unique_ptr< te::dt::DateTime >	getTime () const
	It returns the time pointed by the internal cursor. More...

std::unique_ptr< te::dt::AbstractData >	getValue (std::size_t idx) const
	It returns the idx-th observed value pointed by the internal cursor. More...

std::unique_ptr< te::dt::AbstractData >	getValue () const
	It returns the observed value pointed by the internal cursor. More...

double	getDouble (std::size_t idx) const
	It returns the idx-th observed value as double pointed by the internal cursor. More...

double	getDouble () const
	It returns the observed value as double pointed by the internal cursor. More...

int	getInt (std::size_t idx) const
	It returns the idx-th observed value as integer pointed by the internal cursor. More...

int	getInt () const
	It returns the observed value as double pointed by the internal cursor. More...

std::unique_ptr< te::gm::Geometry >	getGeometry () const
	It returns the geometry pointed by the internal cursor. More...

const te::dt::DateTimePeriod *	getTemporalExtent () const
	It returns the temporal extent of the time series observations. More...

std::unique_ptr< TimeSeries >	getTimeSeries (te::st::AbstractTimeSeriesInterp *interp)
	It returns the time series from the DataSet. More...

std::unique_ptr< TimeSeries >	getTimeSeries (const std::string &propName, te::st::AbstractTimeSeriesInterp *interp)
	It returns the time series from the DataSet. More...

void	getTimeSeriesSet (te::st::AbstractTimeSeriesInterp interp, const std::string &vPropName, std::vector< te::st::TimeSeries > &result)
	It returns all time series from the DataSet. More...

virtual	~TimeSeriesDataSet ()
	It returns the trajectory geometry property. More...

std::unique_ptr< te::da::DataSet >	release ()
	It releases all internal pointers, returning its internal DataSet and invalidating itself. More...

Detailed Description

A class to represent a time series data set.

This class represents a view on a DataSet that contains observations of time series. A time series represents the variation of the values of a property over time.

A TimeSeriesDataSet can contain one or more properties observed over time.

See also: ObservationDataSet ObservationDatasSetType TimeSeriesDataSetType

Definition at line 69 of file TimeSeriesDataSet.h.

Constructor & Destructor Documentation

◆ TimeSeriesDataSet() [1/3]

te::st::TimeSeriesDataSet::TimeSeriesDataSet	(	te::da::DataSet *	ds,
		const ObservationDataSetType &	type,
		const std::vector< std::string > &	propNames
	)

Constructor.

Parameters

ds	The data set that contains the time series observations.
type	The observation data set type.
propNames	The names of the properties that contains the time series values

Note: It will take the ownership of the input pointer.

◆ TimeSeriesDataSet() [2/3]

te::st::TimeSeriesDataSet::TimeSeriesDataSet	(	te::da::DataSet *	ds,
		const ObservationDataSetType &	type,
		const std::vector< std::string > &	propNames,
		const std::string &	id
	)

Constructor.

Parameters

ds	The data set that contains the time series observations.
type	The observation data set type.
propNames	The names of the properties that contains the time series values
id	The time series id

Note: It will take the ownership of the input pointer.

◆ TimeSeriesDataSet() [3/3]

te::st::TimeSeriesDataSet::TimeSeriesDataSet	(	ObservationDataSet *	obs,
		const std::vector< std::string > &	propNames,
		const std::string &	id
	)

Constructor.

Parameters

obs	The data set that contains the time series observations.
propNames	The names of the properties that contains the time series values
id	The time series id

Note: It will take the ownership of the given pointer.

◆ ~TimeSeriesDataSet()

virtual te::st::TimeSeriesDataSet::~TimeSeriesDataSet ( )

virtual

It returns the trajectory geometry property.

Returns: The trajectory geometry property.

Note: The caller will NOT take the ownership of the returned pointer.

It returns the trajectory datetime property.

Returns: The trajectory datetime property.

Note: The caller will NOT take the ownership of the returned pointer.

Virtual destructor.

Member Function Documentation

◆ getDouble() [1/2]

double te::st::TimeSeriesDataSet::getDouble ( ) const

It returns the observed value as double pointed by the internal cursor.

Returns: A pointer to the observed value as double pointed by the internal cursor.

◆ getDouble() [2/2]

double te::st::TimeSeriesDataSet::getDouble ( std::size_t idx ) const

It returns the idx-th observed value as double pointed by the internal cursor.

Returns: A pointer to the idx-th observed value as double pointed by the internal cursor.

◆ getGeometry()

std::unique_ptr< te::gm::Geometry > te::st::TimeSeriesDataSet::getGeometry ( ) const

It returns the geometry pointed by the internal cursor.

Returns: A pointer to the geometry pointed by the internal cursor.

Note: The caller will take the ownership of the returned pointer.

◆ getId()

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

It returns the identifier associated to the time series.

Returns: The identifier associated to the time series.

◆ getInt() [1/2]

int te::st::TimeSeriesDataSet::getInt ( ) const

It returns the observed value as double pointed by the internal cursor.

Returns: A pointer to the observed value as double pointed by the internal cursor.

Note: It returns a 32-bit integer.

◆ getInt() [2/2]

int te::st::TimeSeriesDataSet::getInt ( std::size_t idx ) const

It returns the idx-th observed value as integer pointed by the internal cursor.

Returns: A pointer to the idx-th observed value as integer pointed by the internal cursor.

Note: It returns a 32-bit integer.

◆ getObservationSet()

ObservationDataSet * te::st::TimeSeriesDataSet::getObservationSet ( ) const

It returns the data set that contains the time series observations.

Returns: A pointer to the data set that contains the time series observations.

Note: The caller will NOT take the ownership of the input pointer.

◆ getTemporalExtent()

const te::dt::DateTimePeriod * te::st::TimeSeriesDataSet::getTemporalExtent ( ) const

It returns the temporal extent of the time series observations.

Returns: The temporal extent of the trajectory observations.

Note: The caller will NOT take the ownership of the output pointer.

◆ getTime()

std::unique_ptr< te::dt::DateTime > te::st::TimeSeriesDataSet::getTime ( ) const

It returns the time pointed by the internal cursor.

Returns: A pointer to the time pointed by the internal cursor.

Note: The caller will take the ownership of the returned pointer.

◆ getTimeSeries() [1/2]

std::unique_ptr< TimeSeries > te::st::TimeSeriesDataSet::getTimeSeries	(	const std::string &	propName,
		te::st::AbstractTimeSeriesInterp *	interp
	)

It returns the time series from the DataSet.

This method encapsulates all observations of this DataSet as a TimeSeries type associated to a given interpolator.

Parameters

propName	The name of the observed property to be considered
interp	The time series interpolator.

Returns: The time series associated to a given interpolator.

Note: The caller will take the ownership of the returned pointer.

◆ getTimeSeries() [2/2]

std::unique_ptr< TimeSeries > te::st::TimeSeriesDataSet::getTimeSeries ( te::st::AbstractTimeSeriesInterp * interp )

It returns the time series from the DataSet.

This method encapsulates all observations of this DataSet as a TimeSeries type associated to a given interpolator.

Parameters

interp The time series interpolator.

Returns: The time series associated to a given interpolator.

Note: The caller will take the ownership of the returned pointer.; It uses the first observed property to generate the time series.

◆ getTimeSeriesSet()

void te::st::TimeSeriesDataSet::getTimeSeriesSet	(	te::st::AbstractTimeSeriesInterp *	interp,
		const std::string &	vPropName,
		std::vector< te::st::TimeSeries * > &	result
	)

It returns all time series from the DataSet.

This method encapsulates all observations of this DataSet as a set of TimeSeries associated to a given interpolator.

Parameters

interp	The time series interpolator.
vPropName	The property name that contains the attribute values associated to a time series
result	The returned set of time series.

Note: The caller will take the ownership of the returned pointers.

◆ getValue() [1/2]

std::unique_ptr< te::dt::AbstractData > te::st::TimeSeriesDataSet::getValue ( ) const

It returns the observed value pointed by the internal cursor.

Returns: A pointer to the observed value pointed by the internal cursor.

Note: The caller will take the ownership of the returned pointer.

◆ getValue() [2/2]

std::unique_ptr< te::dt::AbstractData > te::st::TimeSeriesDataSet::getValue ( std::size_t idx ) const

It returns the idx-th observed value pointed by the internal cursor.

Returns: A pointer to the idx-th observed value pointed by the internal cursor.

Note: The caller will take the ownership of the returned pointer.

◆ getValuePropNames()

const std::vector< std::string > & te::st::TimeSeriesDataSet::getValuePropNames ( ) 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.

◆ isAfterEnd()

bool te::st::TimeSeriesDataSet::isAfterEnd ( ) const

◆ isAtBegin()

bool te::st::TimeSeriesDataSet::isAtBegin ( ) const

◆ isAtEnd()

bool te::st::TimeSeriesDataSet::isAtEnd ( ) const

◆ isBeforeBegin()

bool te::st::TimeSeriesDataSet::isBeforeBegin ( ) const

◆ moveBeforeFirst()

bool te::st::TimeSeriesDataSet::moveBeforeFirst ( )

◆ moveFirst()

bool te::st::TimeSeriesDataSet::moveFirst ( )

◆ moveLast()

bool te::st::TimeSeriesDataSet::moveLast ( )

◆ moveNext()

bool te::st::TimeSeriesDataSet::moveNext ( )

◆ movePrevious()

bool te::st::TimeSeriesDataSet::movePrevious ( )

◆ release()

std::unique_ptr< te::da::DataSet > te::st::TimeSeriesDataSet::release ( )

protected

It releases all internal pointers, returning its internal DataSet and invalidating itself.

Returns: A pointer to the internal DataSet that contains the observations.

Note: This method is used when the user is interested only in its internal DataSet; The caller will take the ownership of the returned pointer.

◆ setId()

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

It sets the identifier associated to the time series.

Parameters

id	The identifier associated to the time series.

◆ setValuePropNames()

void te::st::TimeSeriesDataSet::setValuePropNames ( const std::vector< std::string > & n )

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

Parameters

n	The names of the DataSet properties that contains the time series values.

◆ size()

std::size_t te::st::TimeSeriesDataSet::size ( ) const

It returns the size of the time series observation set.

Returns: The observation set size of the time series.

Friends And Related Function Documentation

◆ TimeSeriesDataSetLayer

friend class TimeSeriesDataSetLayer

friend

Definition at line 71 of file TimeSeriesDataSet.h.

Member Data Documentation

◆ m_id

std::string te::st::TimeSeriesDataSet::m_id

private

The time series identification.

Definition at line 340 of file TimeSeriesDataSet.h.

◆ m_obsDs

std::unique_ptr<ObservationDataSet> te::st::TimeSeriesDataSet::m_obsDs

private

The data set that contains the trajectory observations.

Definition at line 338 of file TimeSeriesDataSet.h.

◆ m_vlPropNames

std::vector<std::string> te::st::TimeSeriesDataSet::m_vlPropNames

private

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

Definition at line 339 of file TimeSeriesDataSet.h.

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

/home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/st/core/timeseries/TimeSeriesDataSet.h

Public Member Functions

Friends

Methods to get values pointed by the internal cursor.

Detailed Description

Constructor & Destructor Documentation

◆ TimeSeriesDataSet() [1/3]

◆ TimeSeriesDataSet() [2/3]

◆ TimeSeriesDataSet() [3/3]

◆ ~TimeSeriesDataSet()

Member Function Documentation

◆ getDouble() [1/2]

◆ getDouble() [2/2]

◆ getGeometry()

◆ getId()

◆ getInt() [1/2]

◆ getInt() [2/2]

◆ getObservationSet()

◆ getTemporalExtent()

◆ getTime()

◆ getTimeSeries() [1/2]

◆ getTimeSeries() [2/2]

◆ getTimeSeriesSet()

◆ getValue() [1/2]

◆ getValue() [2/2]

◆ getValuePropNames()

◆ isAfterEnd()

◆ isAtBegin()

◆ isAtEnd()

◆ isBeforeBegin()

◆ moveBeforeFirst()

◆ moveFirst()

◆ moveLast()

◆ moveNext()

◆ movePrevious()

◆ release()

◆ setId()

◆ setValuePropNames()

◆ size()

Friends And Related Function Documentation

◆ TimeSeriesDataSetLayer

Member Data Documentation

◆ m_id

◆ m_obsDs

◆ m_vlPropNames