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::Envelope &	getSpatialExtent ()
	It returns the spatial extent of the observations, when there is an observed value of geometry type. More...

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 (const te::gm::Envelope &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 ()
	It returns the property of the phenomenon beginning time. 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, const te::gm::Envelope &sext)
	Constructor. More...

	ObservationDataSet (te::da::DataSet *ds, int phTimeIdx, int obsPropIdx, int geomPropIdx=-1)
	Constructor. More...

	ObservationDataSet (te::da::DataSet *ds, const std::vector< int > &phTimeIdxs, const std::vector< int > &obsPropIdxs, int geomPropIdx=-1)
	Constructor. More...

	ObservationDataSet (te::da::DataSet ds, int phTimeIdx, int obsPropIdx, int geomPropIdx, te::dt::DateTimePeriod text)
	Constructor. More...

	ObservationDataSet (te::da::DataSet ds, int phTimeIdx, int obsPropIdx, int geomPropIdx, te::dt::DateTimePeriod text, const te::gm::Envelope &sext)
	Constructor. More...

	ObservationDataSet (te::da::DataSet ds, const std::vector< int > &phTimeIdxs, const std::vector< int > &obsPropIdxs, int geomPropIdx, te::dt::DateTimePeriod text)
	Constructor. More...

	ObservationDataSet (te::da::DataSet ds, const std::vector< int > &phTimeIdxs, const std::vector< int > &obsPropIdxs, int geomPropIdx, te::dt::DateTimePeriod text, const te::gm::Envelope &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

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

te::gm::Envelope	m_spExtent
	Its temporal extent. More...

std::auto_ptr < te::dt::DateTimePeriod >	m_tpExtent
	An observation data set type that refers to m_ds. 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

Definition at line 37 of file ObservationDataSet.cpp.

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

Definition at line 45 of file ObservationDataSet.cpp.

te::st::ObservationDataSet::ObservationDataSet	(	te::da::DataSet *	ds,
		const ObservationDataSetType &	obst,
		te::dt::DateTimePeriod *	text,
		const te::gm::Envelope &	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

Definition at line 53 of file ObservationDataSet.cpp.

te::st::ObservationDataSet::ObservationDataSet	(	te::da::DataSet *	ds,
		int	phTimeIdx,
		int	obsPropIdx,
		int	geomPropIdx = `-1`
	)

Constructor.

Parameters

ds	The DataSet.
phTimeIdx	The index of the property that contains the phenomenon time.
obsPropIdx	The index of the property that is observed.
geomPropIdx	The index of the observed property that contains the geometry.

Note: It will take the ownership of the DataSet pointer

Definition at line 62 of file ObservationDataSet.cpp.

te::st::ObservationDataSet::ObservationDataSet	(	te::da::DataSet *	ds,
		const std::vector< int > &	phTimeIdxs,
		const std::vector< int > &	obsPropIdxs,
		int	geomPropIdx = `-1`
	)

Constructor.

Parameters

ds	the DataSet
phTimeIdxs	The indexes of the property that contains the begin and final phenomenon time.
obsPropIdx	The indexes of the properties that are observed.
geomPropIdx	The index of the observed property that contains the geometry.

Note: It will take the ownership of the DataSet pointer

Definition at line 71 of file ObservationDataSet.cpp.

te::st::ObservationDataSet::ObservationDataSet	(	te::da::DataSet *	ds,
		int	phTimeIdx,
		int	obsPropIdx,
		int	geomPropIdx,
		te::dt::DateTimePeriod *	text
	)

Constructor.

Parameters

ds	The DataSet
phTimeIdx	The index of the property that contains the phenomenon time.
obsPropIdx	The index of the property that is observed.
geomPropIdx	The index of the observed property that contains the geometry.
text	The temporal extent
sext	The spatial extent

Note: It will take the ownership of the DataSet pointer

Definition at line 80 of file ObservationDataSet.cpp.

te::st::ObservationDataSet::ObservationDataSet	(	te::da::DataSet *	ds,
		int	phTimeIdx,
		int	obsPropIdx,
		int	geomPropIdx,
		te::dt::DateTimePeriod *	text,
		const te::gm::Envelope &	sext
	)

Constructor.

Parameters

ds	The DataSet
phTimeIdx	The index of the property that contains the phenomenon time.
obsPropIdx	The index of the property that is observed.
geomPropIdx	The index of the observed property that contains the geometry.
text	The temporal extent
sext	The spatial extent

Note: It will take the ownership of the DataSet pointer

Definition at line 88 of file ObservationDataSet.cpp.

te::st::ObservationDataSet::ObservationDataSet	(	te::da::DataSet *	ds,
		const std::vector< int > &	phTimeIdxs,
		const std::vector< int > &	obsPropIdxs,
		int	geomPropIdx,
		te::dt::DateTimePeriod *	text
	)

Constructor.

Parameters

ds	The DataSet
phTimeIdxs	The index of the property that contains the begin and end times.
obsPropIdxs	The indexes of the properties that are observed.
geomPropIdx	The index of the observed property that contains the geometry.
text	The temporal extent
sext	The spatial extent

Note: It will take the ownership of the DataSet pointer

Definition at line 97 of file ObservationDataSet.cpp.

te::st::ObservationDataSet::ObservationDataSet	(	te::da::DataSet *	ds,
		const std::vector< int > &	phTimeIdxs,
		const std::vector< int > &	obsPropIdxs,
		int	geomPropIdx,
		te::dt::DateTimePeriod *	text,
		const te::gm::Envelope &	sext
	)

Constructor.

Parameters

ds	The DataSet
phTimeIdxs	The index of the property that contains the begin and end times.
obsPropIdxs	The indexes of the properties that are observed.
geomPropIdx	The index of the observed property that contains the geometry.
text	The temporal extent
sext	The spatial extent

Note: It will take the ownership of the DataSet pointer

Definition at line 105 of file ObservationDataSet.cpp.

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

virtual

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.

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.

It returns the properties of the observed values.

Parameters

output the properties of the observed values.

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

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.

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.

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.

Virtual destructor.

Definition at line 223 of file ObservationDataSet.cpp.

Member Function Documentation

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.

Definition at line 115 of file ObservationDataSet.cpp.

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

Definition at line 202 of file ObservationDataSet.cpp.

const te::gm::Envelope & 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.

Definition at line 132 of file ObservationDataSet.cpp.

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.

Definition at line 147 of file ObservationDataSet.cpp.

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

It returns a reference to the ObservationDataSetType.

Returns: A reference to the internal ObservationDataSetType.

Definition at line 127 of file ObservationDataSet.cpp.

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

Definition at line 197 of file ObservationDataSet.cpp.

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

Definition at line 182 of file ObservationDataSet.cpp.

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

Definition at line 192 of file ObservationDataSet.cpp.

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

Definition at line 187 of file ObservationDataSet.cpp.

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

Definition at line 172 of file ObservationDataSet.cpp.

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

Definition at line 167 of file ObservationDataSet.cpp.

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

Definition at line 177 of file ObservationDataSet.cpp.

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

Definition at line 157 of file ObservationDataSet.cpp.

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

Definition at line 162 of file ObservationDataSet.cpp.

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.

Definition at line 120 of file ObservationDataSet.cpp.

void te::st::ObservationDataSet::setSpatialExtent ( const te::gm::Envelope & 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.

Definition at line 142 of file ObservationDataSet.cpp.

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.

Definition at line 152 of file ObservationDataSet.cpp.

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 373 of file ObservationDataSet.h.

ObservationDataSetType te::st::ObservationDataSet::m_obst

private

A data set that contains observations.

Definition at line 374 of file ObservationDataSet.h.

te::gm::Envelope te::st::ObservationDataSet::m_spExtent

private

Its temporal extent.

Definition at line 376 of file ObservationDataSet.h.

std::auto_ptr<te::dt::DateTimePeriod> te::st::ObservationDataSet::m_tpExtent

private

An observation data set type that refers to m_ds.

Definition at line 375 of file ObservationDataSet.h.

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

C:/BB_TL5/terralib5/src/terralib/st/core/observation/ObservationDataSet.h
C:/BB_TL5/terralib5/src/terralib/st/core/observation/ObservationDataSet.cpp

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