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

#include <TrajectoryDataSet.h>

Inheritance diagram for te::st::TrajectoryDataSet:

Public Member Functions
const te::gm::GeometryProperty *	getGeometryProperty () const
	It returns the trajectory geometry property. More...

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::Geometry *	getSpatialExtent () const
	It returns the spatial extent of the trajectory observations. More...

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

const te::dt::DateTimeProperty *	getTimeProperty () const
	It returns the trajectory datetime property. More...

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

std::unique_ptr< Trajectory >	getTrajectory ()
	It returns the trajectory from the DataSet. 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 ()
	Virtual destructor. More...

Constructor
	TrajectoryDataSet (te::da::DataSet *ds, const ObservationDataSetType &type)
	Constructor. More...

	TrajectoryDataSet (te::da::DataSet *ds, const ObservationDataSetType &type, const std::string &id)
	Constructor. More...

	TrajectoryDataSet (ObservationDataSet *obs, 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.
std::unique_ptr< te::gm::Geometry >	getGeometry () const
	It returns the geometry pointed by the internal cursor. More...

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

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

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

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

Friends
class	TrajectoryDataSetLayer

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 72 of file TrajectoryDataSet.h.

Constructor & Destructor Documentation

te::st::TrajectoryDataSet::TrajectoryDataSet	(	te::da::DataSet *	ds,
		const ObservationDataSetType &	type
	)

Constructor.

Parameters

ds	The data set that contains the trajectory observations.
type	The observation data set type.

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

te::st::TrajectoryDataSet::TrajectoryDataSet	(	te::da::DataSet *	ds,
		const ObservationDataSetType &	type,
		const std::string &	id
	)

Constructor.

Parameters

ds	The data set that contains the trajectory observations.
type	The observation data set type.
id	The trajectory id.

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

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

Constructor.

Parameters

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

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

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

virtual

Virtual destructor.

Member Function Documentation

std::unique_ptr<te::gm::Geometry> te::st::TrajectoryDataSet::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.

const te::gm::GeometryProperty* te::st::TrajectoryDataSet::getGeometryProperty ( ) const

inline

It returns the trajectory geometry property.

Returns: The trajectory geometry property.

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

Definition at line 238 of file TrajectoryDataSet.h.

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

It returns the identifier associated to the trajectory.

Returns: The identifier associated to the trajectory.

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.

const te::gm::Geometry* te::st::TrajectoryDataSet::getSpatialExtent ( ) const

It returns the spatial extent of the trajectory observations.

Returns: The spatial extent of the trajectory observations.

const 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.

std::unique_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.

const te::dt::DateTimeProperty* te::st::TrajectoryDataSet::getTimeProperty ( ) const

inline

It returns the trajectory datetime property.

Returns: The trajectory datetime property.

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

Definition at line 247 of file TrajectoryDataSet.h.

std::unique_ptr<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.

std::unique_ptr<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.

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

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

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

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

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

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

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

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

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

std::unique_ptr<te::da::DataSet> te::st::TrajectoryDataSet::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.

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.

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

It returns the size of the trajectory observation set.

Returns: The observation set size of the trajectory.

Friends And Related Function Documentation

friend class TrajectoryDataSetLayer

friend

Definition at line 74 of file TrajectoryDataSet.h.

Member Data Documentation

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

private

The trajectory identification.

Definition at line 265 of file TrajectoryDataSet.h.

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

private

The data set that contains the trajectory observations.

Definition at line 264 of file TrajectoryDataSet.h.

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

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

Public Member Functions

Protected Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation