A class to represent a trajectory data set. More...

#include <TrajectoryDataSet.h>

Inheritance diagram for te::st::TrajectoryDataSet:

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

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

const te::gm::Envelope &	getSpatialExtent () const
	It returns the spatial extent of the trajectory observations. More...

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

std::auto_ptr< Trajectory >	getTrajectory (AbstractTrajectoryInterp *interp)
	It returns the trajectory from the DataSet. More...

std::auto_ptr< Trajectory >	getTrajectory ()
	It returns the trajectory from the DataSet. More...

const TrajectoryDataSetType &	getType () const
	It returns a reference to the internal trajectory data set type. More...

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

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

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

Constructor
	TrajectoryDataSet (te::da::DataSet *ds, int tPropIdx, int gPropIdx, int idPropIdx, const std::string &id)
	Constructor. More...

	TrajectoryDataSet (te::da::DataSet ds, int tPropIdx, int gPropIdx, int idPropIdx, const std::string &id, te::dt::DateTimePeriod text, const te::gm::Envelope &sext)
	Constructor. More...

	TrajectoryDataSet (te::da::DataSet *ds, const std::vector< int > &tPropIdxs, int gPropIdx, int idPropIdx, const std::string &id)
	Constructor. More...

	TrajectoryDataSet (te::da::DataSet ds, const std::vector< int > &tPropIdxs, int gPropIdx, int idPropIdx, const std::string &id, te::dt::DateTimePeriod text, const te::gm::Envelope &sext)
	Constructor. More...

	TrajectoryDataSet (te::da::DataSet ds, const TrajectoryDataSetType &type, te::dt::DateTimePeriod text, const te::gm::Envelope &sext)
	Constructor. More...

	TrajectoryDataSet (ObservationDataSet *obs, const TrajectoryDataSetType &type, 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

Methods to get values pointed by the internal cursor.
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.
std::auto_ptr< te::gm::Geometry >	getGeometry () const

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

Private Attributes
std::string	m_id
	The trajectory identification. More...

std::auto_ptr< ObservationDataSet >	m_obsDs
	The data set that contains the trajectory observations. More...

TrajectoryDataSetType	m_type
	The trajectory type. More...

Detailed Description

A class to represent a trajectory data set.

This class represents a view on a DataSet that contains observations of a trajectory.

A trajectory represents the variation of spatial locations or boundaries of an object over time. It is composed of an observation data set where one observed property is a geometry. The observations have a fixed object identity and measured geometries at controlled times.

See Also: ObservationDataSet ObservationDatasSetType TrajectoryDataSetType

Definition at line 71 of file TrajectoryDataSet.h.

Constructor & Destructor Documentation

te::st::TrajectoryDataSet::TrajectoryDataSet	(	te::da::DataSet *	ds,
		int	tPropIdx,
		int	gPropIdx,
		int	idPropIdx,
		const std::string &	id
	)

Constructor.

Parameters

ds	The data set that contains the trajectory observations.
tPropIdx	The index of the property that contains the times of a trajectory.
gPropIdx	The index of the property that contains the geometries of a trajectory.
idPropIdx	The index of the property that contains the identity of the trajectory.
id	The trajectory id.

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

Definition at line 42 of file TrajectoryDataSet.cpp.

te::st::TrajectoryDataSet::TrajectoryDataSet	(	te::da::DataSet *	ds,
		int	tPropIdx,
		int	gPropIdx,
		int	idPropIdx,
		const std::string &	id,
		te::dt::DateTimePeriod *	text,
		const te::gm::Envelope &	sext
	)

Constructor.

Parameters

ds	The data set that contains the trajectory observations.
tPropIdx	The index of the property that contains the times of a trajectory.
gPropIdx	The index of the property that contains the geometries of a trajectory.
idPropIdx	The index of the property that contains the identity of the trajectory.
id	The trajectory id.
text	The temporal extent.
sext	The spatial extent.

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

Definition at line 51 of file TrajectoryDataSet.cpp.

te::st::TrajectoryDataSet::TrajectoryDataSet	(	te::da::DataSet *	ds,
		const std::vector< int > &	tPropIdxs,
		int	gPropIdx,
		int	idPropIdx,
		const std::string &	id
	)

Constructor.

Parameters

ds	The data set that contains the trajectory observations.
tPropIdxs	The indexes of the properties that contains the begin and end times of a trajectory.
gPropIdx	The index of the property that contains the geometries of a trajectory.
idPropIdx	The index of the property that contains the identity of the trajectory.
id	The trajectory id.

Note: It will take the ownership of the input pointer.; This constructor is used when each observation of a trajectory is associated to a period and the DataSet uses two properties to store these periods.

Definition at line 61 of file TrajectoryDataSet.cpp.

te::st::TrajectoryDataSet::TrajectoryDataSet	(	te::da::DataSet *	ds,
		const std::vector< int > &	tPropIdxs,
		int	gPropIdx,
		int	idPropIdx,
		const std::string &	id,
		te::dt::DateTimePeriod *	text,
		const te::gm::Envelope &	sext
	)

Constructor.

Parameters

ds	The data set that contains the trajectory observations.
tPropIdxs	The indexes of the properties that contains the begin and end times of a trajectory.
gPropIdx	The index of the property that contains the geometries of a trajectory.
idPropIdx	The index of the property that contains the identity of the trajectory.
id	The trajectory id.
text	The temporal extent.
sext	The spatial extent.

Note: It will take the ownership of the input pointer.; This constructor is used when each observation of a trajectory is associated to a period and the DataSet uses two properties to store these periods.

Definition at line 70 of file TrajectoryDataSet.cpp.

te::st::TrajectoryDataSet::TrajectoryDataSet	(	te::da::DataSet *	ds,
		const TrajectoryDataSetType &	type,
		te::dt::DateTimePeriod *	text,
		const te::gm::Envelope &	sext
	)

Constructor.

Parameters

ds	The data set that contains the trajectory observations.
type	The trajectory data set type.
text	The temporal extent.
sext	The spatial extent.

Note: It will take the ownership of the input pointer.; This constructor is used when each observation of a trajectory is associated to a period and the DataSet uses two properties to store these periods.

Definition at line 80 of file TrajectoryDataSet.cpp.

te::st::TrajectoryDataSet::TrajectoryDataSet	(	ObservationDataSet *	obs,
		const TrajectoryDataSetType &	type,
		const std::string &	id
	)

Constructor.

Parameters

obs	The data set that contains the trajectory observations.
type	The trajectory data set type.
id	The trajectory id

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

Definition at line 89 of file TrajectoryDataSet.cpp.

te::st::TrajectoryDataSet::~TrajectoryDataSet ( )

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.

Definition at line 208 of file TrajectoryDataSet.cpp.

Member Function Documentation

std::auto_ptr< te::gm::Geometry > te::st::TrajectoryDataSet::getGeometry ( ) const

Definition at line 167 of file TrajectoryDataSet.cpp.

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

It returns the identifier associated to the trajectory.

Returns: The identifier associated to the trajectory.

Definition at line 107 of file TrajectoryDataSet.cpp.

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

It returns the data set that contains the trajectory observations.

Returns: A reference to the data set that contains the trajectory observations.

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

Definition at line 97 of file TrajectoryDataSet.cpp.

const te::gm::Envelope & te::st::TrajectoryDataSet::getSpatialExtent ( ) const

It returns the spatial extent of the trajectory observations.

Returns: The spatial extent of the trajectory observations.

Definition at line 185 of file TrajectoryDataSet.cpp.

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

It returns the temporal extent of the trajectory observations.

Returns: The temporal extent of the trajectory observations.

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

Definition at line 180 of file TrajectoryDataSet.cpp.

std::auto_ptr< te::dt::DateTime > te::st::TrajectoryDataSet::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.

Definition at line 173 of file TrajectoryDataSet.cpp.

std::auto_ptr< te::st::Trajectory > te::st::TrajectoryDataSet::getTrajectory ( AbstractTrajectoryInterp * interp )

It returns the trajectory from the DataSet.

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

Returns: The trajectory associated to a given interpolator.

Note: The caller will take the ownership of the returned pointer.; It uses the method moveNext() internally. So, after calling this method, the internal cursor will point to the end of the DataSet.

Definition at line 190 of file TrajectoryDataSet.cpp.

References te::st::Trajectory::add(), te::da::DataSet::getDateTime(), te::da::DataSet::getGeometry(), and te::da::DataSet::moveNext().

std::auto_ptr< te::st::Trajectory > te::st::TrajectoryDataSet::getTrajectory ( )

It returns the trajectory from the DataSet.

This method encapsulates all observations of this DataSet as a Trajectory type associated to a NearestGeometryAtTimeInterp interpolator.

Returns: The trajectory associated to a NearestGeometryAtTimeInterp interpolator.

Note: The caller will take the ownership of the returned pointer.; It uses the method moveNext() internally. So, after calling this method, the internal cursor will point to the end of the DataSet.

Definition at line 203 of file TrajectoryDataSet.cpp.

References te::common::Singleton< NearestGeometryAtTimeInterp >::getInstance().

const te::st::TrajectoryDataSetType & te::st::TrajectoryDataSet::getType ( ) const

It returns a reference to the internal trajectory data set type.

Returns: A reference to the internal trajectory data set type.

Definition at line 102 of file TrajectoryDataSet.cpp.

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

Definition at line 162 of file TrajectoryDataSet.cpp.

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

Definition at line 147 of file TrajectoryDataSet.cpp.

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

Definition at line 157 of file TrajectoryDataSet.cpp.

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

Definition at line 152 of file TrajectoryDataSet.cpp.

bool te::st::TrajectoryDataSet::moveBeforeFirst ( )

Definition at line 137 of file TrajectoryDataSet.cpp.

bool te::st::TrajectoryDataSet::moveFirst ( )

Definition at line 132 of file TrajectoryDataSet.cpp.

bool te::st::TrajectoryDataSet::moveLast ( )

Definition at line 142 of file TrajectoryDataSet.cpp.

bool te::st::TrajectoryDataSet::moveNext ( )

Definition at line 122 of file TrajectoryDataSet.cpp.

bool te::st::TrajectoryDataSet::movePrevious ( )

Definition at line 127 of file TrajectoryDataSet.cpp.

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

It sets the identifier associated to the trajectory.

Parameters

id	The identifier associated to the trajectory.

Definition at line 112 of file TrajectoryDataSet.cpp.

std::size_t te::st::TrajectoryDataSet::size ( void ) const

It returns the size of the trajectory observation set.

Returns: The observation set size of the trajectory.

Definition at line 117 of file TrajectoryDataSet.cpp.

Member Data Documentation

std::string te::st::TrajectoryDataSet::m_id

private

The trajectory identification.

Definition at line 318 of file TrajectoryDataSet.h.

std::auto_ptr<ObservationDataSet> te::st::TrajectoryDataSet::m_obsDs

private

The data set that contains the trajectory observations.

Definition at line 316 of file TrajectoryDataSet.h.

TrajectoryDataSetType te::st::TrajectoryDataSet::m_type

private

The trajectory type.

Definition at line 317 of file TrajectoryDataSet.h.

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

/home/castejon/castejon_files/develop/terralib5/git/src/terralib/st/core/trajectory/TrajectoryDataSet.h
/home/castejon/castejon_files/develop/terralib5/git/src/terralib/st/core/trajectory/TrajectoryDataSet.cpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation