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

#include <ObservationDataSetInfo.h>

Public Member Functions
std::string	getDSId () const
	It returns an id (as a string) that identifies the DataSet. More...

	ObservationDataSetInfo (const te::da::DataSourceInfo &dsInfo, const std::string &dsName)
	Constructor. More...

	ObservationDataSetInfo (const ObservationDataSetInfo &obs)
	Copy constructor. More...

const ObservationDataSetInfo &	operator= (const ObservationDataSetInfo &rhs)
	Assignment operator. More...

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

Operations to set information
void	setDataSourceInfo (const te::da::DataSourceInfo &dsinfo, const std::string &dsName)
	It sets the information about the DataSource and the DataSet name that contains the observations. More...

void	setTimePropInfo (te::dt::DateTimeProperty *tpInfo)
	It sets the property info that contains the phenomenon time. More...

void	setTimePropInfo (te::dt::DateTimeProperty tpInfo1, te::dt::DateTimeProperty tpInfo2)
	It sets the property info that contains the phenomenon time. More...

void	setTime (te::dt::DateTime *t)
	It sets the phenomenon time associated to all observations. More...

void	setVlTimePropInfo (te::dt::DateTimeProperty *tpInfo)
	It sets the property info that contains the valid time. More...

void	setVlTimePropInfo (te::dt::DateTimeProperty tpInfo1, te::dt::DateTimeProperty tpInfo2)
	It sets the property info that contains the valid time. More...

void	setVlTime (te::dt::DateTimePeriod *t)
	It sets the valid time associated to all observations. More...

void	setRsTimePropInfo (te::dt::DateTimeProperty *tpInfo)
	It sets the property info that contains the result time. More...

void	setRsTime (te::dt::DateTimeInstant *t)
	It sets the result time associated to all observations. More...

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

void	setObsPropInfo (const std::vector< std::string > &props)
	It sets the names of the DataSet properties that are observed over time. More...

void	setGeomPropInfo (te::gm::GeometryProperty *prop)
	It sets the info about the property that contains the observation location. More...

void	setGeometry (te::gm::Geometry *geom)
	It sets the geometry associated to all observations. More...

void	setIdPropInfo (int idProp)
	It sets the index of the DataSet property that contains identifiers that groups the observations. More...

void	setIdPropInfo (const std::string &idProp)
	It sets the name of the DataSet property that contains identifiers that groups the observations. More...

void	setId (const std::string &id)
	It sets the identifier associated to all observations. More...

void	setSpatialExtent (te::gm::Geometry *se)
	It sets the spatial extent of all observations. More...

void	setTemporalExtent (te::dt::DateTimePeriod *te)
	It sets the temporal extent of all observations. More...

Operations to check information
bool	hasTimeProp () const

bool	hasTwoTimeProp () const

bool	hasTime () const

bool	hasVlTimeProp () const

bool	hasTwoVlTimeProp () const

bool	hasVlTime () const

bool	hasRsTimeProp () const

bool	hasRsTime () const

bool	hasGeomProp () const

bool	hasGeometry () const

bool	hasIdProp () const

bool	hasId () const

bool	hasSpatialExtent () const

bool	hasTemporalExtent () const

Operations to get information
const te::da::DataSourceInfo &	getDataSourceInfo () const
	It returns the information about the DataSource. More...

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

const te::dt::DateTimeProperty *	getBeginTimePropInfo () const
	It returns the DataSet property information that contains the phenomenon beginning time. More...

const te::dt::DateTimeProperty *	getEndTimePropInfo () const
	It returns the DataSet property information that contains the phenomenon end time. More...

const te::dt::DateTime *	getTime () const
	It returns the phenomenon time. More...

const te::dt::DateTimeProperty *	getVlBeginTimePropInfo () const
	It returns the DataSet property information that contains the valid beginning time. More...

const te::dt::DateTimeProperty *	getVlEndTimePropInfo () const
	It returns the DataSet property information that contains the valid end time. More...

const te::dt::DateTimePeriod *	getVlTime () const
	It returns the valid time. More...

const te::dt::DateTimeProperty *	getRsTimePropInfo () const
	It returns the DataSet property information that contains the result time. More...

const te::dt::DateTimeInstant *	getRsTime () const
	It returns the result time. More...

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

const std::vector< std::string > &	getObsPropNames () const
	It returns the names of the DataSet properties that are observed over time. More...

const te::gm::GeometryProperty *	getGeomPropInfo () const
	It returns the DataSet property information that contains the geometry. More...

const te::gm::Geometry *	getGeometry () const
	It returns the geometry associated to all observations. More...

int	getIdPropIdx () const
	It returns the index of the property that contains identifiers that groups observations. More...

std::string	getIdPropName () const
	It returns the name of the property that contains identifiers that groups observations. More...

std::string	getObsId () const
	It returns the identifier associated to all observations. More...

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

const te::gm::Geometry *	getSpatialExtent () const
	It returns the spatial extent of the observations. More...

std::string	getBeginTimePropName () const
	It returns the name of the DataSet property that contains the phenomenon beginning time. More...

std::string	getEndTimePropName () const
	It returns the name of the DataSet property that contains the phenomenon end time. More...

std::string	getGeomPropName () const
	It returns the name of the property that is a geometry property. 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...

std::auto_ptr< te::gm::Geometry >	m_geom
	Geometry: the geometry, when the spatial location of the observations are not in the DataSet. More...

std::auto_ptr< te::gm::GeometryProperty >	m_geomPropInfo
	Geometry: information about the property that has the observation spatial location. More...

std::string	m_id
	Id: the id associated to all observations. More...

int	m_idPropIndex
	Id: the index of DataSet property that contain the id of each group of observation. More...

std::string	m_idPropName
	Id: the name of DataSet property that contain the id of each group of observation. More...

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

std::vector< std::string >	m_observedPropName
	Observed properties: the names of DataSet properties that are observed. More...

std::auto_ptr< te::dt::DateTime >	m_phTime
	Phenomenon time: the phenomenon time, when the time is not inside a DataSet. More...

boost::ptr_vector< te::dt::DateTimeProperty >	m_phTimePropInfo
	Phenomenon time: information about the DataSet properties that contain the phenomenon time. More...

std::auto_ptr< te::dt::DateTimeInstant >	m_resultTime
	Result time: the result time, when the time is not inside a DataSet. More...

std::auto_ptr< te::dt::DateTimeProperty >	m_resultTimePropInfo
	Result time: information about the DataSet property that contains the result time. More...

std::auto_ptr< te::gm::Geometry >	m_spatialExtent
	Spatial extent. More...

std::auto_ptr< te::dt::DateTimePeriod >	m_temporalExtent
	Temporal extent. More...

std::auto_ptr< te::dt::DateTimePeriod >	m_validTime
	Valid time: the valid time, when the time is not inside a DataSet. More...

boost::ptr_vector< te::dt::DateTimeProperty >	m_validTimePropInfo
	Valid time: information about the 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 70 of file ObservationDataSetInfo.h.

Constructor & Destructor Documentation

te::st::ObservationDataSetInfo::ObservationDataSetInfo	(	const te::da::DataSourceInfo &	dsInfo,
		const std::string &	dsName
	)

Constructor.

Parameters

dsinfo	Infos about the DataSource.
dsName	The DataSet name.

te::st::ObservationDataSetInfo::ObservationDataSetInfo ( const ObservationDataSetInfo & obs )

Copy constructor.

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

virtual

Virtual destructor.

Member Function Documentation

const te::dt::DateTimeProperty* te::st::ObservationDataSetInfo::getBeginTimePropInfo ( ) const

It returns the DataSet property information that contains the phenomenon beginning time.

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

Note: The user does NOT take the ownership of the returned pointer.; The returned pointer can be NULL, when there is no information.

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

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

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

Note: It returns "" when there is no a phenomenon beginning time.

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

It returns the DataSet name.

Returns: The dataSet name

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

It returns the information about the DataSource.

Returns: A reference to the internal DataSourceInfo.

std::string te::st::ObservationDataSetInfo::getDSId ( ) 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

const te::dt::DateTimeProperty* te::st::ObservationDataSetInfo::getEndTimePropInfo ( ) const

It returns the DataSet property information that contains the phenomenon end time.

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

Note: The user does NOT take the ownership of the returned pointer.; The returned pointer can be NULL, when there is no information.

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

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

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

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

const te::gm::Geometry* te::st::ObservationDataSetInfo::getGeometry ( ) const

It returns the geometry associated to all observations.

Returns: The geometry associated to all observations.

Note: The user does NOT take the ownership of the returned pointer.; The returned pointer can be NULL, when there is no information.

const te::gm::GeometryProperty* te::st::ObservationDataSetInfo::getGeomPropInfo ( ) const

It returns the DataSet property information that contains the geometry.

Returns: The DataSet property information that contains the geometry.

Note: The user does NOT take the ownership of the returned pointer.; The returned pointer can be NULL, when there is no information.

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

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

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

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

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

It returns the index of the property that contains identifiers that groups observations.

Returns: The index of the property that contains identifiers that groups observations.

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

It returns the name of the property that contains identifiers that groups observations.

Returns: The name of the property that contains identifiers that groups observations.

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

It returns the identifier associated to all observations.

Returns: The identifier associated to all observations.

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

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

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

const std::vector<std::string>& te::st::ObservationDataSetInfo::getObsPropNames ( ) const

It returns the names of the DataSet properties that are observed over time.

Returns: The names of the DataSet properties that are observed over time.

const te::dt::DateTimeInstant* te::st::ObservationDataSetInfo::getRsTime ( ) const

It returns the result time.

Returns: The result time.

Note: The user does NOT take the ownership of the returned pointer.; The returned pointer can be NULL, when there is no information.

const te::dt::DateTimeProperty* te::st::ObservationDataSetInfo::getRsTimePropInfo ( ) const

It returns the DataSet property information that contains the result time.

Returns: The DataSet property information that contains the result time.

Note: The user does NOT take the ownership of the returned pointer.; The returned pointer can be NULL, when there is no information.

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

It returns the spatial extent of the observations.

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::ObservationDataSetInfo::getTemporalExtent ( ) const

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 te::dt::DateTime* te::st::ObservationDataSetInfo::getTime ( ) const

It returns the phenomenon time.

Returns: The phenomenon time.

Note: The user does NOT take the ownership of the returned pointer.; The returned pointer can be NULL, when there is no information.

const te::dt::DateTimeProperty* te::st::ObservationDataSetInfo::getVlBeginTimePropInfo ( ) const

It returns the DataSet property information that contains the valid beginning time.

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

Note: The user does NOT take the ownership of the returned pointer.; The returned pointer can be NULL, when there is no information.

const te::dt::DateTimeProperty* te::st::ObservationDataSetInfo::getVlEndTimePropInfo ( ) const

It returns the DataSet property information that contains the valid end time.

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

Note: The user does NOT take the ownership of the returned pointer.; The returned pointer can be NULL, when there is no information.

const te::dt::DateTimePeriod* te::st::ObservationDataSetInfo::getVlTime ( ) const

It returns the valid time.

Returns: The valid time.

Note: The user does NOT take the ownership of the returned pointer.; The returned pointer can be NULL, when there is no information.

bool te::st::ObservationDataSetInfo::hasGeometry ( ) const

bool te::st::ObservationDataSetInfo::hasGeomProp ( ) const

bool te::st::ObservationDataSetInfo::hasId ( ) const

bool te::st::ObservationDataSetInfo::hasIdProp ( ) const

bool te::st::ObservationDataSetInfo::hasRsTime ( ) const

bool te::st::ObservationDataSetInfo::hasRsTimeProp ( ) const

bool te::st::ObservationDataSetInfo::hasSpatialExtent ( ) const

bool te::st::ObservationDataSetInfo::hasTemporalExtent ( ) const

bool te::st::ObservationDataSetInfo::hasTime ( ) const

bool te::st::ObservationDataSetInfo::hasTimeProp ( ) const

bool te::st::ObservationDataSetInfo::hasTwoTimeProp ( ) const

bool te::st::ObservationDataSetInfo::hasTwoVlTimeProp ( ) const

bool te::st::ObservationDataSetInfo::hasVlTime ( ) const

bool te::st::ObservationDataSetInfo::hasVlTimeProp ( ) const

const ObservationDataSetInfo& te::st::ObservationDataSetInfo::operator= ( const ObservationDataSetInfo & rhs )

Assignment operator.

void te::st::ObservationDataSetInfo::setDataSourceInfo	(	const te::da::DataSourceInfo &	dsinfo,
		const std::string &	dsName
	)

It sets the information about the DataSource and the DataSet name that contains the observations.

Parameters

dsinfo	Infos about the DataSource.
dsName	The DataSet name.

void te::st::ObservationDataSetInfo::setGeometry ( te::gm::Geometry * geom )

It sets the geometry associated to all observations.

In this case, the location of all observations is NOT stored in the DataSet as a geometry property. The observation location is informed by the user.

Parameters

geom	The geometry associated to all observations.

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

void te::st::ObservationDataSetInfo::setGeomPropInfo ( te::gm::GeometryProperty * prop )

It sets the info about the property that contains the observation location.

In this case, the location of each observation is stored in the DataSet as a geometry property. The geometry property can be observed over time or be the same for all observations.

Parameters

prop	The info about the property that contains the observation location.

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

void te::st::ObservationDataSetInfo::setId ( const std::string & id )

It sets the identifier associated to all observations.

In this case, the identifier is NOT in the DataSet. It is informed by the user.

Parameters

id	The identifier associated to all observations.

void te::st::ObservationDataSetInfo::setIdPropInfo ( int idProp )

It sets the index of the DataSet property that contains identifiers that groups the observations.

Parameters

idProp The index of the DataSet property that contains identifiers that groups the observations.

void te::st::ObservationDataSetInfo::setIdPropInfo ( const std::string & idProp )

It sets the name of the DataSet property that contains identifiers that groups the observations.

Parameters

idProp The name of the DataSet property that contains identifiers that groups the observations.

void te::st::ObservationDataSetInfo::setObsPropInfo ( const std::vector< int > & props )

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

Parameters

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

void te::st::ObservationDataSetInfo::setObsPropInfo ( const std::vector< std::string > & props )

It sets the names of the DataSet properties that are observed over time.

Parameters

props The names of the DataSet properties that are observed over time.

void te::st::ObservationDataSetInfo::setRsTime ( te::dt::DateTimeInstant * t )

It sets the result time associated to all observations.

In this case, the result time is not inside the DataSet but it is informed by the user.

Parameters

t	The result time.

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

void te::st::ObservationDataSetInfo::setRsTimePropInfo ( te::dt::DateTimeProperty * tpInfo )

It sets the property info that contains the result time.

Parameters

tpInfo The property info that contains the result time.

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

void te::st::ObservationDataSetInfo::setSpatialExtent ( te::gm::Geometry * se )

It sets the spatial extent of all observations.

Parameters

se	The spatial extent of all observations.

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

void te::st::ObservationDataSetInfo::setTemporalExtent ( te::dt::DateTimePeriod * te )

It sets the temporal extent of all observations.

Parameters

te	The temporal extent of all observations.

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

void te::st::ObservationDataSetInfo::setTime ( te::dt::DateTime * t )

It sets the phenomenon time associated to all observations.

In this case, the phenomenon time is not inside the DataSet but it is informed by the user.

Parameters

t	The phenomenon time.

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

void te::st::ObservationDataSetInfo::setTimePropInfo ( te::dt::DateTimeProperty * tpInfo )

It sets the property info that contains the phenomenon time.

Parameters

tpInfo The property info that contains the phenomenon time.

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

void te::st::ObservationDataSetInfo::setTimePropInfo	(	te::dt::DateTimeProperty *	tpInfo1,
		te::dt::DateTimeProperty *	tpInfo2
	)

It sets the property info that contains the phenomenon time.

Parameters

tpInfo1	The property info that contains the phenomenon beginning time.
tpInfo2	The property info that contains the phenomenon beginning time.

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

void te::st::ObservationDataSetInfo::setVlTime ( te::dt::DateTimePeriod * t )

It sets the valid time associated to all observations.

In this case, the valid time is not inside the DataSet but it is informed by the user.

Parameters

t	The valid time.

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

void te::st::ObservationDataSetInfo::setVlTimePropInfo ( te::dt::DateTimeProperty * tpInfo )

It sets the property info that contains the valid time.

Parameters

tpInfo The property info that contains the valid time.

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

void te::st::ObservationDataSetInfo::setVlTimePropInfo	(	te::dt::DateTimeProperty *	tpInfo1,
		te::dt::DateTimeProperty *	tpInfo2
	)

It sets the property info that contains the valid time.

Parameters

tpInfo1	The property info that contains the phenomenon valid time.
tpInfo2	The property info that contains the phenomenon valid time.

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

Member Data Documentation

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

protected

Information about the DataSource from which the DataSet come.

Definition at line 498 of file ObservationDataSetInfo.h.

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

protected

The DataSet name.

Definition at line 499 of file ObservationDataSetInfo.h.

std::auto_ptr<te::gm::Geometry> te::st::ObservationDataSetInfo::m_geom

protected

Geometry: the geometry, when the spatial location of the observations are not in the DataSet.

Definition at line 514 of file ObservationDataSetInfo.h.

std::auto_ptr<te::gm::GeometryProperty> te::st::ObservationDataSetInfo::m_geomPropInfo

protected

Geometry: information about the property that has the observation spatial location.

Definition at line 513 of file ObservationDataSetInfo.h.

std::string te::st::ObservationDataSetInfo::m_id

protected

Id: the id associated to all observations.

Definition at line 518 of file ObservationDataSetInfo.h.

int te::st::ObservationDataSetInfo::m_idPropIndex

protected

Id: the index of DataSet property that contain the id of each group of observation.

Definition at line 516 of file ObservationDataSetInfo.h.

std::string te::st::ObservationDataSetInfo::m_idPropName

protected

Id: the name of DataSet property that contain the id of each group of observation.

Definition at line 517 of file ObservationDataSetInfo.h.

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

protected

Observed properties: the indexes of DataSet properties that are observed.

Definition at line 510 of file ObservationDataSetInfo.h.

std::vector<std::string> te::st::ObservationDataSetInfo::m_observedPropName

protected

Observed properties: the names of DataSet properties that are observed.

Definition at line 511 of file ObservationDataSetInfo.h.

std::auto_ptr<te::dt::DateTime> te::st::ObservationDataSetInfo::m_phTime

protected

Phenomenon time: the phenomenon time, when the time is not inside a DataSet.

Definition at line 502 of file ObservationDataSetInfo.h.

boost::ptr_vector<te::dt::DateTimeProperty> te::st::ObservationDataSetInfo::m_phTimePropInfo

protected

Phenomenon time: information about the DataSet properties that contain the phenomenon time.

Definition at line 501 of file ObservationDataSetInfo.h.

std::auto_ptr<te::dt::DateTimeInstant> te::st::ObservationDataSetInfo::m_resultTime

protected

Result time: the result time, when the time is not inside a DataSet.

Definition at line 508 of file ObservationDataSetInfo.h.

std::auto_ptr<te::dt::DateTimeProperty> te::st::ObservationDataSetInfo::m_resultTimePropInfo

protected

Result time: information about the DataSet property that contains the result time.

Definition at line 507 of file ObservationDataSetInfo.h.

std::auto_ptr<te::gm::Geometry> te::st::ObservationDataSetInfo::m_spatialExtent

protected

Spatial extent.

Definition at line 520 of file ObservationDataSetInfo.h.

std::auto_ptr<te::dt::DateTimePeriod> te::st::ObservationDataSetInfo::m_temporalExtent

protected

Temporal extent.

Definition at line 521 of file ObservationDataSetInfo.h.

std::auto_ptr<te::dt::DateTimePeriod> te::st::ObservationDataSetInfo::m_validTime

protected

Valid time: the valid time, when the time is not inside a DataSet.

Definition at line 505 of file ObservationDataSetInfo.h.

boost::ptr_vector<te::dt::DateTimeProperty> te::st::ObservationDataSetInfo::m_validTimePropInfo

protected

Valid time: information about the DataSet properties that contain the valid time.

Definition at line 504 of file ObservationDataSetInfo.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/ObservationDataSetInfo.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation