A class that contains complemental DataSetType information about a DataSet that holds observations. More...

#include <ObservationDataSetType.h>

Public Member Functions
int	getBeginTimePropIdx () const
	It returns the index of the DataSet property that contains the phenomenon beginning time. More...

int	getEndTimePropIdx () const
	It returns the index of the DataSet property that contains the phenomenon end time. More...

int	getGeomPropIdx () const
	It returns the index of the observed property that is a geometry property. More...

const std::vector< int > &	getObsPropIdxs () const
	It returns the indexes of the DataSetType properties that are observed over time. More...

int	getRsTimePropIdx () const
	It returns the index of the DataSet property that contains the result time. More...

const std::vector< int > &	getTimePropIdxs () const
	It returns the indexes of the DataSetType properties that contains the phenomenon time. More...

int	getVlBeginTimePropIdx () const
	It returns the index of the DataSet property that contains the valid beginning time. More...

int	getVlEndTimePropIdx () const
	It returns the index of the DataSet property that contains the valid end time. More...

const std::vector< int > &	getVlTimePropIdxs () const
	It returns the indexes of the DataSet properties that contains the valid time. More...

	ObservationDataSetType (int phTimeIdx, int obsPropIdx, int geomPropIdx=-1)
	Constructor. More...

	ObservationDataSetType (int phTimeIdx, const std::vector< int > &obsPropIdx, int geomPropIdx=-1)
	Constructor. More...

	ObservationDataSetType (const std::vector< int > &phTimeIdx, const std::vector< int > &obsPropIdx, int geomPropIdx=-1)
	Constructor. More...

	ObservationDataSetType (const std::vector< int > &phTimeIdx, const std::vector< int > &obsPropIdx, int geomPropIdx, const std::vector< int > &valTimeIdx, int resTimeIdx)
	Constructor. More...

void	setBeginTimePropIdx (int idx)
	It sets the index of the DataSet property that contains the phenomenon beginning time. More...

void	setEndTimePropIdx (int idx)
	It sets the index of the DataSet property that contains the phenomenon end time. More...

void	setGeomPropIdx (int idx)
	It sets the index of the observed property that is a geometry property. More...

void	setObsPropIdxs (const std::vector< int > &props)
	It sets the indexes of the DataSetType properties that are observed over time. More...

void	setRsTimePropIdx (int idx)
	It sets the index of the DataSet property that contains the result time. More...

void	setTimePropIdxs (const std::vector< int > &idxs)
	It sets the indexes of the DataSet properties that contains the phenomenon time. More...

void	setVlBeginTimePropIdx (int idx)
	It sets the index of the DataSet property that contains the valid beginning time. More...

void	setVlEndTimePropIdx (int idx)
	It sets the index of the DataSet property that contains the valid end time. More...

void	setVlTimePropIdxs (const std::vector< int > &idxs)
	It sets the indexes of the DataSet properties that contains the valid time. More...

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

Private Attributes
int	m_geomPropIdx
	The index of the observed property that contains the spatial information. More...

std::vector< int >	m_observedPropIdx
	The indexes of DataSet properties that are observed. More...

std::vector< int >	m_phTimePropIdx
	The indexes of DataSet properties that contain the phenomenon time. More...

int	m_resultTimePropIdx
	The index of DataSet property that contains the result time. More...

std::vector< int >	m_validTimePropIdx
	The indexes of DataSet properties that contain the valid time. More...

Detailed Description

A class that contains complemental DataSetType information about a DataSet that holds observations.

This class contains complemental DataSetType information about a DataSet that holds observations.

An observation is a result of a measurement associated to a discrete time instant or period which assigns values to a phenomenon. It follows the OGC's Observation and Measurement (O&M) specification. An observation is composed of: (1) a phenomenon time, (2) a valid time, (3) a result time and (4) observed values.

Thus, this class has the indexes of the DataSet properties that contains the phenomenon time, the valid time, the result time and the observed values.

See also: Observation ObservationDataSet

Definition at line 64 of file ObservationDataSetType.h.

Constructor & Destructor Documentation

te::st::ObservationDataSetType::ObservationDataSetType	(	int	phTimeIdx,
		int	obsPropIdx,
		int	geomPropIdx = `-1`
	)

Constructor.

Parameters

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.

Definition at line 29 of file ObservationDataSetType.cpp.

References m_observedPropIdx, and m_phTimePropIdx.

te::st::ObservationDataSetType::ObservationDataSetType	(	int	phTimeIdx,
		const std::vector< int > &	obsPropIdx,
		int	geomPropIdx = `-1`
	)

Constructor.

Parameters

phTimeIdx	The index of the property that contains the phenomenon time.
obsPropIdx	The indexes of the properties that are observed.
geomPropIdx	The index of the observed property that contains the geometry.

Definition at line 39 of file ObservationDataSetType.cpp.

References m_phTimePropIdx.

te::st::ObservationDataSetType::ObservationDataSetType	(	const std::vector< int > &	phTimeIdx,
		const std::vector< int > &	obsPropIdx,
		int	geomPropIdx = `-1`
	)

Constructor.

This constructor is used when the DataSet uses two properties to store a period, one for its begining and the other for its end.

Parameters

phTimeIdx	The indexes of the properties that contain the phenomenon time.
obsPropIdx	The indexes of the properties that are observed.
geomPropIdx	The index of the observed property that contains the geometry.

Definition at line 49 of file ObservationDataSetType.cpp.

References m_phTimePropIdx.

te::st::ObservationDataSetType::ObservationDataSetType	(	const std::vector< int > &	phTimeIdx,
		const std::vector< int > &	obsPropIdx,
		int	geomPropIdx,
		const std::vector< int > &	valTimeIdx,
		int	resTimeIdx
	)

Constructor.

Parameters

phTimeIdx	The indexes of the properties that contains the phenomen time.
obsPropIdx	The indexes of the property that are observed.
geomPropIdx	The index of the observed property that contains the geometry.
valTimeIdx	The indexes of the properties that contains the valid time.
resTimeIdx	The index of the property that contains the result time.

Definition at line 61 of file ObservationDataSetType.cpp.

References m_phTimePropIdx, and m_validTimePropIdx.

te::st::ObservationDataSetType::~ObservationDataSetType ( )

virtual

Virtual destructor.

Definition at line 168 of file ObservationDataSetType.cpp.

Member Function Documentation

int te::st::ObservationDataSetType::getBeginTimePropIdx ( ) const

It returns the index of the DataSet property that contains the phenomenon beginning time.

Returns: The index of the DataSet property that contains the phenomenon beginning time.

Definition at line 81 of file ObservationDataSetType.cpp.

int te::st::ObservationDataSetType::getEndTimePropIdx ( ) const

It returns the index of the DataSet property that contains the phenomenon end time.

Returns: The index of the DataSet property that contains the phenomenon end time.

Note: It returns -1 when there is no a phenomenon end time.

Definition at line 86 of file ObservationDataSetType.cpp.

int te::st::ObservationDataSetType::getGeomPropIdx ( ) const

It returns the index of the observed property that is a geometry property.

Returns: The index of the observed property that is a geometry property.

Definition at line 117 of file ObservationDataSetType.cpp.

const std::vector< int > & te::st::ObservationDataSetType::getObsPropIdxs ( ) const

It returns the indexes of the DataSetType properties that are observed over time.

Returns: The indexes of the DataSetType properties that are observed over time.

Definition at line 107 of file ObservationDataSetType.cpp.

int te::st::ObservationDataSetType::getRsTimePropIdx ( ) const

It returns the index of the DataSet property that contains the result time.

Returns: The index of the DataSet properties that contains the result time.

Definition at line 158 of file ObservationDataSetType.cpp.

const std::vector< int > & te::st::ObservationDataSetType::getTimePropIdxs ( ) const

It returns the indexes of the DataSetType properties that contains the phenomenon time.

Returns: The indexes of the DataSetType properties that contains the phenomenon time.

Definition at line 76 of file ObservationDataSetType.cpp.

int te::st::ObservationDataSetType::getVlBeginTimePropIdx ( ) const

It returns the index of the DataSet property that contains the valid beginning time.

Returns: The index of the DataSet property that contains the valid beginning time.

Note: It returns -1 when there is no a valid beginning time.

Definition at line 127 of file ObservationDataSetType.cpp.

int te::st::ObservationDataSetType::getVlEndTimePropIdx ( ) const

It returns the index of the DataSet property that contains the valid end time.

Returns: The index of the DataSet property that contains the valid end time.

Note: It returns -1 when there is no a valid end time.

Definition at line 132 of file ObservationDataSetType.cpp.

const std::vector< int > & te::st::ObservationDataSetType::getVlTimePropIdxs ( ) const

It returns the indexes of the DataSet properties that contains the valid time.

Returns: The indexes of the DataSet properties that contains the valid time.

Definition at line 137 of file ObservationDataSetType.cpp.

void te::st::ObservationDataSetType::setBeginTimePropIdx ( int idx )

It sets the index of the DataSet property that contains the phenomenon beginning time.

Parameters

idx	The index of the DataSet property that contains the phenomenon beginning time.

Definition at line 97 of file ObservationDataSetType.cpp.

void te::st::ObservationDataSetType::setEndTimePropIdx ( int idx )

It sets the index of the DataSet property that contains the phenomenon end time.

Parameters

idx	The index of the DataSet property that contains the phenomenon end time.

Definition at line 102 of file ObservationDataSetType.cpp.

void te::st::ObservationDataSetType::setGeomPropIdx ( int idx )

It sets the index of the observed property that is a geometry property.

Parameters

idx	The index of the observed property that is a geometry property.

Definition at line 122 of file ObservationDataSetType.cpp.

void te::st::ObservationDataSetType::setObsPropIdxs ( const std::vector< int > & props )

It sets the indexes of the DataSetType properties that are observed over time.

Parameters

props The indexes of the DataSetType properties that are observed over time.

Definition at line 112 of file ObservationDataSetType.cpp.

void te::st::ObservationDataSetType::setRsTimePropIdx ( int idx )

It sets the index of the DataSet property that contains the result time.

Parameters

idx	The index of the DataSet property that contains the result time.

Definition at line 163 of file ObservationDataSetType.cpp.

void te::st::ObservationDataSetType::setTimePropIdxs ( const std::vector< int > & idxs )

It sets the indexes of the DataSet properties that contains the phenomenon time.

Parameters

idxs	The indexes of the DataSet properties that contains the phenomenon time.

Definition at line 91 of file ObservationDataSetType.cpp.

void te::st::ObservationDataSetType::setVlBeginTimePropIdx ( int idx )

It sets the index of the DataSet property that contains the valid beginning time.

Parameters

idx	The index of the DataSet property that contains the valid beginning time.

Definition at line 142 of file ObservationDataSetType.cpp.

void te::st::ObservationDataSetType::setVlEndTimePropIdx ( int idx )

It sets the index of the DataSet property that contains the valid end time.

Parameters

idx	The index of the DataSet property that contains the valid end time.

Definition at line 147 of file ObservationDataSetType.cpp.

void te::st::ObservationDataSetType::setVlTimePropIdxs ( const std::vector< int > & idxs )

It sets the indexes of the DataSet properties that contains the valid time.

Parameters

idxs	The indexes of the DataSet properties that contains the valid time.

Definition at line 152 of file ObservationDataSetType.cpp.

Member Data Documentation

int te::st::ObservationDataSetType::m_geomPropIdx

private

The index of the observed property that contains the spatial information.

Definition at line 250 of file ObservationDataSetType.h.

std::vector<int> te::st::ObservationDataSetType::m_observedPropIdx

private

The indexes of DataSet properties that are observed.

Definition at line 249 of file ObservationDataSetType.h.

Referenced by ObservationDataSetType().

std::vector<int> te::st::ObservationDataSetType::m_phTimePropIdx

private

The indexes of DataSet properties that contain the phenomenon time.

Definition at line 248 of file ObservationDataSetType.h.

Referenced by ObservationDataSetType().

int te::st::ObservationDataSetType::m_resultTimePropIdx

private

The index of DataSet property that contains the result time.

Definition at line 252 of file ObservationDataSetType.h.

std::vector<int> te::st::ObservationDataSetType::m_validTimePropIdx

private

The indexes of DataSet properties that contain the valid time.

Definition at line 251 of file ObservationDataSetType.h.

Referenced by ObservationDataSetType().

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

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation