A class to represent an observation. More...

#include <Observation.h>

Public Member Functions
void	addValue (te::dt::AbstractData *value)
	It adds an observed value. More...

Observation *	clone () const
	It returns a clone of this object. More...

te::gm::Geometry *	getGeometry () const
	It returns the observation location or region. More...

const te::dt::AbstractData *	getObservedValue (int idx=0) const
	It returns the idx-th observed value. More...

boost::ptr_vector< te::dt::AbstractData > &	getObservedValues ()
	It returns the observed values. More...

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

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

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

	Observation ()
	It constructs an empty Observation. More...

	Observation (te::dt::DateTime *phTime)
	Constructor. More...

	Observation (te::dt::DateTime phTime, te::dt::AbstractData obsValue)
	Constructor. More...

	Observation (te::dt::DateTime phTime, te::gm::Geometry geom, const boost::ptr_vector< te::dt::AbstractData > &obsValues)
	Constructor. More...

	Observation (te::dt::DateTime phTime, te::dt::DateTimeInstant resTime, te::dt::DateTimePeriod valTime, te::gm::Geometry geom, const boost::ptr_vector< te::dt::AbstractData > &obsValues)
	Constructor. More...

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

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

void	setGeometry (te::gm::Geometry *geom)
	It sets the observation location or region. More...

void	setResultTime (te::dt::DateTimeInstant *resTime)
	It sets the result time. More...

void	setTime (te::dt::DateTime *phTime)
	It sets the phenomenon time. More...

void	setValidTime (te::dt::DateTimePeriod *valTime)
	It sets the valid time. More...

void	setValues (const boost::ptr_vector< te::dt::AbstractData > &values)
	It sets the observed values. More...

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

Private Attributes
std::auto_ptr< te::gm::Geometry >	m_geometry
	The observation location. More...

boost::ptr_vector< te::dt::AbstractData >	m_observedValues
	The observed values. More...

std::auto_ptr< te::dt::DateTime >	m_phTime
	The phenomenon time. More...

std::auto_ptr< te::dt::DateTimeInstant >	m_resultTime
	The result time. More...

std::auto_ptr< te::dt::DateTimePeriod >	m_validTime
	The valid time. More...

Detailed Description

A class to represent an observation.

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, (4) observed values.

See also: ObservationDataSet AbstractData DateTime

Definition at line 60 of file Observation.h.

Constructor & Destructor Documentation

te::st::Observation::Observation ( )

It constructs an empty Observation.

te::st::Observation::Observation ( te::dt::DateTime * phTime )

Constructor.

Parameters

phTime A pointer to phenomenon time.

Note: It will take the ownership of the DateTime input pointer.

te::st::Observation::Observation	(	te::dt::DateTime *	phTime,
		te::dt::AbstractData *	obsValue
	)

Constructor.

Parameters

phTime	A pointer to phenomenon time.
obsValue	A observed value.

Note: It will take the ownership of the DateTime and AbstractData input pointers.

te::st::Observation::Observation	(	te::dt::DateTime *	phTime,
		te::gm::Geometry *	geom,
		const boost::ptr_vector< te::dt::AbstractData > &	obsValues
	)

Constructor.

Parameters

phTime	A pointer to phenomenon time.
geom	The observation location.
obsValues	The observed values.

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

te::st::Observation::Observation	(	te::dt::DateTime *	phTime,
		te::dt::DateTimeInstant *	resTime,
		te::dt::DateTimePeriod *	valTime,
		te::gm::Geometry *	geom,
		const boost::ptr_vector< te::dt::AbstractData > &	obsValues
	)

Constructor.

Parameters

phTime	A pointer to phenomenon time.
resTime	A pointer to the result time.
valTime	A pointer to the valid time.
geom	The observation location.
obsValues	The observed values.

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

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

Copy constructor.

virtual te::st::Observation::~Observation ( )

virtual

Virtual destructor.

Member Function Documentation

void te::st::Observation::addValue ( te::dt::AbstractData * value )

It adds an observed value.

Parameters

A	pointer to the observed value to be added.

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

Observation* te::st::Observation::clone ( ) const

It returns a clone of this object.

Returns: A clone of this object.

Note: The caller will take the ownership of the input pointer.

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

It returns the observation location or region.

Returns: A pointer to the geometry.

Note: The caller will NOT take the ownership of the returned pointer.

const te::dt::AbstractData* te::st::Observation::getObservedValue ( int idx = 0 ) const

It returns the idx-th observed value.

Returns: A pointer to the idx-th observed value.

Note: The caller will NOT take the ownership of the returned pointer.

boost::ptr_vector<te::dt::AbstractData>& te::st::Observation::getObservedValues ( )

It returns the observed values.

Returns: A reference to the observed values.

Note: The caller will NOT take the ownership of the returned pointer.

te::dt::DateTimeInstant* te::st::Observation::getResultTime ( ) const

It returns the result time.

Returns: A pointer to the result time.

Note: The caller will NOT take the ownership of the returned pointer.

te::dt::DateTime* te::st::Observation::getTime ( ) const

It returns the phenomenon time.

Returns: A pointer to the phenomenon time.

Note: The caller will NOT take the ownership of the returned pointer.

te::dt::DateTimePeriod* te::st::Observation::getValidTime ( ) const

It returns the valid time.

Returns: A pointer to the valid time.

Note: The caller will NOT take the ownership of the returned pointer.

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

Assignment operator.

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

It sets the observation location or region.

Parameters

geom	A pointer to the observation location or region.

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

void te::st::Observation::setResultTime ( te::dt::DateTimeInstant * resTime )

It sets the result time.

Parameters

A	pointer to the result time.

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

void te::st::Observation::setTime ( te::dt::DateTime * phTime )

It sets the phenomenon time.

Parameters

A	pointer to the the phenomenon time.

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

void te::st::Observation::setValidTime ( te::dt::DateTimePeriod * valTime )

It sets the valid time.

Parameters

A	pointer to the valid time.

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

void te::st::Observation::setValues ( const boost::ptr_vector< te::dt::AbstractData > & values )

It sets the observed values.

Parameters

A	reference to the observed values.

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

Member Data Documentation

std::auto_ptr<te::gm::Geometry> te::st::Observation::m_geometry

private

The observation location.

Definition at line 248 of file Observation.h.

boost::ptr_vector<te::dt::AbstractData> te::st::Observation::m_observedValues

private

The observed values.

Definition at line 247 of file Observation.h.

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

private

The phenomenon time.

Definition at line 244 of file Observation.h.

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

private

The result time.

Definition at line 245 of file Observation.h.

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

private

The valid time.

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation