te::st::ObservationDataSetType Class Reference

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

#include <ObservationDataSetType.h>

Public Member Functions

 ObservationDataSetType (const std::string &dsName)
 Constructor. More...
 
 ObservationDataSetType (const ObservationDataSetType &obs)
 Copy constructor. More...
 
const ObservationDataSetTypeoperator= (const ObservationDataSetType &rhs)
 Assignment operator. More...
 
virtual ~ObservationDataSetType ()
 Virtual destructor. More...
 
Operations to set information
void setDataSetName (const std::string &dsName)
 It sets the DataSet name that contains the observations. More...
 
void setTimePropInfo (te::dt::DateTimeProperty *tpInfo)
 It sets the property info that contains the phenomenon beginning 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
std::string getDataSetName () const
 It returns the DataSet name. More...
 
const te::dt::DateTimePropertygetBeginTimePropInfo () const
 It returns the DataSet property information that contains the phenomenon beginning time. More...
 
const te::dt::DateTimePropertygetEndTimePropInfo () const
 It returns the DataSet property information that contains the phenomenon end time. More...
 
const te::dt::DateTimegetTime () const
 It returns the phenomenon time. More...
 
const te::dt::DateTimePropertygetVlBeginTimePropInfo () const
 It returns the DataSet property information that contains the valid beginning time. More...
 
const te::dt::DateTimePropertygetVlEndTimePropInfo () const
 It returns the DataSet property information that contains the valid end time. More...
 
const te::dt::DateTimePeriodgetVlTime () const
 It returns the valid time. More...
 
const te::dt::DateTimePropertygetRsTimePropInfo () const
 It returns the DataSet property information that contains the result time. More...
 
const te::dt::DateTimeInstantgetRsTime () 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::GeometryPropertygetGeomPropInfo () const
 It returns the DataSet property information that contains the geometry. More...
 
const te::gm::GeometrygetGeometry () 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::DateTimePeriodgetTemporalExtent () const
 It returns the temporal extent of the observations. More...
 
const te::gm::GeometrygetSpatialExtent () 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...
 

Private Attributes

std::string m_dsName
 The DataSet name. More...
 
std::auto_ptr< te::gm::Geometrym_geom
 Geometry: the geometry, when the spatial location of the observations are not in the DataSet. More...
 
std::auto_ptr< te::gm::GeometryPropertym_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::DateTimem_phTime
 Phenomenon time: the phenomenon time, when the time is not inside a DataSet. More...
 
boost::ptr_vector< te::dt::DateTimePropertym_phTimePropInfo
 Phenomenon time: information about the DataSet properties that contain the phenomenon time. More...
 
std::auto_ptr< te::dt::DateTimeInstantm_resultTime
 Result time: the result time, when the time is not inside a DataSet. More...
 
std::auto_ptr< te::dt::DateTimePropertym_resultTimePropInfo
 Result time: information about the DataSet property that contains the result time. More...
 
std::auto_ptr< te::gm::Geometrym_spatialExtent
 Spatial extent. More...
 
std::auto_ptr< te::dt::DateTimePeriodm_temporalExtent
 Temporal extent. More...
 
std::auto_ptr< te::dt::DateTimePeriodm_validTime
 Valid time: the valid time, when the time is not inside a DataSet. More...
 
boost::ptr_vector< te::dt::DateTimePropertym_validTimePropInfo
 Valid time: information about the 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 70 of file ObservationDataSetType.h.

Constructor & Destructor Documentation

te::st::ObservationDataSetType::ObservationDataSetType ( const std::string &  dsName)

Constructor.

Parameters
dsNameThe DataSet name.
te::st::ObservationDataSetType::ObservationDataSetType ( const ObservationDataSetType obs)

Copy constructor.

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

Virtual destructor.

Member Function Documentation

const te::dt::DateTimeProperty* te::st::ObservationDataSetType::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::ObservationDataSetType::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::ObservationDataSetType::getDataSetName ( ) const

It returns the DataSet name.

Returns
The dataSet name
const te::dt::DateTimeProperty* te::st::ObservationDataSetType::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::ObservationDataSetType::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::ObservationDataSetType::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::ObservationDataSetType::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::ObservationDataSetType::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::ObservationDataSetType::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::ObservationDataSetType::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::ObservationDataSetType::getObsId ( ) const

It returns the identifier associated to all observations.

Returns
The identifier associated to all observations.
const std::vector<int>& te::st::ObservationDataSetType::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::ObservationDataSetType::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::ObservationDataSetType::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::ObservationDataSetType::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::ObservationDataSetType::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::ObservationDataSetType::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::ObservationDataSetType::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::ObservationDataSetType::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::ObservationDataSetType::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::ObservationDataSetType::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::ObservationDataSetType::hasGeometry ( ) const
bool te::st::ObservationDataSetType::hasGeomProp ( ) const
bool te::st::ObservationDataSetType::hasId ( ) const
bool te::st::ObservationDataSetType::hasIdProp ( ) const
bool te::st::ObservationDataSetType::hasRsTime ( ) const
bool te::st::ObservationDataSetType::hasRsTimeProp ( ) const
bool te::st::ObservationDataSetType::hasSpatialExtent ( ) const
bool te::st::ObservationDataSetType::hasTemporalExtent ( ) const
bool te::st::ObservationDataSetType::hasTime ( ) const
bool te::st::ObservationDataSetType::hasTimeProp ( ) const
bool te::st::ObservationDataSetType::hasTwoTimeProp ( ) const
bool te::st::ObservationDataSetType::hasTwoVlTimeProp ( ) const
bool te::st::ObservationDataSetType::hasVlTime ( ) const
bool te::st::ObservationDataSetType::hasVlTimeProp ( ) const
const ObservationDataSetType& te::st::ObservationDataSetType::operator= ( const ObservationDataSetType rhs)

Assignment operator.

void te::st::ObservationDataSetType::setDataSetName ( const std::string &  dsName)

It sets the DataSet name that contains the observations.

Parameters
dsNameThe DataSet name.
void te::st::ObservationDataSetType::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
geomThe geometry associated to all observations.
Note
It will take the ownership of the given pointer.
void te::st::ObservationDataSetType::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
propThe info about the property that contains the observation location.
Note
It will take the ownership of the given pointer.
void te::st::ObservationDataSetType::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
idThe identifier associated to all observations.
void te::st::ObservationDataSetType::setIdPropInfo ( int  idProp)

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

Parameters
idPropThe index of the DataSet property that contains identifiers that groups the observations.
void te::st::ObservationDataSetType::setIdPropInfo ( const std::string &  idProp)

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

Parameters
idPropThe name of the DataSet property that contains identifiers that groups the observations.
void te::st::ObservationDataSetType::setObsPropInfo ( const std::vector< int > &  props)

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

Parameters
propsThe indexes of the DataSet properties that are observed over time.
void te::st::ObservationDataSetType::setObsPropInfo ( const std::vector< std::string > &  props)

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

Parameters
propsThe names of the DataSet properties that are observed over time.
void te::st::ObservationDataSetType::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
tThe result time.
Note
It will take the ownership of the given pointers.
void te::st::ObservationDataSetType::setRsTimePropInfo ( te::dt::DateTimeProperty tpInfo)

It sets the property info that contains the result time.

Parameters
tpInfoThe property info that contains the result time.
Note
It will take the ownership of the given pointers.
void te::st::ObservationDataSetType::setSpatialExtent ( te::gm::Geometry se)

It sets the spatial extent of all observations.

Parameters
seThe spatial extent of all observations.
Note
It will take the ownership of the given pointer.
void te::st::ObservationDataSetType::setTemporalExtent ( te::dt::DateTimePeriod te)

It sets the temporal extent of all observations.

Parameters
teThe temporal extent of all observations.
Note
It will take the ownership of the given pointer.
void te::st::ObservationDataSetType::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
tThe phenomenon time.
Note
It will take the ownership of the given pointers.
void te::st::ObservationDataSetType::setTimePropInfo ( te::dt::DateTimeProperty tpInfo)

It sets the property info that contains the phenomenon beginning time.

Parameters
tpInfoThe property info that contains the phenomenon beginning time.
Note
It will take the ownership of the given pointers.
void te::st::ObservationDataSetType::setTimePropInfo ( te::dt::DateTimeProperty tpInfo1,
te::dt::DateTimeProperty tpInfo2 
)

It sets the property info that contains the phenomenon time.

Parameters
tpInfo1The property info that contains the phenomenon beginning time.
tpInfo2The property info that contains the phenomenon beginning time.
Note
It will take the ownership of the given pointers.
void te::st::ObservationDataSetType::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
tThe valid time.
Note
It will take the ownership of the given pointers.
void te::st::ObservationDataSetType::setVlTimePropInfo ( te::dt::DateTimeProperty tpInfo)

It sets the property info that contains the valid time.

Parameters
tpInfoThe property info that contains the valid time.
Note
It will take the ownership of the given pointers.
void te::st::ObservationDataSetType::setVlTimePropInfo ( te::dt::DateTimeProperty tpInfo1,
te::dt::DateTimeProperty tpInfo2 
)

It sets the property info that contains the valid time.

Parameters
tpInfo1The property info that contains the phenomenon valid time.
tpInfo2The property info that contains the phenomenon valid time.
Note
It will take the ownership of the given pointers.

Member Data Documentation

std::string te::st::ObservationDataSetType::m_dsName
private

The DataSet name.

Definition at line 479 of file ObservationDataSetType.h.

std::auto_ptr<te::gm::Geometry> te::st::ObservationDataSetType::m_geom
private

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

Definition at line 494 of file ObservationDataSetType.h.

std::auto_ptr<te::gm::GeometryProperty> te::st::ObservationDataSetType::m_geomPropInfo
private

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

Definition at line 493 of file ObservationDataSetType.h.

std::string te::st::ObservationDataSetType::m_id
private

Id: the id associated to all observations.

Definition at line 498 of file ObservationDataSetType.h.

int te::st::ObservationDataSetType::m_idPropIndex
private

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

Definition at line 496 of file ObservationDataSetType.h.

std::string te::st::ObservationDataSetType::m_idPropName
private

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

Definition at line 497 of file ObservationDataSetType.h.

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

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

Definition at line 490 of file ObservationDataSetType.h.

std::vector<std::string> te::st::ObservationDataSetType::m_observedPropName
private

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

Definition at line 491 of file ObservationDataSetType.h.

std::auto_ptr<te::dt::DateTime> te::st::ObservationDataSetType::m_phTime
private

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

Definition at line 482 of file ObservationDataSetType.h.

boost::ptr_vector<te::dt::DateTimeProperty> te::st::ObservationDataSetType::m_phTimePropInfo
private

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

Definition at line 481 of file ObservationDataSetType.h.

std::auto_ptr<te::dt::DateTimeInstant> te::st::ObservationDataSetType::m_resultTime
private

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

Definition at line 488 of file ObservationDataSetType.h.

std::auto_ptr<te::dt::DateTimeProperty> te::st::ObservationDataSetType::m_resultTimePropInfo
private

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

Definition at line 487 of file ObservationDataSetType.h.

std::auto_ptr<te::gm::Geometry> te::st::ObservationDataSetType::m_spatialExtent
private

Spatial extent.

Definition at line 500 of file ObservationDataSetType.h.

std::auto_ptr<te::dt::DateTimePeriod> te::st::ObservationDataSetType::m_temporalExtent
private

Temporal extent.

Definition at line 501 of file ObservationDataSetType.h.

std::auto_ptr<te::dt::DateTimePeriod> te::st::ObservationDataSetType::m_validTime
private

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

Definition at line 485 of file ObservationDataSetType.h.

boost::ptr_vector<te::dt::DateTimeProperty> te::st::ObservationDataSetType::m_validTimePropInfo
private

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

Definition at line 484 of file ObservationDataSetType.h.


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