te::map::MarkRendererManager Class Reference

This is a singleton for managing all mark renderers instances available in the system. More...

#include <MarkRendererManager.h>

Inheritance diagram for te::map::MarkRendererManager:

Public Types
typedef ClassLevelLockingPolicy< ::boost::lock_guard< ::boost::recursive_mutex > >	LockRead
typedef ClassLevelLockingPolicy< ::boost::lock_guard< ::boost::recursive_mutex > >	LockWrite
typedef volatile MarkRendererManager	VolatileType

Public Member Functions
void	add (const std::string &key, AbstractMarkRenderer *renderer)
	It adds a new mark renderer to the manager.
void	clear ()
	It clears the marks renderers of the manager.
void	getAllSupportedMarks (std::vector< std::string > &marks) const
	It informs the set of all supported marks available in the system.
te::color::RGBAColor **	render (const MarkRendererParams &markRenderParams)
	It generates the image pattern from the given Symbology Enconding Mark element.

Static Public Member Functions
static MarkRendererManager &	getInstance ()
	It returns a reference to the singleton instance.

Protected Member Functions
	MarkRendererManager ()
	It initializes the singleton instance of the mark renderer manager.
	~MarkRendererManager ()
	Singleton destructor.

Private Attributes
std::map< std::string, AbstractMarkRenderer * >	m_renderers
	The mark renderers in the manager.

Static Private Attributes
static ::boost::recursive_mutex	sm_mtx
	The mutex used to control the class lock.

Friends
class	te::common::Singleton< MarkRendererManager >

Detailed Description

This is a singleton for managing all mark renderers instances available in the system.

If you want to render a mark, use commands like: te::color::RBGA** image = te::map::MarkRendererManager::getInstance().render(mark, size);

See also

AbstractMarkRenderer

Definition at line 64 of file MarkRendererManager.h.

Member Typedef Documentation

LockRead

typedef ClassLevelLockingPolicy<::boost::lock_guard< ::boost::recursive_mutex > > te::common::ClassLevelLockable< MarkRendererManager , ::boost::recursive_mutex , ::boost::lock_guard< ::boost::recursive_mutex > , ::boost::lock_guard< ::boost::recursive_mutex > >::LockRead

inherited

Definition at line 302 of file ThreadingPolicies.h.

LockWrite

typedef ClassLevelLockingPolicy<::boost::lock_guard< ::boost::recursive_mutex > > te::common::ClassLevelLockable< MarkRendererManager , ::boost::recursive_mutex , ::boost::lock_guard< ::boost::recursive_mutex > , ::boost::lock_guard< ::boost::recursive_mutex > >::LockWrite

inherited

Definition at line 303 of file ThreadingPolicies.h.

VolatileType

typedef volatile MarkRendererManager te::common::ClassLevelLockable< MarkRendererManager , ::boost::recursive_mutex , ::boost::lock_guard< ::boost::recursive_mutex > , ::boost::lock_guard< ::boost::recursive_mutex > >::VolatileType

inherited

Definition at line 301 of file ThreadingPolicies.h.

Constructor & Destructor Documentation

MarkRendererManager()

te::map::MarkRendererManager::MarkRendererManager ( )

protected

It initializes the singleton instance of the mark renderer manager.

~MarkRendererManager()

te::map::MarkRendererManager::~MarkRendererManager ( )

protected

Singleton destructor.

Member Function Documentation

add()

void te::map::MarkRendererManager::add	(	const std::string &	key,
		AbstractMarkRenderer *	renderer
	)

It adds a new mark renderer to the manager.

Parameters

key	The key of the new renderer.
renderer	The new mark renderer that will be added on the manager.

Note

The manager will take the owership of the given mark renderer.

Exceptions

Exception

It will throws an exception if there is already a mark renderer registered with the given key.

clear()

void te::map::MarkRendererManager::clear

(

)

It clears the marks renderers of the manager.

getAllSupportedMarks()

void te::map::MarkRendererManager::getAllSupportedMarks

(

std::vector< std::string > &

marks

)

const

It informs the set of all supported marks available in the system.

Parameters

marks

A pre-created vector of string that will be filled with the supported marks names.

Note

All registered mark renderers will be consulted.

getInstance()

MarkRendererManager & te::common::Singleton< MarkRendererManager >::getInstance

inlinestaticinherited

It returns a reference to the singleton instance.

Returns

A reference to the singleton instance.

Definition at line 109 of file Singleton.h.

render()

te::color::RGBAColor ** te::map::MarkRendererManager::render

(

const MarkRendererParams &

markRenderParams

)

It generates the image pattern from the given Symbology Enconding Mark element.

Parameters

markRenderParams

The parameters that will be used to render the mark

Returns

The RGBA image that represents the mark.

Note

This method will look the name of the mark and try extract the associated rendererKey. The pattern used is "rendererKey://markName". Case empty will be used the default mark renderer.

The caller will take the ownership of the returned pointer.

Exceptions

Exception

It will throws an exception if the image pattern can not be generated.

Friends And Related Symbol Documentation

te::common::Singleton< MarkRendererManager >

friend class te::common::Singleton< MarkRendererManager >

friend

Definition at line 64 of file MarkRendererManager.h.

Member Data Documentation

m_renderers

std::map<std::string, AbstractMarkRenderer*> te::map::MarkRendererManager::m_renderers

private

The mark renderers in the manager.

Definition at line 128 of file MarkRendererManager.h.

sm_mtx

::boost::recursive_mutex te::common::ClassLevelLockable< MarkRendererManager , ::boost::recursive_mutex , ::boost::lock_guard< ::boost::recursive_mutex > , ::boost::lock_guard< ::boost::recursive_mutex > >::sm_mtx

staticprivateinherited

The mutex used to control the class lock.

Definition at line 310 of file ThreadingPolicies.h.

---

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

• /home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/maptools/MarkRendererManager.h