Implementation of a random-access dataset class for the TerraLib In-Memory Data Access driver. More...

#include <DataSet.h>

Inheritance diagram for te::mem::DataSet:

Public Member Functions
void	add (DataSetItem *item)
	It adds a new item to the dataset and takes its ownership. More...

void	add (const std::string &propertyName, std::size_t propertyType, const te::dt::AbstractData *defaultValue=0)
	It adds a new property to the dataset schema and fills this new property with a default value. More...

void	clear ()
	It clears all the dataset items. More...

void	copy (te::da::DataSet &src, std::size_t 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, std::size_t limit=0)
	It copies up to limit items from the source dataset (src). More...

	DataSet (const te::da::DataSetType *const dt)
	It constructs an empty dataset having the schema dt. More...

	DataSet (te::da::DataSet &rhs)
	Regular copy constructor. More...

	DataSet (const DataSet &rhs, const bool deepCopy=false)
	It creates a new In-Memory dataset with the items from the rhs dataset. More...

	DataSet (te::da::DataSet &rhs, const std::vector< std::size_t > &properties, std::size_t limit=0)
	Copy constructor with property restriction. More...

void	drop (std::size_t pos)
	It drops a property from the dataset. More...

void	remove ()
	It removes the current dataset item. More...

void	remove (DataSetItem *item)
	It removes a specific dataset item. More...

void	update (te::dt::Property *prop)
	It update a property from the dataset. 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 pos) const
	It returns the underlying data type of the property at position pos. More...

void	setPropertyDataType (int dt, std::size_t pos)

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

void	setPropertyName (const std::string &name, std::size_t pos)

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 pos) const
	It returns the underlying dataset name of the property at position pos. More...

DataSetItem *	getItem () const

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...

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...

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

Methods to set values to the DataSet
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
std::map< int, te::common::CharEncoding >	m_encodings
	The list of string properties char-encoding. More...

int	m_i
	The index of the current item. More...

boost::shared_ptr < boost::ptr_vector < DataSetItem > >	m_items
	The list of dataset items. More...

std::vector< std::string >	m_pnames
	The list of property names. More...

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

Detailed Description

Implementation of a random-access dataset class for the TerraLib In-Memory Data Access driver.

See also: te::da::DataSet

Definition at line 65 of file DataSet.h.

Constructor & Destructor Documentation

te::mem::DataSet::DataSet ( const te::da::DataSetType *const dt )

explicit

It constructs an empty dataset having the schema dt.

Parameters

dt	The DataSetType associated to the dataset.

Note: The dataset will NOT take the ownership of the given DataSetType.

Definition at line 47 of file DataSet.cpp.

References te::dt::StringProperty::getCharEncoding(), te::dt::CompositeProperty::getProperty(), te::da::GetPropertyInfo(), m_encodings, m_pnames, m_ptypes, and te::dt::CompositeProperty::size().

te::mem::DataSet::DataSet ( te::da::DataSet & rhs )

Regular copy constructor.

It creates a new In-Memory dataset with the items from the rhs dataset.

Parameters

rhs	The dataset which will provide the items.

Precondition: You must assure that rhs is in a valid item to be read.

Note: This constructor will use the method "moveNext()" of the source dataset (rhs) in order to read its dataset 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.; The new dataset will not have a transactor associated to it.

Definition at line 62 of file DataSet.cpp.

References copy(), te::da::DataSet::getPropertyCharEncoding(), te::da::GetPropertyInfo(), m_encodings, m_pnames, m_ptypes, and te::dt::STRING_TYPE.

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

explicit

It creates a new In-Memory dataset with the items from the rhs dataset.

Parameters

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

Note: The new dataset will not have a transactor associated to it.

Definition at line 76 of file DataSet.cpp.

References getPropertyCharEncoding(), te::da::GetPropertyInfo(), m_encodings, m_items, m_pnames, m_ptypes, and te::dt::STRING_TYPE.

te::mem::DataSet::DataSet	(	te::da::DataSet &	rhs,
		const std::vector< std::size_t > &	properties,
		std::size_t	limit = `0`
	)

Copy constructor with property restriction.

It creates a new memory data set with items from a source dataset (rhs) considering just some properties.

Parameters

rhs	The data set whose data set items 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 (rhs) schema. In other words, they must be valid pointers in the rhs dataset type.

Note: This constructor will use the method "moveNext()" of the given data set in order to read its dataset 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.; The dataset will NOT take the ownership of the given properties, internally it will clone them.

Definition at line 93 of file DataSet.cpp.

References copy(), te::da::DataSet::getPropertyCharEncoding(), te::da::DataSet::getPropertyDataType(), te::da::DataSet::getPropertyName(), m_encodings, m_pnames, m_ptypes, and te::dt::STRING_TYPE.

te::mem::DataSet::~DataSet ( )

virtual

Destructor.

Reimplemented from te::da::DataSet.

Definition at line 110 of file DataSet.cpp.

Member Function Documentation

void te::mem::DataSet::add ( 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: In-Memory driver extended method.

Definition at line 172 of file DataSet.cpp.

Referenced by te::cellspace::CellularSpacesOperations::addCell(), te::mem::DataSource::addProperty(), te::vp::BufferMemory::dissolveMemory(), Editor::getEditedDataSet(), te::vp::IntersectionMemory::pairwiseIntersection(), te::vp::BufferQuery::prepareDataSet(), te::vp::GeometricOpQuery::SetOutputDSet(), and te::vp::IntersectionQuery::updateGeomType().

void te::mem::DataSet::add	(	const std::string &	propertyName,
		std::size_t	propertyType,
		const te::dt::AbstractData *	defaultValue = `0`
	)

It adds a new property to the dataset schema and fills this new property with a default value.

Parameters

prop	The new property that will be created. The dataset will take its ownership.
defaultValue	The default value that will be used to fill the new property values. May be a NULL value.

Note: The DataSet will NOT take the ownership of the informed default value.; In-Memory driver extended method.

Definition at line 198 of file DataSet.cpp.

References te::dt::AbstractData::clone().

void te::mem::DataSet::clear ( )

It clears all the dataset items.

Definition at line 114 of file DataSet.cpp.

Referenced by te::vp::BufferMemory::dissolveMemory().

void te::mem::DataSet::copy	(	te::da::DataSet &	src,
		std::size_t	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.

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.; In-Memory driver extended method.

Definition at line 119 of file DataSet.cpp.

References te::da::DataSet::getNumProperties().

Referenced by te::mem::DataSource::add(), and DataSet().

void te::mem::DataSet::copy	(	te::da::DataSet &	src,
		const std::vector< std::size_t > &	properties,
		std::size_t	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 (rhs) schema. In other words, they must be valid pointers in the rhs dataset type.

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.; In-Memory driver extended method.

Definition at line 131 of file DataSet.cpp.

References te::da::DataSet::getValue(), te::da::DataSet::isNull(), te::da::DataSet::moveNext(), and TE_TR.

void te::mem::DataSet::drop ( std::size_t pos )

It drops a property from the dataset.

Parameters

prop	The property that will be dropped.

Note: The Property will be destroyed.; In-Memory driver extended method.

Definition at line 209 of file DataSet.cpp.

Referenced by te::mem::DataSource::dropProperty().

te::common::AccessPolicy te::mem::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.

Definition at line 236 of file DataSet.cpp.

References te::common::RWAccess.

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

virtual

Method for retrieving an array.

Parameters

i	The attribute index.

Implements te::da::DataSet.

Definition at line 582 of file DataSet.cpp.

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.

Definition at line 144 of file DataSet.cpp.

References te::da::GetPropertyPos().

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.

Definition at line 218 of file DataSet.cpp.

References te::dt::ARRAY_TYPE, te::dt::BOOLEAN_TYPE, te::dt::BYTE_ARRAY_TYPE, te::dt::CHAR_TYPE, te::common::Convert2String(), te::dt::DATETIME_TYPE, te::dt::DOUBLE_TYPE, te::dt::FLOAT_TYPE, te::dt::GEOMETRY_TYPE, getDouble(), te::dt::INT16_TYPE, te::dt::INT32_TYPE, te::dt::INT64_TYPE, te::dt::NUMERIC_TYPE, te::dt::RASTER_TYPE, te::dt::STRING_TYPE, and te::dt::UCHAR_TYPE.

Referenced by te::ogr::Transactor::add(), te::sa::AssociateGPMVertexAttribute(), te::sa::KernelRatioOperation::buildTree(), te::sa::KernelMapOperation::buildTree(), te::sa::SkaterOperation::createDataSet(), te::map::QueryLayerRenderer::drawDatSetGeometries(), te::attributefill::VectorToVectorMemory::getClassWithHighestIntersectionArea(), te::attributefill::VectorToVectorMemory::getClassWithHighestOccurrence(), te::attributefill::VectorToVectorMemory::getDistinctClasses(), te::qt::widgets::Info::getGeometryInfo(), te::attributefill::VectorToVectorMemory::getPercentageOfEachClassByArea(), te::attributefill::VectorToVectorMemory::getPercentagePerClass(), te::attributefill::VectorToVectorMemory::getWeightedByArea(), te::attributefill::VectorToVectorMemory::getWeightedSumByArea(), te::qt::widgets::Promoter::preProcessKeys(), te::sa::BayesLocalOperation::runBayesLocal(), ToHighlight(), te::da::TupleToStringConverter(), te::ado::Transactor::update(), and te::pgis::Transactor::update().

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.

Definition at line 306 of file DataSet.cpp.

References te::da::GetPropertyPos().

bool te::mem::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.

Definition at line 447 of file DataSet.cpp.

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.

Definition at line 81 of file DataSet.cpp.

References te::da::GetPropertyPos().

std::auto_ptr< te::dt::ByteArray > te::mem::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.

Definition at line 522 of file DataSet.cpp.

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.

Definition at line 116 of file DataSet.cpp.

References te::da::GetPropertyPos().

char te::mem::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.

Definition at line 372 of file DataSet.cpp.

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.

Definition at line 46 of file DataSet.cpp.

References te::da::DataSet::getChar(), and te::da::GetPropertyPos().

std::string te::mem::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.

Definition at line 291 of file DataSet.cpp.

std::auto_ptr< te::dt::DateTime > te::mem::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.

Definition at line 567 of file DataSet.cpp.

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.

Definition at line 137 of file DataSet.cpp.

References te::da::GetPropertyPos().

double te::mem::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.

Definition at line 477 of file DataSet.cpp.

Referenced by te::sa::DataSetAdaptRadiusKernel(), te::sa::DataSetKernelNormalize(), te::sa::DataSetRatioKernel(), te::sa::BayesGlobalOperation::runBayesGlobal(), and te::sa::BayesLocalOperation::runBayesLocal().

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.

Definition at line 95 of file DataSet.cpp.

References getDouble(), and te::da::GetPropertyPos().

std::auto_ptr< te::gm::Envelope > te::mem::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.

Definition at line 241 of file DataSet.cpp.

Referenced by te::vp::BufferMemory::dissolveMemory().

float te::mem::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.

Definition at line 462 of file DataSet.cpp.

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.

Definition at line 88 of file DataSet.cpp.

References te::da::GetPropertyPos().

std::auto_ptr< te::gm::Geometry > te::mem::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.

Definition at line 537 of file DataSet.cpp.

Referenced by te::sa::DataSetAdaptRadiusKernel(), te::sa::DataSetKernelNormalize(), te::sa::DataSetRatioKernel(), te::sa::DataSetStatRadiusKernel(), and te::vp::BufferMemory::dissolveMemory().

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.

Definition at line 123 of file DataSet.cpp.

References te::da::GetPropertyPos().

boost::int16_t te::mem::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.

Definition at line 402 of file DataSet.cpp.

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.

Definition at line 60 of file DataSet.cpp.

References te::da::GetPropertyPos().

boost::int32_t te::mem::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.

Definition at line 417 of file DataSet.cpp.

Referenced by te::vp::BufferMemory::dissolveMemory().

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.

Definition at line 67 of file DataSet.cpp.

References te::da::GetPropertyPos().

boost::int64_t te::mem::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.

Definition at line 432 of file DataSet.cpp.

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.

Definition at line 74 of file DataSet.cpp.

References te::da::GetPropertyPos().

te::mem::DataSetItem * te::mem::DataSet::getItem ( ) const

Definition at line 296 of file DataSet.cpp.

References te::mem::DataSetItem::clone().

std::string te::mem::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.

Definition at line 492 of file DataSet.cpp.

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.

Definition at line 102 of file DataSet.cpp.

References te::da::GetPropertyPos().

std::size_t te::mem::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.

Definition at line 257 of file DataSet.cpp.

te::common::CharEncoding te::mem::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.

Definition at line 282 of file DataSet.cpp.

References te::common::UNKNOWN_CHAR_ENCODING.

Referenced by DataSet().

int te::mem::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.

Definition at line 262 of file DataSet.cpp.

std::string te::mem::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.

Definition at line 272 of file DataSet.cpp.

std::auto_ptr< te::rst::Raster > te::mem::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.

Definition at line 552 of file DataSet.cpp.

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.

Definition at line 130 of file DataSet.cpp.

References te::da::GetPropertyPos().

std::string te::mem::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.

Definition at line 507 of file DataSet.cpp.

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.

Definition at line 109 of file DataSet.cpp.

References te::da::GetPropertyPos().

te::common::TraverseType te::mem::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.

Definition at line 231 of file DataSet.cpp.

References te::common::RANDOM.

unsigned char te::mem::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.

Definition at line 387 of file DataSet.cpp.

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.

Definition at line 53 of file DataSet.cpp.

References te::da::GetPropertyPos().

std::auto_ptr< te::dt::AbstractData > te::mem::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.

Definition at line 587 of file DataSet.cpp.

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.

Definition at line 211 of file DataSet.cpp.

References te::da::GetPropertyPos().

bool te::mem::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.

Definition at line 367 of file DataSet.cpp.

bool te::mem::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.

Definition at line 352 of file DataSet.cpp.

bool te::mem::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.

Definition at line 362 of file DataSet.cpp.

bool te::mem::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.

Definition at line 357 of file DataSet.cpp.

bool te::mem::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.

Definition at line 306 of file DataSet.cpp.

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

virtual

It returns true if the collection is empty.

Returns: True, if the collection is empty.

Implements te::da::DataSet.

Definition at line 301 of file DataSet.cpp.

bool te::mem::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.

Definition at line 602 of file DataSet.cpp.

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.

Definition at line 313 of file DataSet.cpp.

References te::da::GetPropertyPos().

bool te::mem::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.

Definition at line 346 of file DataSet.cpp.

bool te::mem::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.

Definition at line 328 of file DataSet.cpp.

Referenced by te::sa::DataSetAdaptRadiusKernel(), te::sa::DataSetKernelNormalize(), te::sa::DataSetRatioKernel(), te::sa::DataSetStatRadiusKernel(), te::vp::BufferMemory::dissolveMemory(), te::vp::IntersectionMemory::pairwiseIntersection(), te::sa::BayesGlobalOperation::runBayesGlobal(), te::sa::BayesLocalOperation::runBayesLocal(), te::qt::widgets::VectorizationWizard::saveDataSet(), and te::sa::SamplePointsGeneratorAbstract::saveDataSet().

bool te::mem::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.

Definition at line 334 of file DataSet.cpp.

bool te::mem::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.

Definition at line 340 of file DataSet.cpp.

bool te::mem::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.

Definition at line 316 of file DataSet.cpp.

Referenced by te::sa::DataSetAdaptRadiusKernel(), te::sa::DataSetKernelNormalize(), te::sa::DataSetRatioKernel(), te::sa::DataSetStatRadiusKernel(), te::vp::BufferMemory::dissolveMemory(), te::vp::IntersectionMemory::pairwiseIntersection(), te::mem::DataSource::remove(), te::sa::BayesGlobalOperation::runBayesGlobal(), and te::sa::BayesLocalOperation::runBayesLocal().

bool te::mem::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.

Definition at line 322 of file DataSet.cpp.

void te::mem::DataSet::remove ( )

It removes the current dataset item.

Note: In-Memory driver extended method.

Definition at line 177 of file DataSet.cpp.

Referenced by te::mem::DataSource::remove().

void te::mem::DataSet::remove ( DataSetItem * item )

It removes a specific dataset item.

Note: In-Memory driver extended method.

Definition at line 182 of file DataSet.cpp.

References TE_TR.

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

Definition at line 452 of file DataSet.cpp.

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

Definition at line 457 of file DataSet.cpp.

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

Definition at line 527 of file DataSet.cpp.

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

Definition at line 532 of file DataSet.cpp.

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

Definition at line 377 of file DataSet.cpp.

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

Definition at line 382 of file DataSet.cpp.

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

Definition at line 572 of file DataSet.cpp.

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

Definition at line 577 of file DataSet.cpp.

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

Definition at line 482 of file DataSet.cpp.

Referenced by te::sa::DataSetAdaptRadiusKernel(), te::sa::DataSetKernelNormalize(), te::sa::DataSetRatioKernel(), te::sa::DataSetStatRadiusKernel(), te::sa::BayesGlobalOperation::runBayesGlobal(), and te::sa::BayesLocalOperation::runBayesLocal().

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

Definition at line 487 of file DataSet.cpp.

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

Definition at line 467 of file DataSet.cpp.

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

Definition at line 472 of file DataSet.cpp.

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

Definition at line 542 of file DataSet.cpp.

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

Definition at line 547 of file DataSet.cpp.

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

Definition at line 407 of file DataSet.cpp.

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

Definition at line 412 of file DataSet.cpp.

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

Definition at line 422 of file DataSet.cpp.

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

Definition at line 427 of file DataSet.cpp.

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

Definition at line 437 of file DataSet.cpp.

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

Definition at line 442 of file DataSet.cpp.

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

Definition at line 497 of file DataSet.cpp.

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

Definition at line 502 of file DataSet.cpp.

void te::mem::DataSet::setPropertyDataType	(	int	dt,
		std::size_t	pos
	)

Definition at line 267 of file DataSet.cpp.

void te::mem::DataSet::setPropertyName	(	const std::string &	name,
		std::size_t	pos
	)

Definition at line 277 of file DataSet.cpp.

Referenced by te::mem::DataSource::renameProperty().

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

Definition at line 557 of file DataSet.cpp.

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

Definition at line 562 of file DataSet.cpp.

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

Definition at line 512 of file DataSet.cpp.

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

Definition at line 517 of file DataSet.cpp.

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

Definition at line 392 of file DataSet.cpp.

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

Definition at line 397 of file DataSet.cpp.

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

Definition at line 592 of file DataSet.cpp.

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

Definition at line 597 of file DataSet.cpp.

std::size_t te::mem::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.

Definition at line 311 of file DataSet.cpp.

Referenced by te::sa::DataSetAdaptRadiusKernel(), te::sa::DataSetKernelNormalize(), te::sa::DataSetRatioKernel(), te::sa::DataSetStatRadiusKernel(), te::sa::BayesGlobalOperation::runBayesGlobal(), and te::sa::BayesLocalOperation::runBayesLocal().

void te::mem::DataSet::update ( te::dt::Property * prop )

It update a property from the dataset.

Parameters

prop	The property that will be updated.

Note: For now, for all items, the value will be changed to 0.

Note: In-Memory driver extended method.

Definition at line 220 of file DataSet.cpp.

Member Data Documentation

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

protected

The list of string properties char-encoding.

Definition at line 387 of file DataSet.h.

Referenced by DataSet().

int te::mem::DataSet::m_i

protected

The index of the current item.

Definition at line 388 of file DataSet.h.

boost::shared_ptr<boost::ptr_vector<DataSetItem> > te::mem::DataSet::m_items

protected

The list of dataset items.

Definition at line 384 of file DataSet.h.

Referenced by DataSet().

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

protected

The list of property names.

Definition at line 385 of file DataSet.h.

Referenced by DataSet().

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

protected

The list of property types.

Definition at line 386 of file DataSet.h.

Referenced by DataSet().

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

C:/TL5_2015_release/terralib5/src/terralib/memory/DataSet.h
C:/TL5_2015_release/terralib5/src/terralib/memory/DataSet.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation