This is the concrete factory for GDAL rasters. More...

#include <RasterFactory.h>

Inheritance diagram for te::gdal::RasterFactory:

Public Types
typedef FactoryDictionary < AbstractFactory< Raster, std::string, TKEYCOMPARE > , std::string, TKEYCOMPARE >	dictionary_type

typedef AbstractFactory	factory_type

Public Member Functions
std::map< std::string, std::string >	getCapabilities () const
	It return a map (string, string) containing all supported formats. More...

void	getCreationalParameters (std::vector< std::pair< std::string, std::string > > &params) const
	It returns the list of parameters accepted as raster info. More...

const std::string &	getKey () const
	It returns the factory key associated to the concreate factory. More...

const std::string &	getType () const
	Returns the type (name) of this factory. More...

	~RasterFactory ()
	Destructor. More...

Static Public Member Functions
static void	finalize ()
	It finalizes the factory: the singleton instance will be destroyed and will be unregistered from the abstract factory DataSourceFactory. More...

static const factory_type *	find (const std::string &factoryKey)

static dictionary_type &	getDictionary ()
	It returns a reference to the internal dictionary of concrete factories. More...

static void	initialize ()
	It initializes the factory: the singleton instance will be registered in the abstract factory DataSourceFactory. More...

static Raster *	make ()
	It creates and returns an empty raster with default raster driver. More...

static Raster *	make (const std::string &rType)
	It creates an empty raster with the proper driver. More...

static Raster *	make (Grid g, const std::vector< BandProperty > bands, const std::map< std::string, std::string > &rinfo, void h=0, void(deleter)(void *)=0)
	It creates a raster with the given parameters using the default raster driver. More...

static Raster *	make (const std::string &rType, Grid g, const std::vector< BandProperty > bands, const std::map< std::string, std::string > &rinfo, void h=0, void(deleter)(void *)=0)
	It creates a raster with the given parameters using a proper driver. More...

static Raster *	make (const std::map< std::string, std::string > &rinfo, void h=0, void(deleter)(void *)=0)
	It creates a raster with the given parameters using the default driver. More...

static Raster *	make (const std::string &rType, const std::map< std::string, std::string > &rinfo, void h, void(deleter)(void *)=0)
	It creates a raster with the given parameters using a proper driver. More...

static Raster *	open (const std::map< std::string, std::string > &rinfo, te::common::AccessPolicy p=te::common::RAccess)
	It opens a raster with the given parameters and default raster driver. More...

static Raster *	open (const std::string &rType, const std::map< std::string, std::string > &rinfo, te::common::AccessPolicy p=te::common::RAccess)
	It creates a raster with the given parameters. More...

static Raster *	open (const std::string &key, const std::string &value, te::common::AccessPolicy p=te::common::RAccess)
	It creates a raster with the given parameters and default raster driver. More...

static Raster *	open (const std::string &rType, const std::string &key, const std::string &value, te::common::AccessPolicy p=te::common::RAccess)
	It creates a raster with the given parameters. More...

Protected Member Functions
te::rst::Raster *	build ()
	Concrete factories (derived from this one) must implement this method in order to create objects. More...

te::rst::Raster *	create (te::rst::Grid g, const std::vector< te::rst::BandProperty > bands, const std::map< std::string, std::string > &rinfo, void h=0, void(deleter)(void *)=0)
	This method must be implemented by subclasses (raster drivers). More...

virtual Raster *	iOpen (const std::map< std::string, std::string > &rinfo, te::common::AccessPolicy p=te::common::RAccess)
	This method may be re-implemented by subclasses in order to have a finner control for the raster object instantiation. More...

	RasterFactory ()

Protected Attributes
std::string	m_factoryKey
	The key that identifies the concrete factory: it will be used for unregistering the factory during destruction. More...

Static Private Attributes
static RasterFactory *	sm_factory

Detailed Description

This is the concrete factory for GDAL rasters.

See also: te::rst::RasterFactory

Definition at line 44 of file RasterFactory.h.

Member Typedef Documentation

typedef FactoryDictionary<AbstractFactory<Raster , std::string , TKEYCOMPARE>, std::string , TKEYCOMPARE> te::common::AbstractFactory< Raster , std::string , TKEYCOMPARE >::dictionary_type

inherited

Definition at line 73 of file AbstractFactory.h.

typedef AbstractFactory te::common::AbstractFactory< Raster , std::string , TKEYCOMPARE >::factory_type

inherited

Definition at line 77 of file AbstractFactory.h.

Constructor & Destructor Documentation

te::gdal::RasterFactory::~RasterFactory ( )

inlinevirtual

Destructor.

Reimplemented from te::rst::RasterFactory.

Definition at line 48 of file RasterFactory.h.

te::gdal::RasterFactory::RasterFactory ( )

protected

Definition at line 60 of file RasterFactory.cpp.

Member Function Documentation

te::rst::Raster * te::gdal::RasterFactory::build ( )

protectedvirtual

Concrete factories (derived from this one) must implement this method in order to create objects.

Returns: It returns an object created by the concrete factory.

Implements te::common::AbstractFactory< Raster, std::string >.

Definition at line 74 of file RasterFactory.cpp.

te::rst::Raster * te::gdal::RasterFactory::create	(	te::rst::Grid *	g,
		const std::vector< te::rst::BandProperty * >	bands,
		const std::map< std::string, std::string > &	rinfo,
		void *	h = `0`,
		void()(void )	deleter = `0`
	)

protectedvirtual

This method must be implemented by subclasses (raster drivers).

Parameters

g	The raster grid. May be a NULL parameter. Implementations must take its ownership.
bands	A vector of band properties, one for each band. Implementations must take ownership of the pointers in this vector.
rinfo	The necessary information to create the raster.
h	It may be any specific value for a given driver. May be a NULL parameter.
deleter	A pointer to a deleter function used to free the memory pointed by h. May be a NULL parameter. Implementations must use this method when it doesn't use 'h' anymore.

Returns: The new raster.

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

Implements te::rst::RasterFactory.

Definition at line 65 of file RasterFactory.cpp.

void te::gdal::RasterFactory::finalize ( )

static

It finalizes the factory: the singleton instance will be destroyed and will be unregistered from the abstract factory DataSourceFactory.

Definition at line 54 of file RasterFactory.cpp.

Referenced by te::gdal::Module::shutdown().

static const factory_type* te::common::AbstractFactory< Raster , std::string , TKEYCOMPARE >::find ( const std::string & factoryKey )

staticinherited

std::map< std::string, std::string > te::gdal::RasterFactory::getCapabilities ( ) const

virtual

It return a map (string, string) containing all supported formats.

Implements te::rst::RasterFactory.

Definition at line 79 of file RasterFactory.cpp.

References capabilities.

void te::gdal::RasterFactory::getCreationalParameters ( std::vector< std::pair< std::string, std::string > > & params ) const

virtual

It returns the list of parameters accepted as raster info.

Implements te::rst::RasterFactory.

Definition at line 44 of file RasterFactory.cpp.

static dictionary_type& te::common::AbstractFactory< Raster , std::string , TKEYCOMPARE >::getDictionary ( )

staticinherited

It returns a reference to the internal dictionary of concrete factories.

The dictionary is a singleton.

Returns: A reference to the internal dictionary.

const std::string & te::common::AbstractFactory< Raster , std::string , TKEYCOMPARE >::getKey ( ) const

inherited

It returns the factory key associated to the concreate factory.

Returns: The factory key associated to the concreate factory.

const std::string & te::gdal::RasterFactory::getType ( ) const

virtual

Returns the type (name) of this factory.

Implements te::rst::RasterFactory.

Definition at line 39 of file RasterFactory.cpp.

References te::gdal::Globals::sm_driverIdentifier.

void te::gdal::RasterFactory::initialize ( )

static

It initializes the factory: the singleton instance will be registered in the abstract factory DataSourceFactory.

Definition at line 48 of file RasterFactory.cpp.

Referenced by te::gdal::Module::startup().

te::rst::Raster * te::rst::RasterFactory::iOpen	(	const std::map< std::string, std::string > &	rinfo,
		te::common::AccessPolicy	p = `te::common::RAccess`
	)

protectedvirtualinherited

This method may be re-implemented by subclasses in order to have a finner control for the raster object instantiation.

Parameters

rinfo	The necessary information to open the raster.
p	The access policy.

Returns: A raster.

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

Definition at line 122 of file RasterFactory.cpp.

Referenced by te::rst::RasterFactory::open().

te::rst::Raster * te::rst::RasterFactory::make ( )

staticinherited

It creates and returns an empty raster with default raster driver.

Returns: An empty raster.

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

Definition at line 35 of file RasterFactory.cpp.

References te::common::AbstractFactory< TPRODUCT, TFACTORYKEY, TKEYCOMPARE >::make(), and TE_DEFAULT_RASTER_TYPE.

te::rst::Raster * te::rst::RasterFactory::make ( const std::string & rType )

staticinherited

It creates an empty raster with the proper driver.

Parameters

rType The name of the specific driver to be used to create the raster.

Returns: An empty raster.

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

Definition at line 40 of file RasterFactory.cpp.

References te::common::Convert2UCase(), and te::common::AbstractFactory< TPRODUCT, TFACTORYKEY, TKEYCOMPARE >::make().

te::rst::Raster * te::rst::RasterFactory::make	(	Grid *	g,
		const std::vector< BandProperty * >	bands,
		const std::map< std::string, std::string > &	rinfo,
		void *	h = `0`,
		void()(void )	deleter = `0`
	)

staticinherited

It creates a raster with the given parameters using the default raster driver.

Parameters

g	The raster grid. The factory will take its ownership.
bands	A vector of band properties with one property for each band. The factory will take the ownership of all properties.
rinfo	The necessary information to create the raster.
h	It may be any specific value for a given driver.
deleter	A pointer to a deleter function used to free the memory pointed by h.

Returns: A new raster.

Note: The caller will take the ownership of the returned pointer.; If you inform a deleter when the created raster is destroyed it will call it for the informed h pointer.

Definition at line 47 of file RasterFactory.cpp.

References te::common::Convert2UCase(), and TE_DEFAULT_RASTER_TYPE.

te::rst::Raster * te::rst::RasterFactory::make	(	const std::string &	rType,
		Grid *	g,
		const std::vector< BandProperty * >	bands,
		const std::map< std::string, std::string > &	rinfo,
		void *	h = `0`,
		void()(void )	deleter = `0`
	)

staticinherited

It creates a raster with the given parameters using a proper driver.

Parameters

rType	The name of the specific driver to create the raster.
g	The raster grid. The factory will take its ownership.
bands	A vector of band properties, one property for each band. The factory will take the ownership of all properties.
rinfo	The necessary information to create the raster.
h	It may be any specific value for a given driver.
deleter	A pointer to a deleter function used to free the memory pointed by h.

Returns: A new raster.

Note: The caller will take the ownership of the returned pointer.; If you inform a deleter when the created raster is destroyed it will call it for the informed h pointer.

Definition at line 58 of file RasterFactory.cpp.

References te::common::Convert2UCase(), te::rst::RasterFactory::create(), te::common::FactoryDictionary< TFACTORY, TFACTORYKEY, TKEYCOMPARE >::find(), te::common::AbstractFactory< TPRODUCT, TFACTORYKEY, TKEYCOMPARE >::getDictionary(), and TE_TR.

te::rst::Raster * te::rst::RasterFactory::make	(	const std::map< std::string, std::string > &	rinfo,
		void *	h = `0`,
		void()(void )	deleter = `0`
	)

staticinherited

It creates a raster with the given parameters using the default driver.

Parameters

rinfo	The necessary information to create the raster.
h	It may be any specific value for a given driver.
deleter	A pointer to a deleter function used to free the memory pointed by h.

Returns: A new raster.

Note: The caller will take the ownership of the returned pointer.; If you inform a deleter when the created raster is destroyed it will call it for the informed h pointer.

Definition at line 74 of file RasterFactory.cpp.

References TE_DEFAULT_RASTER_TYPE.

te::rst::Raster * te::rst::RasterFactory::make	(	const std::string &	rType,
		const std::map< std::string, std::string > &	rinfo,
		void *	h,
		void()(void )	deleter = `0`
	)

staticinherited

It creates a raster with the given parameters using a proper driver.

Parameters

rType	The name of the specific driver to create the raster.
rinfo	The necessary information to create the raster.
h	It may be any specific value for a given driver.
deleter	A pointer to a deleter function used to free the memory pointed by h.

Returns: A new raster.

Note: The caller will take the ownership of the returned pointer.; If you inform a deleter when the created raster is destroyed it will call it for the informed h pointer.

Definition at line 79 of file RasterFactory.cpp.

te::rst::Raster * te::rst::RasterFactory::open	(	const std::map< std::string, std::string > &	rinfo,
		te::common::AccessPolicy	p = `te::common::RAccess`
	)

staticinherited

It opens a raster with the given parameters and default raster driver.

Parameters

rinfo	The necessary information to open the raster.
p	The access policy.

Returns: The opened raster.

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

Definition at line 84 of file RasterFactory.cpp.

References TE_DEFAULT_RASTER_TYPE.

Referenced by te::tools::rastermanager::Utils::getRaster(), te::map::RasterLayer::getRaster(), te::map::RasterLayer::getSchema(), te::rp::FeederConstRasterInfo::moveNext(), te::rp::FeederConstRasterDirectory::moveNext(), te::rp::FeederConstRasterInfo::moveTo(), te::rp::FeederConstRasterDirectory::moveTo(), te::mem::Raster::open(), te::rp::FeederConstRasterInfo::reset(), te::rp::FeederConstRasterDirectory::reset(), te::map::RasterLayer::setRasterInfo(), and te::gdal::Raster::transform().

te::rst::Raster * te::rst::RasterFactory::open	(	const std::string &	rType,
		const std::map< std::string, std::string > &	rinfo,
		te::common::AccessPolicy	p = `te::common::RAccess`
	)

staticinherited

It creates a raster with the given parameters.

Parameters

rType	The name of the specific driver to create the raster.
rinfo	The necessary information to open the raster.
p	The access policy.

Returns: The opened raster.

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

Definition at line 89 of file RasterFactory.cpp.

References te::common::Convert2UCase(), te::common::FactoryDictionary< TFACTORY, TFACTORYKEY, TKEYCOMPARE >::find(), te::common::AbstractFactory< TPRODUCT, TFACTORYKEY, TKEYCOMPARE >::getDictionary(), te::rst::RasterFactory::iOpen(), and TE_TR.

te::rst::Raster * te::rst::RasterFactory::open	(	const std::string &	key,
		const std::string &	value,
		te::common::AccessPolicy	p = `te::common::RAccess`
	)

staticinherited

It creates a raster with the given parameters and default raster driver.

Parameters

key	The name of the key used to define raster location, ex.: "URI".
value	The value of the key to define raster location, ex.: "/path/to/raster.tif".
p	The access policy.

Returns: The opened raster.

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

Definition at line 103 of file RasterFactory.cpp.

References TE_DEFAULT_RASTER_TYPE.

te::rst::Raster * te::rst::RasterFactory::open	(	const std::string &	rType,
		const std::string &	key,
		const std::string &	value,
		te::common::AccessPolicy	p = `te::common::RAccess`
	)

staticinherited

It creates a raster with the given parameters.

Parameters

rType	The name of the specific driver to create the raster.
key	The name of the key used to define raster location, ex.: "URI".
value	The value of the key to define raster location, ex.: "/path/to/raster.tif".
p	The access policy.

Returns: The opened raster.

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

Definition at line 108 of file RasterFactory.cpp.

Member Data Documentation

std::string te::common::AbstractFactory< Raster , std::string , TKEYCOMPARE >::m_factoryKey

protectedinherited

The key that identifies the concrete factory: it will be used for unregistering the factory during destruction.

Definition at line 136 of file AbstractFactory.h.

te::gdal::RasterFactory * te::gdal::RasterFactory::sm_factory

staticprivate

Definition at line 73 of file RasterFactory.h.

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

C:/BB_TL5/terralib5/src/terralib/gdal/RasterFactory.h
C:/BB_TL5/terralib5/src/terralib/gdal/RasterFactory.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation