Implementation of a in-memory data set that contains spatiotemporal observations indexed by time and space. More...

#include <DataSet.h>

Inheritance diagram for te::stmem::DataSet:

Public Member Functions
void	add (const std::pair< te::dt::DateTime *, DateSetItemShrPtr > &item)
	It adds an existing item to the dataset. More...

void	add (te::mem::DataSetItem *item)
	It adds a new item to the dataset and takes its ownership. More...

std::auto_ptr< DataSet >	clone () const
	It returns a clone of the DataSet. More...

void	copy (te::da::DataSet *src, unsigned int limit=0)
	It copies up to limit items from the source dataset. More...

void	copy (te::da::DataSet *src, const std::vector< std::size_t > &properties, unsigned int limit=0)
	It copies up to limit items from the source dataset (src). More...

	DataSet (const te::da::DataSetType *type, int tpPropIdx)
	It constructs an empty in-memory dataset indexed by time and space. More...

	DataSet (const te::da::DataSetType *type, int tpPropIdx, int gmPropIdx)
	It constructs an empty in-memory dataset indexed by time and space. More...

	DataSet (const te::da::DataSetType *type, int begTimePropIdx, int endTimePropIdx, int gmPropIdx)
	It constructs an empty in-memory dataset indexed by time and space. More...

	DataSet (const std::vector< std::string > &pnames, const std::vector< int > &ptyes, const std::map< int, te::common::CharEncoding > &encodings, int begTimePropIdx, int endTimePropIdx, int gmPropIdx)
	It constructs an empty in-memory dataset indexed by time and space. More...

	DataSet (te::da::DataSet *ds, int tpPropIdx, int gmPropIdx=-1, unsigned int limit=0)
	It constructs an in-memory observation dataset from a given data set. More...

	DataSet (te::da::DataSet *ds, int begTimePropIdx, int endTimePropIdx, int gmPropIdx, unsigned int limit)
	It constructs an in-memory observation dataset from a given data set. More...

	DataSet (const DataSet &rhs, const bool deepCopy=false)
	Regular copy constructor. More...

std::auto_ptr< DataSet >	filter (const te::gm::Envelope *e, te::gm::SpatialRelation r) const
	It returns a new DataSet, based on a given spatial filter. More...

std::auto_ptr< DataSet >	filter (const te::gm::Geometry *g, te::gm::SpatialRelation r) const
	It returns a new DataSet, based on a given spatial filter. More...

std::auto_ptr< DataSet >	filter (const te::dt::DateTime *dt, te::dt::TemporalRelation tr) const
	It returns a new DataSet, based on a given temporal filter. More...

std::auto_ptr< DataSet >	filter (const te::gm::Envelope e, te::gm::SpatialRelation r, const te::dt::DateTime dt, te::dt::TemporalRelation tr) const
	It returns a new DataSet, based on a given spatial and temporal filter. More...

std::auto_ptr< DataSet >	filter (const te::gm::Geometry g, te::gm::SpatialRelation r, const te::dt::DateTime dt, te::dt::TemporalRelation tr) const
	It returns a new DataSet, based on a given spatial filter. More...

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

const TimeToDataSetItemMap &	getData () const
	It returns a reference to the internal observation set. More...

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

int	getGeomPropIdx () const
	It returns the index of the property that contains the observed geometries. More...

std::auto_ptr< te::dt::DateTimePeriod >	getTemporalExtent () const
	It returns the temporal extent of the observations. More...

std::auto_ptr< te::stmem::DataSet >	nearestObservations (const te::dt::DateTime *time, int n) const
	It returns the n nearest observations to a given date and time. More...

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

	~DataSet ()
	Destructor. More...

DataSet inherited methods
te::common::TraverseType	getTraverseType () const
	It returns the traverse type associated to the dataset. More...

te::common::AccessPolicy	getAccessPolicy () const
	It returns the read and write permission associated to the dataset. More...

std::size_t	getNumProperties () const
	It returns the number of properties that composes an item of the dataset. More...

int	getPropertyDataType (std::size_t i) const
	It returns the underlying data type of the property at position pos. More...

std::string	getPropertyName (std::size_t i) const
	It returns the property name at position pos. More...

te::common::CharEncoding	getPropertyCharEncoding (std::size_t i) const
	It returns the property character encoding at position pos. More...

std::string	getDatasetNameOfProperty (std::size_t i) const
	It returns the underlying dataset name of the property at position pos. More...

bool	isEmpty () const
	It returns true if the collection is empty. More...

bool	isConnected () const
	It returns true if the dataset is connected and false if it is disconnected. A dataset can be connected or disconnected. A connected dataset, after its creation through the data source transactor, continues to depend on the connection given by its associated data source. Differently, a disconnected dataset, after its creation, no more depends of the connection given by the data source, and it continues to live after the connection has been released to the data source. More...

std::size_t	size () const
	It returns the collection size, if it is known. More...

std::auto_ptr< te::gm::Envelope >	getExtent (std::size_t i)
	It computes the bounding rectangle for a spatial property of the dataset. More...

bool	moveNext ()
	It moves the internal pointer to the next item of the collection. More...

bool	movePrevious ()
	It moves the internal pointer to the previous item of the collection. More...

bool	moveBeforeFirst ()
	It moves the internal pointer to a position before the first item in the collection. More...

bool	moveFirst ()
	It moves the internal pointer to the first item in the collection. More...

bool	moveLast ()
	It sets the dataset internal pointer to the last item in the collection. More...

bool	move (std::size_t i)
	It moves the dataset internal pointer to a given position. More...

bool	isAtBegin () const
	It tells if the dataset internal pointer is on the first element of the collection or not. More...

bool	isBeforeBegin () const
	It tells if the dataset internal pointer is in a position before the first element of the collection or not. More...

bool	isAtEnd () const
	It tells if the dataset internal pointer is on the last element of the collection. More...

bool	isAfterEnd () const
	It tells if the dataset internal pointer is on the sentinel position after the last element of the collection or not. More...

char	getChar (std::size_t i) const
	Method for retrieving a signed character attribute value (1 byte long). More...

unsigned char	getUChar (std::size_t i) const
	Method for retrieving an unsigned character attribute value (1 byte long). More...

boost::int16_t	getInt16 (std::size_t i) const
	Method for retrieving a 16-bit integer attribute value (2 bytes long). More...

boost::int32_t	getInt32 (std::size_t i) const
	Method for retrieving a 32-bit integer attribute value (4 bytes long). More...

boost::int64_t	getInt64 (std::size_t i) const
	Method for retrieving a 64-bit integer attribute value (8 bytes long). More...

bool	getBool (std::size_t i) const
	Method for retrieving a boolean attribute value. More...

float	getFloat (std::size_t i) const
	Method for retrieving a float attribute value. More...

double	getDouble (std::size_t i) const
	Method for retrieving a double attribute value. More...

std::string	getNumeric (std::size_t i) const
	Method for retrieving a numeric attribute value. More...

std::string	getString (std::size_t i) const
	Method for retrieving a string value attribute. More...

std::auto_ptr< te::dt::ByteArray >	getByteArray (std::size_t i) const
	Method for retrieving a byte array. More...

std::auto_ptr< te::gm::Geometry >	getGeometry (std::size_t i) const
	Method for retrieving a geometric attribute value. More...

std::auto_ptr< te::rst::Raster >	getRaster (std::size_t i) const
	Method for retrieving a raster attribute value. More...

std::auto_ptr< te::dt::DateTime >	getDateTime (std::size_t i) const
	Method for retrieving a date and time attribute value. More...

std::auto_ptr< te::dt::Array >	getArray (std::size_t i) const
	Method for retrieving an array. More...

bool	isNull (std::size_t i) const
	It checks if the attribute value is NULL. More...

std::auto_ptr< te::dt::AbstractData >	getValue (std::size_t i) const
	Method for retrieving any other type of data value stored in the data source. More...

Methods to set values to the DataSet
Note These methods will take the ownership of the given pointers.
void	setChar (std::size_t i, char value)

void	setChar (const std::string &name, char value)

void	setUChar (std::size_t i, unsigned char value)

void	setUChar (const std::string &name, unsigned char value)

void	setInt16 (std::size_t i, boost::int16_t value)

void	setInt16 (const std::string &name, boost::int16_t value)

void	setInt32 (std::size_t i, boost::int32_t value)

void	setInt32 (const std::string &name, boost::int32_t value)

void	setInt64 (std::size_t i, boost::int64_t value)

void	setInt64 (const std::string &name, boost::int64_t value)

void	setBool (std::size_t i, bool value)

void	setBool (const std::string &name, bool value)

void	setFloat (std::size_t i, float value)

void	setFloat (const std::string &name, float value)

void	setDouble (std::size_t i, double value)

void	setDouble (const std::string &name, double value)

void	setNumeric (std::size_t i, const std::string &value)

void	setNumeric (const std::string &name, const std::string &value)

void	setString (std::size_t i, const std::string &value)

void	setString (const std::string &name, const std::string &value)

void	setByteArray (std::size_t i, te::dt::ByteArray *value)

void	setByteArray (const std::string &name, te::dt::ByteArray *value)

void	setGeometry (std::size_t i, te::gm::Geometry *value)

void	setGeometry (const std::string &name, te::gm::Geometry *value)

void	setRaster (std::size_t i, te::rst::Raster *value)

void	setRaster (const std::string &name, te::rst::Raster *value)

void	setDateTime (std::size_t i, te::dt::DateTime *value)

void	setDateTime (const std::string &name, te::dt::DateTime *value)

void	setValue (std::size_t i, te::dt::AbstractData *value)

void	setValue (const std::string &name, te::dt::AbstractData *ad)

DataSet Element Properties
Methods for retrieving/setting the dataset item component values without the need to explicitly instantiate an item via getItem method.
virtual char	getChar (const std::string &name) const
	Method for retrieving a signed character attribute value (1 byte long). More...

virtual unsigned char	getUChar (const std::string &name) const
	Method for retrieving an unsigned character attribute value (1 byte long). More...

virtual boost::int16_t	getInt16 (const std::string &name) const
	Method for retrieving a 16-bit integer attribute value (2 bytes long). More...

virtual boost::int32_t	getInt32 (const std::string &name) const
	Method for retrieving a 32-bit integer attribute value (4 bytes long). More...

virtual boost::int64_t	getInt64 (const std::string &name) const
	Method for retrieving a 64-bit integer attribute value (8 bytes long). More...

virtual bool	getBool (const std::string &name) const
	Method for retrieving a boolean attribute value. More...

virtual float	getFloat (const std::string &name) const
	Method for retrieving a float attribute value. More...

virtual double	getDouble (const std::string &name) const
	Method for retrieving a double attribute value. More...

virtual std::string	getNumeric (const std::string &name) const
	Method for retrieving a numeric attribute value. More...

virtual std::string	getString (const std::string &name) const
	Method for retrieving a string attribute value. More...

virtual std::auto_ptr< te::dt::ByteArray >	getByteArray (const std::string &name) const
	Method for retrieving a byte array. More...

virtual std::auto_ptr< te::gm::Geometry >	getGeometry (const std::string &name) const
	Method for retrieving a geometric attribute value. More...

virtual std::auto_ptr< te::rst::Raster >	getRaster (const std::string &name) const
	Method for retrieving a raster attribute value. More...

virtual std::auto_ptr< te::dt::DateTime >	getDateTime (const std::string &name) const
	Method for retrieving a date and time attribute value. More...

virtual std::auto_ptr< te::dt::Array >	getArray (const std::string &name) const
	Method for retrieving an array. More...

virtual std::auto_ptr< te::dt::AbstractData >	getValue (const std::string &name) const
	Method for retrieving any other type of data value stored in the data source. More...

virtual std::string	getAsString (std::size_t i, int precision=0) const
	Method for retrieving a data value as a string plain representation. More...

virtual std::string	getAsString (const std::string &name, int precision=0) const
	Method for retrieving a data value as a string plain representation. More...

virtual bool	isNull (const std::string &name) const
	It checks if the attribute value is NULL. More...

Protected Attributes
bool	m_beforeFirst

int	m_begTimePropIdx
	The property index of the DataSetType that contains the phenomenon beginning time. More...

std::map< int, te::common::CharEncoding >	m_encodings
	The list of string properties char-encoding. More...

int	m_endTimePropIdx
	The property index of the DataSetType that contains the phenomenon end time. More...

int	m_geomPropIdx
	The property index of the DataSetType that contains geometries. More...

TimeToDataSetItemMap	m_items
	The list of dataset items, ordered by time. More...

TimeToDataSetItemMap::const_iterator	m_iterator
	The pointer to the current item. More...

std::vector< std::string >	m_pnames
	internal control More...

std::vector< int >	m_ptypes
	The list of property types. More...

std::auto_ptr< te::sam::rtree::Index< te::mem::DataSetItem * > >	m_RTree
	A RTree index created over the default geometry property. More...

Detailed Description

Implementation of a in-memory data set that contains spatiotemporal observations indexed by time and space.

See also: te::da::DataSet

Definition at line 61 of file DataSet.h.

Constructor & Destructor Documentation

te::stmem::DataSet::DataSet	(	const te::da::DataSetType *	type,
		int	tpPropIdx
	)

It constructs an empty in-memory dataset indexed by time and space.

Parameters

dt	the schema of the in-memory observation DataSet that will be created.
tpPropIdx	the property index of the DataSetType "dt" that contains the observation phenomenon time.
gmPropIdx	the property index of the DataSetType "dt" that contains geometries.

Note: DataSet will NOT take the ownership of the given pointer.

te::stmem::DataSet::DataSet	(	const te::da::DataSetType *	type,
		int	tpPropIdx,
		int	gmPropIdx
	)

It constructs an empty in-memory dataset indexed by time and space.

Parameters

dt	the schema of the in-memory observation DataSet that will be created.
tpPropIdx	the property index of the DataSetType "dt" that contains the observation phenomenon time.
gmPropIdx	the property index of the DataSetType "dt" that contains geometries.

Note: DataSet will NOT take the ownership of the given pointer.

te::stmem::DataSet::DataSet	(	const te::da::DataSetType *	type,
		int	begTimePropIdx,
		int	endTimePropIdx,
		int	gmPropIdx
	)

It constructs an empty in-memory dataset indexed by time and space.

Parameters

dt	the schema of the in-memory observation DataSet that will be created.
begTimePropIdx	the property index of the DataSetType "dt" that contains the observation phenomenon beginning time.
endTimePropIdx	the property index of the DataSetType "dt" that contains the observation phenomenon end time.
gmPropIdx	the property index of the DataSetType "dt" that contains geometries.

Note: DataSet will NOT take the ownership of the given pointer.

te::stmem::DataSet::DataSet	(	const std::vector< std::string > &	pnames,
		const std::vector< int > &	ptyes,
		const std::map< int, te::common::CharEncoding > &	encodings,
		int	begTimePropIdx,
		int	endTimePropIdx,
		int	gmPropIdx
	)

It constructs an empty in-memory dataset indexed by time and space.

Parameters

pnames	The names of the properties.
ptypes	The types of the properties.
begTimePropIdx	The property index of the ptypes vector that contains the observation phenomenon beginning time.
endTimePropIdx	The property index of the ptypes vector that contains the observation phenomenon end time.
gmPropIdx	The property index of the ptypes vector that contains geometries.

te::stmem::DataSet::DataSet	(	te::da::DataSet *	ds,
		int	tpPropIdx,
		int	gmPropIdx = `-1`,
		unsigned int	limit = `0`
	)

It constructs an in-memory observation dataset from a given data set.

It creates a new in-memory observation dataset with the items from the given dataset.

Parameters

ds	the dataset which will provide the observations.
tpPropIdx	the property index of the DataSet "ds" that contains the observation phenomenon time
gmPropIdx	the property index of the DataSet "ds" that contains geometries
limit	The number of items to be copied. Use 0 to copy all items.

Precondition: You must assure that ds is a valid item to be read.; You must assure that ds has a valid type associated to it, that is, getType() is valid.

Note: This constructor will use the method "moveNext()" of the source dataset (ds) in order to read its items. It will start reading the given dataset in the current position. So, the caller is responsible for informing the dataset in the right position to start processing it.; DataSet will NOT take the ownership of the given ds pointer.; The new dataset will not have a transactor associated to it.

te::stmem::DataSet::DataSet	(	te::da::DataSet *	ds,
		int	begTimePropIdx,
		int	endTimePropIdx,
		int	gmPropIdx,
		unsigned int	limit
	)

It constructs an in-memory observation dataset from a given data set.

It creates a new in-memory observation dataset with the items from the given dataset.

Parameters

ds	the dataset which will provide the observations.
begTimePropIdx	the property index of the DataSetType "dt" that contains the observation phenomenon beginning time.
endTimePropIdx	the property index of the DataSetType "dt" that contains the observation phenomenon end time.
gmPropIdx	the property index of the DataSet "ds" that contains geometries
limit	The number of items to be copied. Use 0 to copy all items.

Precondition: You must assure that ds is in a valid item to be read.; You must assure that ds has a valid type associated to it, that is, getType() is valid.

Note: This constructor will use the method "moveNext()" of the source dataset (ds) in order to read its items. It will start reading the given dataset in the current position. So, the caller is responsible for informing the dataset in the right position to start processing it.; DataSet will NOT take the ownership of the given ds pointer.; The new dataset will not have a transactor associated to it.

te::stmem::DataSet::DataSet	(	const DataSet &	rhs,
		const bool	deepCopy = `false`
	)

Regular copy constructor.

It creates a new in-memory observation dataset with the items from the rhs dataset.

Parameters

rhs	The dataset which will provide the items.
deepCopy	If true the new dataset instance will clone all dataset items from the source dataset (rhs), otherwise it will share all items.

Precondition: You must assure that rhs is in a valid item to be read.; You must assure that rhs has a valid type associated to it, that is, getType() is valid.

Note: This constructor will copy all items from the given DataSet rhs, independently on its current position.

te::stmem::DataSet::~DataSet ( )

virtual

Destructor.

Reimplemented from te::da::DataSet.

Member Function Documentation

void te::stmem::DataSet::add ( const std::pair< te::dt::DateTime *, DateSetItemShrPtr > & item )

It adds an existing item to the dataset.

This method must be used when the user wants to share the same item among DataSets. After adding the item, it updates the internal RTree.

Parameters

item	An existing item coming from another DataSet.

Precondition: The item schema must be compatible with the dataset items.

Note: The first element of the pair (DateTime*) will be cloned.; It will not take the ownership of the first element of the given pair.

void te::stmem::DataSet::add ( te::mem::DataSetItem * item )

It adds a new item to the dataset and takes its ownership.

Parameters

item	The item to be added to the dataset.

Precondition: The item schema must be compatible with the dataset items.

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

std::auto_ptr<DataSet> te::stmem::DataSet::clone ( ) const

It returns a clone of the DataSet.

Returns: a clone of the DataSet

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

void te::stmem::DataSet::copy	(	te::da::DataSet *	src,
		unsigned int	limit = `0`
	)

It copies up to limit items from the source dataset.

Parameters

src	The source dataset with the items that will be copied.
limit	The number of items to be copied. Use 0 to copy all items.

Precondition: The internal DataSetType and ObservationSetType must be already created and valid.; The internal DataSetType must be equal to the given DataSet src

Note: This method will call moveNext() for the source dataset in order to read its items. It will start reading the given dataset in the current position. So, the caller is responsible for informing the dataset in the right position to start processing it.

void te::stmem::DataSet::copy	(	te::da::DataSet *	src,
		const std::vector< std::size_t > &	properties,
		unsigned int	limit = `0`
	)

It copies up to limit items from the source dataset (src).

Parameters

src	The source dataset with the items that will be copied.
properties	The list of properties which will be considered in the copy.
limit	The number of items to be copied. Use 0 to copy all items.

Precondition: The properties in the property vector must come from the source dataset (src) schema. In other words, they must be valid pointers in the src dataset type.; The internal DataSetType must be already created, using the given properties.

Note: This method will call moveNext() for the source dataset in order to read its items. It will start reading the given dataset in the current position. So, the caller is responsible for informing the dataset in the right position to start processing it.

std::auto_ptr<DataSet> te::stmem::DataSet::filter	(	const te::gm::Envelope *	e,
		te::gm::SpatialRelation	r
	)		const

It returns a new DataSet, based on a given spatial filter.

Parameters

e	A given envelope
r	A given spatial relation.

Returns: a new DataSet

Note: For while, it only works if the spatial relation is te::gm::INTERSECTS; The caller will take the ownership of the returned pointer.; The returned DataSet will NOT share the intenal observations. It will clone the internal observations.

std::auto_ptr<DataSet> te::stmem::DataSet::filter	(	const te::gm::Geometry *	g,
		te::gm::SpatialRelation	r
	)		const

It returns a new DataSet, based on a given spatial filter.

Parameters

g	A given geometry
r	A given spatial relation.

Returns: a new DataSet

Note: For while, it only works if the spatial relation is te::gm::INTERSECTS; The caller will take the ownership of the returned pointer.; The returned DataSet will NOT share the intenal observations. It will clone the internal observations.

std::auto_ptr<DataSet> te::stmem::DataSet::filter	(	const te::dt::DateTime *	dt,
		te::dt::TemporalRelation	tr
	)		const

It returns a new DataSet, based on a given temporal filter.

Parameters

dt	A given date time
tr	A given temporal relation.

Returns: a new DataSet

Note: The caller will take the ownership of the returned pointer.; The new DataSet will share the intenal observations.

std::auto_ptr<DataSet> te::stmem::DataSet::filter	(	const te::gm::Envelope *	e,
		te::gm::SpatialRelation	r,
		const te::dt::DateTime *	dt,
		te::dt::TemporalRelation	tr
	)		const

It returns a new DataSet, based on a given spatial and temporal filter.

Parameters

e	A given envelope
r	A given spatial relation.
dt	A given date time
tr	A given temporal relation.

Returns: a new DataSet

Note: The caller will take the ownership of the returned pointer.; The returned DataSet will NOT share the intenal observations. It will clone the internal observations.

std::auto_ptr<DataSet> te::stmem::DataSet::filter	(	const te::gm::Geometry *	g,
		te::gm::SpatialRelation	r,
		const te::dt::DateTime *	dt,
		te::dt::TemporalRelation	tr
	)		const

It returns a new DataSet, based on a given spatial filter.

Parameters

g	A given geometry
r	A given spatial relation.
dt	A given date time
tr	A given temporal relation.

Returns: a new DataSet

Note: The caller will take the ownership of the returned pointer.; The returned DataSet will NOT share the intenal observations. It will clone the internal observations.

te::common::AccessPolicy te::stmem::DataSet::getAccessPolicy ( ) const

virtual

It returns the read and write permission associated to the dataset.

Returns: The read and write permission associated to the dataset.

Implements te::da::DataSet.

std::auto_ptr<te::dt::Array> te::stmem::DataSet::getArray ( std::size_t i ) const

virtual

Method for retrieving an array.

Parameters

i	The attribute index.

Implements te::da::DataSet.

virtual std::auto_ptr<te::dt::Array> te::da::DataSet::getArray ( const std::string & name ) const

virtualinherited

Method for retrieving an array.

Parameters

name	The attribute name.

Returns: An array. The caller will take its ownership.

Reimplemented in te::gdal::DataSet.

virtual std::string te::da::DataSet::getAsString	(	std::size_t	i,
		int	precision = `0`
	)		const

virtualinherited

Method for retrieving a data value as a string plain representation.

Parameters

i	The attribute index.
precision	The precision in the conversion.

Returns: The attribute value in a string format.

Note: It is safe to call this method for any data type, the data source implementation will take care of how to convert the internal representation to a string.

virtual std::string te::da::DataSet::getAsString	(	const std::string &	name,
		int	precision = `0`
	)		const

virtualinherited

Method for retrieving a data value as a string plain representation.

Parameters

name	The attribute name.
precision	The precision in the conversion.

Returns: The attribute value in a string format.

Note: It is safe to call this method for any data type, the data source implementation will take care of how to convert the internal representation to a string.

int te::stmem::DataSet::getBeginTimePropIdx ( ) const

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

Returns: An index of the property that conatins the beginning phenomenon time.

bool te::stmem::DataSet::getBool ( std::size_t i ) const

virtual

Method for retrieving a boolean attribute value.

Parameters

i	The attribute index.

Returns: The boolean attribute value in the given position.

Implements te::da::DataSet.

virtual bool te::da::DataSet::getBool ( const std::string & name ) const

virtualinherited

Method for retrieving a boolean attribute value.

Parameters

name	The attribute name.

Returns: The boolean attribute value with the given name.

Reimplemented in te::gdal::DataSet.

std::auto_ptr<te::dt::ByteArray> te::stmem::DataSet::getByteArray ( std::size_t i ) const

virtual

Method for retrieving a byte array.

You can use this method in order to retrieve a BLOB data.

Parameters

i	The attribute index.

Returns: The byte array attribute.

Implements te::da::DataSet.

virtual std::auto_ptr<te::dt::ByteArray> te::da::DataSet::getByteArray ( const std::string & name ) const

virtualinherited

Method for retrieving a byte array.

You can use this method in order to retrieve a BLOB data.

Parameters

name	The attribute name.

Returns: The byte array attribute.

Reimplemented in te::gdal::DataSet.

virtual char te::da::DataSet::getChar ( const std::string & name ) const

virtualinherited

Method for retrieving a signed character attribute value (1 byte long).

Parameters

name	The attribute name.

Returns: The signed character attribute value (1 byte long) with the given name.

Reimplemented in te::gdal::DataSet.

char te::stmem::DataSet::getChar ( std::size_t i ) const

virtual

Method for retrieving a signed character attribute value (1 byte long).

Parameters

i	The attribute index.

Returns: The signed character attribute value (1 byte long) in the given position.

Implements te::da::DataSet.

const TimeToDataSetItemMap& te::stmem::DataSet::getData ( ) const

It returns a reference to the internal observation set.

Returns: A reference to the internal observation set.

std::string te::stmem::DataSet::getDatasetNameOfProperty ( std::size_t i ) const

virtual

It returns the underlying dataset name of the property at position pos.

Parameters

i	The property position of interest.

Returns: The underlying dataset name of the property at position pos.

Implements te::da::DataSet.

std::auto_ptr<te::dt::DateTime> te::stmem::DataSet::getDateTime ( std::size_t i ) const

virtual

Method for retrieving a date and time attribute value.

Parameters

i	The attribute index.

Returns: The date and time attribute value in the given position.

Implements te::da::DataSet.

virtual std::auto_ptr<te::dt::DateTime> te::da::DataSet::getDateTime ( const std::string & name ) const

virtualinherited

Method for retrieving a date and time attribute value.

Parameters

name	The attribute name.

Returns: The date and time attribute value with the given name.

Reimplemented in te::gdal::DataSet.

double te::stmem::DataSet::getDouble ( std::size_t i ) const

virtual

Method for retrieving a double attribute value.

Parameters

i	The attribute index.

Returns: The double attribute value in the given position.

Implements te::da::DataSet.

virtual double te::da::DataSet::getDouble ( const std::string & name ) const

virtualinherited

Method for retrieving a double attribute value.

Parameters

name	The attribute name.

Returns: The double attribute value with the given name.

Reimplemented in te::gdal::DataSet.

int te::stmem::DataSet::getEndTimePropIdx ( ) const

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

Returns: An index of the property that conatins the end phenomenon time.

std::auto_ptr<te::gm::Envelope> te::stmem::DataSet::getExtent ( std::size_t i )

virtual

It computes the bounding rectangle for a spatial property of the dataset.

Parameters

i	The position of a spatial property to get its bounding box.

Precondition: The position i must be associated to a spatial property of the dataset.

Exceptions

Exception It throws an exception if something goes wrong during MBR search.

Returns: The spatial property bounding rectangle, or an invalid box, if none is found.

Implements te::da::DataSet.

float te::stmem::DataSet::getFloat ( std::size_t i ) const

virtual

Method for retrieving a float attribute value.

Parameters

i	The attribute index.

Returns: The float attribute value in the given position.

Implements te::da::DataSet.

virtual float te::da::DataSet::getFloat ( const std::string & name ) const

virtualinherited

Method for retrieving a float attribute value.

Parameters

name	The attribute name.

Returns: The float attribute value with the given name.

Reimplemented in te::gdal::DataSet.

std::auto_ptr<te::gm::Geometry> te::stmem::DataSet::getGeometry ( std::size_t i ) const

virtual

Method for retrieving a geometric attribute value.

Parameters

i	The attribute index.

Returns: The geometric attribute value in the given position.

Implements te::da::DataSet.

virtual std::auto_ptr<te::gm::Geometry> te::da::DataSet::getGeometry ( const std::string & name ) const

virtualinherited

Method for retrieving a geometric attribute value.

Parameters

name	The attribute name.

Returns: The geometric attribute value with the given name.

Reimplemented in te::gdal::DataSet.

int te::stmem::DataSet::getGeomPropIdx ( ) const

It returns the index of the property that contains the observed geometries.

Returns: An index of the property that conatins the observed geometries.

virtual boost::int16_t te::da::DataSet::getInt16 ( const std::string & name ) const

virtualinherited

Method for retrieving a 16-bit integer attribute value (2 bytes long).

Parameters

name	The attribute name.

Returns: The 16-bit integer attribute value (2 bytes long) with the given name.

Reimplemented in te::gdal::DataSet.

boost::int16_t te::stmem::DataSet::getInt16 ( std::size_t i ) const

virtual

Method for retrieving a 16-bit integer attribute value (2 bytes long).

Parameters

i	The attribute index.

Returns: The 16-bit integer attribute value (2 bytes long) in the given position.

Implements te::da::DataSet.

virtual boost::int32_t te::da::DataSet::getInt32 ( const std::string & name ) const

virtualinherited

Method for retrieving a 32-bit integer attribute value (4 bytes long).

Parameters

name	The attribute name.

Returns: The 32-bit integer attribute value with the given name.

Reimplemented in te::gdal::DataSet.

boost::int32_t te::stmem::DataSet::getInt32 ( std::size_t i ) const

virtual

Method for retrieving a 32-bit integer attribute value (4 bytes long).

Parameters

i	The attribute index.

Returns: The 32-bit integer attribute value in the given position.

Implements te::da::DataSet.

virtual boost::int64_t te::da::DataSet::getInt64 ( const std::string & name ) const

virtualinherited

Method for retrieving a 64-bit integer attribute value (8 bytes long).

Parameters

name	The attribute name.

Returns: The 64-bit integer attribute value with the given name.

Reimplemented in te::gdal::DataSet.

boost::int64_t te::stmem::DataSet::getInt64 ( std::size_t i ) const

virtual

Method for retrieving a 64-bit integer attribute value (8 bytes long).

Parameters

i	The attribute index.

Returns: The 64-bit integer attribute value in the given position.

Implements te::da::DataSet.

std::string te::stmem::DataSet::getNumeric ( std::size_t i ) const

virtual

Method for retrieving a numeric attribute value.

Parameters

i	The attribute index.

Returns: The numeric attribute value in the given position.

Implements te::da::DataSet.

virtual std::string te::da::DataSet::getNumeric ( const std::string & name ) const

virtualinherited

Method for retrieving a numeric attribute value.

Parameters

name	The attribute name.

Returns: The numeric attribute value with the given name.

Reimplemented in te::gdal::DataSet.

std::size_t te::stmem::DataSet::getNumProperties ( ) const

virtual

It returns the number of properties that composes an item of the dataset.

Returns: The number of properties that composes an item of the dataset.

Implements te::da::DataSet.

te::common::CharEncoding te::stmem::DataSet::getPropertyCharEncoding ( std::size_t i ) const

virtual

It returns the property character encoding at position pos.

Parameters

i	The property the position of interest.

Returns: The property character encoding.

Note: The property at position pos must be a textual property.

Exceptions

Exception It throws an exception if the property at position pos is not a textual property.

Implements te::da::DataSet.

int te::stmem::DataSet::getPropertyDataType ( std::size_t i ) const

virtual

It returns the underlying data type of the property at position pos.

Parameters

i	The property position of interest.

Returns: The underlying data type of the property at position pos.

Implements te::da::DataSet.

std::string te::stmem::DataSet::getPropertyName ( std::size_t i ) const

virtual

It returns the property name at position pos.

Parameters

i	The property name at the position of interest.

Returns: The property name at position pos.

Implements te::da::DataSet.

std::auto_ptr<te::rst::Raster> te::stmem::DataSet::getRaster ( std::size_t i ) const

virtual

Method for retrieving a raster attribute value.

Parameters

i	The attribute index.

Returns: The raster attribute value in the given position.

Exceptions

Exception

It can throw an exception if:

something goes wrong during the data retrieval
the maximum number of simultaneous accesses has been reached

Implements te::da::DataSet.

virtual std::auto_ptr<te::rst::Raster> te::da::DataSet::getRaster ( const std::string & name ) const

virtualinherited

Method for retrieving a raster attribute value.

Parameters

name	The attribute name.

Returns: The raster attribute value with the given name.

Exceptions

Exception

It can throw an exception if:

something goes wrong during the data retrieval
the maximum number of simultaneous accesses has been reached

Reimplemented in te::gdal::DataSet.

std::string te::stmem::DataSet::getString ( std::size_t i ) const

virtual

Method for retrieving a string value attribute.

Parameters

i	The attribute index.

Returns: The string attribute value in the given position.

Implements te::da::DataSet.

virtual std::string te::da::DataSet::getString ( const std::string & name ) const

virtualinherited

Method for retrieving a string attribute value.

Parameters

name	The attribute name.

Returns: The string attribute value with the given name.

Reimplemented in te::gdal::DataSet.

std::auto_ptr<te::dt::DateTimePeriod> te::stmem::DataSet::getTemporalExtent ( ) const

It returns the temporal extent of the observations.

Returns: The temporal extent of the observations.

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

te::common::TraverseType te::stmem::DataSet::getTraverseType ( ) const

virtual

It returns the traverse type associated to the dataset.

Returns: The traverse type associated to the dataset.

Implements te::da::DataSet.

virtual unsigned char te::da::DataSet::getUChar ( const std::string & name ) const

virtualinherited

Method for retrieving an unsigned character attribute value (1 byte long).

Parameters

name	The attribute name.

Returns: The unsigned character attribute value (1 byte long) with the given name.

Reimplemented in te::gdal::DataSet.

unsigned char te::stmem::DataSet::getUChar ( std::size_t i ) const

virtual

Method for retrieving an unsigned character attribute value (1 byte long).

Parameters

i	The attribute index.

Returns: The unsigned character attribute value (1 byte long) in the given position.

Implements te::da::DataSet.

std::auto_ptr<te::dt::AbstractData> te::stmem::DataSet::getValue ( std::size_t i ) const

virtual

Method for retrieving any other type of data value stored in the data source.

This method can be use for extensible datatypes.

Parameters

i	The attribute index.

Returns: A pointer to the data value.

Reimplemented from te::da::DataSet.

virtual std::auto_ptr<te::dt::AbstractData> te::da::DataSet::getValue ( const std::string & name ) const

virtualinherited

Method for retrieving any other type of data value stored in the data source.

This method can be use for extensible datatypes.

Parameters

name	The attribute name.

Returns: A pointer to the data value.

Reimplemented in te::gdal::DataSet.

bool te::stmem::DataSet::isAfterEnd ( ) const

virtual

It tells if the dataset internal pointer is on the sentinel position after the last element of the collection or not.

Returns: True, if the dataset internal pointer is on the sentinel position after the last element otherwise it returns false.

Implements te::da::DataSet.

bool te::stmem::DataSet::isAtBegin ( ) const

virtual

It tells if the dataset internal pointer is on the first element of the collection or not.

Returns: True if the dataset internal pointer is on the first element otherwise it returns false.

Implements te::da::DataSet.

bool te::stmem::DataSet::isAtEnd ( ) const

virtual

It tells if the dataset internal pointer is on the last element of the collection.

Returns: True, if the dataset internal pointer is on the last element otherwise it returns false.

Implements te::da::DataSet.

bool te::stmem::DataSet::isBeforeBegin ( ) const

virtual

It tells if the dataset internal pointer is in a position before the first element of the collection or not.

Returns: True, if the dataset internal pointer is in a position before the first element otherwise it returns false.

Implements te::da::DataSet.

bool te::stmem::DataSet::isConnected ( ) const

virtual

It returns true if the dataset is connected and false if it is disconnected. A dataset can be connected or disconnected. A connected dataset, after its creation through the data source transactor, continues to depend on the connection given by its associated data source. Differently, a disconnected dataset, after its creation, no more depends of the connection given by the data source, and it continues to live after the connection has been released to the data source.

Returns: True, if the dataset is connected, or false if it is disconnected.

Implements te::da::DataSet.

bool te::stmem::DataSet::isEmpty ( ) const

virtual

It returns true if the collection is empty.

Returns: True, if the collection is empty.

Implements te::da::DataSet.

bool te::stmem::DataSet::isNull ( std::size_t i ) const

virtual

It checks if the attribute value is NULL.

Parameters

i	The attribute index.

Returns: True if the attribute value is NULL.

Implements te::da::DataSet.

virtual bool te::da::DataSet::isNull ( const std::string & name ) const

virtualinherited

It checks if the attribute value is NULL.

Parameters

name	The attribute name.

Returns: True if the attribute value is NULL.

Reimplemented in te::gdal::DataSet.

bool te::stmem::DataSet::move ( std::size_t i )

virtual

It moves the dataset internal pointer to a given position.

Parameters

i	The position the dataset internal pointer must be set up.

Returns: True, if it was possible to move the dataset reading to the given position.

Note: The first item in the collection starts at address 0.

Implements te::da::DataSet.

bool te::stmem::DataSet::moveBeforeFirst ( )

virtual

It moves the internal pointer to a position before the first item in the collection.

Returns: True, if it was possible to move to a sentinel position before the first item in the collection.

Note: This method is not supported by FORWARDONLY datasets.

Implements te::da::DataSet.

bool te::stmem::DataSet::moveFirst ( )

virtual

It moves the internal pointer to the first item in the collection.

Returns: True, if it was possible to move to the first item in the collection.

Note: This method is not supported by FORWARDONLY datasets.

Implements te::da::DataSet.

bool te::stmem::DataSet::moveLast ( )

virtual

It sets the dataset internal pointer to the last item in the collection.

Returns: True, if it was possible to move to the last item in the collection.

Implements te::da::DataSet.

bool te::stmem::DataSet::moveNext ( )

virtual

It moves the internal pointer to the next item of the collection.

You always has to call this method in order to move the internal pointer to the first item in the collection. This method can be used to traverse a dataset.

Returns: True if the internal pointer is on a valid item, or false otherwise.

Note: All dataset types support this method: FORWARDONLY, BIDIRECTIONAL and RANDOM.

Implements te::da::DataSet.

bool te::stmem::DataSet::movePrevious ( )

virtual

It moves the internal pointer to the previous item of the collection.

Returns: True, if the internal pointer (cursor position) is on a valid item, or false otherwise.

Note: This method is not supported by FORWARDONLY datasets.

Implements te::da::DataSet.

std::auto_ptr<te::stmem::DataSet> te::stmem::DataSet::nearestObservations	(	const te::dt::DateTime *	time,
		int	n
	)		const

It returns the n nearest observations to a given date and time.

Parameters

dt	A given date time
n	The number of returned observations.

Returns: a new DataSet

Note: The caller will take the ownership of the returned pointer.; The returned DataSet will share the intenal observations.

DataSet& te::stmem::DataSet::operator= ( const DataSet & rhs )

Assignment operator.

Note: The left-side DataSet will share all observations or items of the right-side DataSet.; If the caller does not want to share the items, it must use the method clone.

void te::stmem::DataSet::setBool	(	std::size_t	i,
		bool	value
	)

void te::stmem::DataSet::setBool	(	const std::string &	name,
		bool	value
	)

void te::stmem::DataSet::setByteArray	(	std::size_t	i,
		te::dt::ByteArray *	value
	)

void te::stmem::DataSet::setByteArray	(	const std::string &	name,
		te::dt::ByteArray *	value
	)

void te::stmem::DataSet::setChar	(	std::size_t	i,
		char	value
	)

void te::stmem::DataSet::setChar	(	const std::string &	name,
		char	value
	)

void te::stmem::DataSet::setDateTime	(	std::size_t	i,
		te::dt::DateTime *	value
	)

void te::stmem::DataSet::setDateTime	(	const std::string &	name,
		te::dt::DateTime *	value
	)

void te::stmem::DataSet::setDouble	(	std::size_t	i,
		double	value
	)

void te::stmem::DataSet::setDouble	(	const std::string &	name,
		double	value
	)

void te::stmem::DataSet::setFloat	(	std::size_t	i,
		float	value
	)

void te::stmem::DataSet::setFloat	(	const std::string &	name,
		float	value
	)

void te::stmem::DataSet::setGeometry	(	std::size_t	i,
		te::gm::Geometry *	value
	)

void te::stmem::DataSet::setGeometry	(	const std::string &	name,
		te::gm::Geometry *	value
	)

void te::stmem::DataSet::setInt16	(	std::size_t	i,
		boost::int16_t	value
	)

void te::stmem::DataSet::setInt16	(	const std::string &	name,
		boost::int16_t	value
	)

void te::stmem::DataSet::setInt32	(	std::size_t	i,
		boost::int32_t	value
	)

void te::stmem::DataSet::setInt32	(	const std::string &	name,
		boost::int32_t	value
	)

void te::stmem::DataSet::setInt64	(	std::size_t	i,
		boost::int64_t	value
	)

void te::stmem::DataSet::setInt64	(	const std::string &	name,
		boost::int64_t	value
	)

void te::stmem::DataSet::setNumeric	(	std::size_t	i,
		const std::string &	value
	)

void te::stmem::DataSet::setNumeric	(	const std::string &	name,
		const std::string &	value
	)

void te::stmem::DataSet::setRaster	(	std::size_t	i,
		te::rst::Raster *	value
	)

void te::stmem::DataSet::setRaster	(	const std::string &	name,
		te::rst::Raster *	value
	)

void te::stmem::DataSet::setString	(	std::size_t	i,
		const std::string &	value
	)

void te::stmem::DataSet::setString	(	const std::string &	name,
		const std::string &	value
	)

void te::stmem::DataSet::setUChar	(	std::size_t	i,
		unsigned char	value
	)

void te::stmem::DataSet::setUChar	(	const std::string &	name,
		unsigned char	value
	)

void te::stmem::DataSet::setValue	(	std::size_t	i,
		te::dt::AbstractData *	value
	)

void te::stmem::DataSet::setValue	(	const std::string &	name,
		te::dt::AbstractData *	ad
	)

std::size_t te::stmem::DataSet::size ( ) const

virtual

It returns the collection size, if it is known.

It may return std::string::npos if the size is not known, or it would be too costly to compute it.

Returns: The size of the collection, if it is known.

Implements te::da::DataSet.

Member Data Documentation

bool te::stmem::DataSet::m_beforeFirst

protected

Definition at line 530 of file DataSet.h.

int te::stmem::DataSet::m_begTimePropIdx

protected

The property index of the DataSetType that contains the phenomenon beginning time.

Definition at line 534 of file DataSet.h.

std::map<int, te::common::CharEncoding> te::stmem::DataSet::m_encodings

protected

The list of string properties char-encoding.

Definition at line 533 of file DataSet.h.

int te::stmem::DataSet::m_endTimePropIdx

protected

The property index of the DataSetType that contains the phenomenon end time.

Definition at line 535 of file DataSet.h.

int te::stmem::DataSet::m_geomPropIdx

protected

The property index of the DataSetType that contains geometries.

Definition at line 536 of file DataSet.h.

TimeToDataSetItemMap te::stmem::DataSet::m_items

protected

The list of dataset items, ordered by time.

Definition at line 527 of file DataSet.h.

TimeToDataSetItemMap::const_iterator te::stmem::DataSet::m_iterator

protected

The pointer to the current item.

Definition at line 529 of file DataSet.h.

std::vector<std::string> te::stmem::DataSet::m_pnames

protected

internal control

The list of property names.

Definition at line 531 of file DataSet.h.

std::vector<int> te::stmem::DataSet::m_ptypes

protected

The list of property types.

Definition at line 532 of file DataSet.h.

std::auto_ptr<te::sam::rtree::Index<te::mem::DataSetItem*> > te::stmem::DataSet::m_RTree

protected

A RTree index created over the default geometry property.

Definition at line 528 of file DataSet.h.

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

/home/castejon/castejon_files/develop/terralib5/git_master/terralib5/src/terralib/stmemory/DataSet.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation