A class that contains infos about a DataSet that contains observations. More...

#include <ObservationDataSetInfo.h>

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

std::string	getDataSetName () const
	It returns the DataSet name. More...

const te::da::DataSourceInfo &	getDataSourceInfo () const
	It returns the information about the DataSource. 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 property that is a geometry property. More...

std::string	getId () const
	It returns an id (as a string) that identifies the DataSet. 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...

	ObservationDataSetInfo (const te::da::DataSourceInfo &dsinfo, const std::string &dsName, int phTimePropIdx, int obsPropIdx, int gPropIdx=-1)
	Constructor. More...

	ObservationDataSetInfo (const te::da::DataSourceInfo &dsinfo, const std::string &dsName, const std::vector< int > &phTimeIdx, const std::vector< int > &obsPropIdx, int gPropIdx=-1)
	Constructor. More...

	ObservationDataSetInfo (const te::da::DataSourceInfo &dsinfo, const std::string &dsName, const std::vector< int > &phTimeIdx, const std::vector< int > &obsPropIdx, const std::vector< int > &valTimeIdx, int resTimeIdx, int gPropIdx=-1)
	Constructor. More...

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

void	setDataSetName (const std::string &name)
	It sets the DataSet name. More...

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

void	setObsPropIdxs (const std::vector< int > &props, int gPropIdx=-1)
	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	~ObservationDataSetInfo ()
	Virtual destructor. More...

Protected Attributes
te::da::DataSourceInfo	m_dsInfo
	Information about the DataSource from which the DataSet come. More...

std::string	m_dsName
	The DataSet name. More...

int	m_geomPropIdx
	The index of the 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 infos about a DataSet that contains observations.

This class contains information about a DataSet that contains observations. This information includes: (1) the DataSource which it is from (2) the DataSet name (3) the DataSet properties that contains the phenomenon time, the result time, etc.

An observation is an act associated with a discrete position in time, in space or in space and time through which a number, term or other value is assigned to a phenomenon. So, given a DataSet that contains observations, we need to know some extra information about it, such as what columns contain the phenomenon time and the observed properties.

See also: DataSourceInfo

Definition at line 64 of file ObservationDataSetInfo.h.

Constructor & Destructor Documentation

te::st::ObservationDataSetInfo::ObservationDataSetInfo	(	const te::da::DataSourceInfo &	dsinfo,
		const std::string &	dsName,
		int	phTimePropIdx,
		int	obsPropIdx,
		int	gPropIdx = `-1`
	)

Constructor.

Parameters

dsinfo	Infos about the DataSource.
dsName	The DataSet name.
phTimeIdx	The index of the DataSet property that contains the phenomenon time.
obsPropIdx	The index of the DataSet property that is observed.
gPropIdx	The index of the property that contains the spatial information.

Definition at line 33 of file ObservationDataSetInfo.cpp.

References m_observedPropIdx, and m_phTimePropIdx.

te::st::ObservationDataSetInfo::ObservationDataSetInfo	(	const te::da::DataSourceInfo &	dsinfo,
		const std::string &	dsName,
		const std::vector< int > &	phTimeIdx,
		const std::vector< int > &	obsPropIdx,
		int	gPropIdx = `-1`
	)

Constructor.

Parameters

dsinfo	Infos about the DataSource.
dsName	The DataSet name.
phTimeIdx	The indexes of DataSet properties that contain the phenomenon time.
obsPropIdx	The indexes of DataSete properties that are observed.
gPropIdx	The index of the property that contains the spatial information.

Definition at line 44 of file ObservationDataSetInfo.cpp.

References m_phTimePropIdx.

te::st::ObservationDataSetInfo::ObservationDataSetInfo	(	const te::da::DataSourceInfo &	dsinfo,
		const std::string &	dsName,
		const std::vector< int > &	phTimeIdx,
		const std::vector< int > &	obsPropIdx,
		const std::vector< int > &	valTimeIdx,
		int	resTimeIdx,
		int	gPropIdx = `-1`
	)

Constructor.

Parameters

dsinfo	Infos about the DataSource.
dsName	The DataSet name.
phTimeIdx	The indexes of DataSetType properties that contains the phenomen time.
obsPropIdx	The indexes of DataSetType property that are observed.
valTimeIdx	The indexes of DataSetType properties that contains the valid time.
resTimeIdx	The index of DataSetType property that contains the result time.
gPropIdx	The index of the property that contains the spatial information.

Definition at line 58 of file ObservationDataSetInfo.cpp.

References m_phTimePropIdx, and m_validTimePropIdx.

te::st::ObservationDataSetInfo::~ObservationDataSetInfo ( )

virtual

Virtual destructor.

Definition at line 184 of file ObservationDataSetInfo.cpp.

Member Function Documentation

int te::st::ObservationDataSetInfo::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 96 of file ObservationDataSetInfo.cpp.

Referenced by te::st::STDataLoaderFromMemDS::getDataSet(), te::st::STDataLoaderFromMemDS::getSpatialExtent(), and te::st::STDataLoaderFromMemDS::getTemporalExtent().

std::string te::st::ObservationDataSetInfo::getDataSetName ( ) const

It returns the DataSet name.

Returns: The dataSet name

Definition at line 81 of file ObservationDataSetInfo.cpp.

Referenced by te::st::STDataLoader::getCoverage(), te::st::STDataLoaderFromDS::getDataSet(), te::st::STDataLoaderFromMemDS::getDataSet(), te::st::STDataLoaderFromDS::getSpatialExtent(), te::st::STDataLoaderFromMemDS::getSpatialExtent(), and te::st::STDataLoaderFromMemDS::getTemporalExtent().

const te::da::DataSourceInfo & te::st::ObservationDataSetInfo::getDataSourceInfo ( ) const

It returns the information about the DataSource.

Returns: A reference to the internal DataSourceInfo.

Definition at line 76 of file ObservationDataSetInfo.cpp.

Referenced by te::st::STDataLoaderFromDS::getDataSet(), te::st::STDataLoaderFromMemDS::getDataSet(), te::st::STDataLoader::getDataSet(), te::st::STDataLoaderFromDS::getSpatialExtent(), te::st::STDataLoaderFromMemDS::getSpatialExtent(), te::st::STDataLoader::getSpatialExtent(), te::st::STDataLoaderFromMemDS::getTemporalExtent(), and te::st::STDataLoader::getTemporalExtent().

int te::st::ObservationDataSetInfo::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 101 of file ObservationDataSetInfo.cpp.

Referenced by te::st::STDataLoaderFromMemDS::getDataSet(), te::st::STDataLoaderFromMemDS::getSpatialExtent(), and te::st::STDataLoaderFromMemDS::getTemporalExtent().

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

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

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

Definition at line 133 of file ObservationDataSetInfo.cpp.

Referenced by te::st::STDataLoaderFromMemDS::buildDataSet(), te::st::STDataLoaderFromDS::getDataSet(), te::st::STDataLoaderFromMemDS::getDataSet(), te::st::STDataLoaderFromDS::getSpatialExtent(), te::st::STDataLoaderFromMemDS::getSpatialExtent(), te::st::STDataLoaderFromMemDS::getTemporalExtent(), and te::st::GetType().

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

It returns an id (as a string) that identifies the DataSet.

The id is composed of : DataSourceId + DataSetName

Returns: An id that identifies the DataSet

Definition at line 179 of file ObservationDataSetInfo.cpp.

References te::common::Convert2UCase().

const std::vector< int > & te::st::ObservationDataSetInfo::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 122 of file ObservationDataSetInfo.cpp.

Referenced by te::st::GetType().

int te::st::ObservationDataSetInfo::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 169 of file ObservationDataSetInfo.cpp.

Referenced by te::st::GetType().

const std::vector< int > & te::st::ObservationDataSetInfo::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 91 of file ObservationDataSetInfo.cpp.

Referenced by te::st::GetType().

int te::st::ObservationDataSetInfo::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 138 of file ObservationDataSetInfo.cpp.

int te::st::ObservationDataSetInfo::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 143 of file ObservationDataSetInfo.cpp.

const std::vector< int > & te::st::ObservationDataSetInfo::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 148 of file ObservationDataSetInfo.cpp.

Referenced by te::st::GetType().

void te::st::ObservationDataSetInfo::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 112 of file ObservationDataSetInfo.cpp.

void te::st::ObservationDataSetInfo::setDataSetName ( const std::string & name )

It sets the DataSet name.

Parameters

name	The dataSet name

Definition at line 86 of file ObservationDataSetInfo.cpp.

void te::st::ObservationDataSetInfo::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 117 of file ObservationDataSetInfo.cpp.

void te::st::ObservationDataSetInfo::setObsPropIdxs	(	const std::vector< int > &	props,
		int	gPropIdx = `-1`
	)

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.
gPropIdx	The index of the observed property that contains the spatial information.

Definition at line 127 of file ObservationDataSetInfo.cpp.

void te::st::ObservationDataSetInfo::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 174 of file ObservationDataSetInfo.cpp.

void te::st::ObservationDataSetInfo::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 106 of file ObservationDataSetInfo.cpp.

void te::st::ObservationDataSetInfo::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 153 of file ObservationDataSetInfo.cpp.

void te::st::ObservationDataSetInfo::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 158 of file ObservationDataSetInfo.cpp.

void te::st::ObservationDataSetInfo::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 163 of file ObservationDataSetInfo.cpp.

Member Data Documentation

te::da::DataSourceInfo te::st::ObservationDataSetInfo::m_dsInfo

protected

Information about the DataSource from which the DataSet come.

Definition at line 271 of file ObservationDataSetInfo.h.

std::string te::st::ObservationDataSetInfo::m_dsName

protected

The DataSet name.

Definition at line 272 of file ObservationDataSetInfo.h.

int te::st::ObservationDataSetInfo::m_geomPropIdx

protected

The index of the property that contains the spatial information.

Definition at line 275 of file ObservationDataSetInfo.h.

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

protected

The indexes of DataSet properties that are observed.

Definition at line 274 of file ObservationDataSetInfo.h.

Referenced by ObservationDataSetInfo().

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

protected

The indexes of DataSet properties that contain the phenomenon time.

Definition at line 273 of file ObservationDataSetInfo.h.

Referenced by ObservationDataSetInfo().

int te::st::ObservationDataSetInfo::m_resultTimePropIdx

protected

The index of DataSet property that contains the result time.

Definition at line 277 of file ObservationDataSetInfo.h.

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

protected

The indexes of DataSet properties that contain the valid time.

Definition at line 276 of file ObservationDataSetInfo.h.

Referenced by ObservationDataSetInfo().

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

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation