A class to represent a DataSet that contains observations. More...

#include <ObservationDataSet.h>

Inheritance diagram for te::st::ObservationDataSet:

Public Member Functions
te::da::DataSet *	getData () const
	It returns the DataSet that contains the observations. More...

std::auto_ptr< Observation >	getObservation () const
	It returns the observation pointed by the internal cursor. More...

const te::gm::Geometry *	getSpatialExtent ()
	It returns the spatial extent of the observations, when there is an observed value of geometry type. More...

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

const ObservationDataSetType &	getType () const
	It returns a reference to the ObservationDataSetType. More...

void	setSpatialExtent (te::gm::Geometry *ext)
	It sets the spatial extent of the observations, when there is an observed value of geometry type. More...

void	setTemporalExtent (te::dt::DateTimePeriod *ext)
	It sets the temporal extent of the observations, when there is an observed value of geometry type. More...

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

Constructors
	ObservationDataSet (te::da::DataSet *ds, const ObservationDataSetType &obst)
	Constructor. More...

	ObservationDataSet (te::da::DataSet ds, const ObservationDataSetType &obst, te::dt::DateTimePeriod text)
	Constructor. More...

	ObservationDataSet (te::da::DataSet ds, const ObservationDataSetType &obst, te::dt::DateTimePeriod text, te::gm::Geometry *sext)
	Constructor. More...

Methods to traverse the observation set 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 return the properties associated to observations.
const te::dt::DateTimeProperty *	getBeginTimeProperty () const
	It returns the property of the phenomenon beginning time. More...

const te::dt::DateTimeProperty *	getEndTimeProperty () const
	It returns the property of the phenomenon end time. More...

const te::dt::DateTimeProperty *	getVlBeginTimeProperty () const
	It returns the property of the valid beginning time. More...

const te::dt::DateTimeProperty *	getVlEndTimeProperty () const
	It returns the property of the valid end time. More...

const te::dt::DateTimeProperty *	getRsTimeProperty () const
	It returns the property of the result time. More...

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

Private Attributes
std::auto_ptr< te::da::DataSet >	m_ds

ObservationDataSetType	m_obst
	A data set that contains observations. More...

Friends
class	ObservationDataSetLayer

class	TimeSeriesDataSet

class	TrajectoryDataSet

Detailed Description

A class to represent a DataSet that contains observations.

This class implements a view on a data set. It encapsulates a DataSet as a ObservationDataSet. An observation data set is composed of a finite number of homogeneous observations, that is, every observation has the same number and type of observed values.

See also: DataSet Observation DataSource

Definition at line 82 of file ObservationDataSet.h.

Constructor & Destructor Documentation

te::st::ObservationDataSet::ObservationDataSet	(	te::da::DataSet *	ds,
		const ObservationDataSetType &	obst
	)

Constructor.

It constructs an observation data set, based on the given DataSet and ObservationDataSetType

Parameters

ds	the DataSet
obst	extra information about the properies of the DataSet

Note: It will take the ownership of the DataSet pointer

te::st::ObservationDataSet::ObservationDataSet	(	te::da::DataSet *	ds,
		const ObservationDataSetType &	obst,
		te::dt::DateTimePeriod *	text
	)

Constructor.

It constructs an observation data set, based on the given DataSet and ObservationDataSetType

Parameters

ds	The DataSet.
obst	extra information about the properies of the DataSet
text	the temporal extent

Note: It will take the ownership of the given pointers

te::st::ObservationDataSet::ObservationDataSet	(	te::da::DataSet *	ds,
		const ObservationDataSetType &	obst,
		te::dt::DateTimePeriod *	text,
		te::gm::Geometry *	sext
	)

Constructor.

It constructs an observation data set, based on the given DataSet and ObservationDataSetType

Parameters

ds	The DataSet.
obst	extra information about the properies of the DataSet
text	the temporal extent
sext	the spatial extent

Note: It will take the ownership of the given pointers

virtual te::st::ObservationDataSet::~ObservationDataSet ( )

virtual

Virtual destructor.

Member Function Documentation

const te::dt::DateTimeProperty* te::st::ObservationDataSet::getBeginTimeProperty ( ) const

It returns the property of the phenomenon beginning time.

Returns: The property of the phenomenon beginning time.

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

te::da::DataSet* te::st::ObservationDataSet::getData ( ) const

It returns the DataSet that contains the observations.

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

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

const te::dt::DateTimeProperty* te::st::ObservationDataSet::getEndTimeProperty ( ) const

It returns the property of the phenomenon end time.

Returns: The property of the phenomenon end time.

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

std::auto_ptr<Observation> te::st::ObservationDataSet::getObservation ( ) const

It returns the observation pointed by the internal cursor.

Returns: The observation pointed by the internal cursor.

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

const te::dt::DateTimeProperty* te::st::ObservationDataSet::getRsTimeProperty ( ) const

It returns the property of the result time.

Returns: The property of the result time.

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

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

It returns the spatial extent of the observations, when there is an observed value of geometry type.

Returns: The spatial extent of the observations.

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

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

It returns the temporal extent of the observations.

Returns: The temporal extent of the observations.

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

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

It returns a reference to the ObservationDataSetType.

Returns: A reference to the internal ObservationDataSetType.

const te::dt::DateTimeProperty* te::st::ObservationDataSet::getVlBeginTimeProperty ( ) const

It returns the property of the valid beginning time.

Returns: The property of the valid beginning time.

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

const te::dt::DateTimeProperty* te::st::ObservationDataSet::getVlEndTimeProperty ( ) const

It returns the property of the valid end time.

Returns: The property of the valid end time.

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

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

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

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

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

bool te::st::ObservationDataSet::moveBeforeFirst ( )

bool te::st::ObservationDataSet::moveFirst ( )

bool te::st::ObservationDataSet::moveLast ( )

bool te::st::ObservationDataSet::moveNext ( )

bool te::st::ObservationDataSet::movePrevious ( )

std::auto_ptr<te::da::DataSet> te::st::ObservationDataSet::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::ObservationDataSet::setSpatialExtent ( te::gm::Geometry * ext )

It sets the spatial extent of the observations, when there is an observed value of geometry type.

Parameters

ext	The spatial extent of the observations.

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

void te::st::ObservationDataSet::setTemporalExtent ( te::dt::DateTimePeriod * ext )

It sets the temporal extent of the observations, when there is an observed value of geometry type.

Parameters

ext	The temporal extent of the observations.

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

Friends And Related Function Documentation

friend class ObservationDataSetLayer

friend

Definition at line 84 of file ObservationDataSet.h.

friend class TimeSeriesDataSet

friend

Definition at line 86 of file ObservationDataSet.h.

friend class TrajectoryDataSet

friend

Definition at line 85 of file ObservationDataSet.h.

Member Data Documentation

std::auto_ptr<te::da::DataSet> te::st::ObservationDataSet::m_ds

private

Definition at line 286 of file ObservationDataSet.h.

ObservationDataSetType te::st::ObservationDataSet::m_obst

private

A data set that contains observations.

Definition at line 287 of file ObservationDataSet.h.

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

/home/castejon/castejon_files/develop/terralib5/git_master/src/terralib/st/core/observation/ObservationDataSet.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