te::map::ChartRendererManager Class Reference

This is a singleton for managing chart renderer instance available in the system. More...

#include <ChartRendererManager.h>

Inheritance diagram for te::map::ChartRendererManager:

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

Public Member Functions
te::color::RGBAColor **	render (const Chart *chart, const std::map< std::string, double > &chartValue, std::size_t &width)
te::color::RGBAColor **	render (const Chart *chart, const te::da::DataSet *dataset, std::size_t &width)
	It generates the image pattern from the given chart and dataset. More...
void	set (AbstractChartRenderer *renderer)
	It sets the chart renderer to the manager. More...

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

Protected Member Functions
	ChartRendererManager ()
	It initializes the singleton instance of the chart renderer manager. More...
	~ChartRendererManager ()
	Singleton destructor. More...

Private Attributes
AbstractChartRenderer *	m_renderer
	The chart renderer in the manager. More...

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

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

Detailed Description

This is a singleton for managing chart renderer instance available in the system.

If you want to render a chart, use commands like: te::color::RBGA** image = te::map::ChartRendererManager::getInstance().render(chart, dataset);

See also

AbstractChartRenderer, Chart

Definition at line 61 of file ChartRendererManager.h.

Member Typedef Documentation

LockRead

typedef ClassLevelLockingPolicy<::boost::lock_guard< ::boost::recursive_mutex > > te::common::ClassLevelLockable< ChartRendererManager , ::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< ChartRendererManager , ::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 ChartRendererManager te::common::ClassLevelLockable< ChartRendererManager , ::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

ChartRendererManager()

te::map::ChartRendererManager::ChartRendererManager ( )

protected

It initializes the singleton instance of the chart renderer manager.

~ChartRendererManager()

te::map::ChartRendererManager::~ChartRendererManager ( )

protected

Singleton destructor.

Member Function Documentation

getInstance()

ChartRendererManager & te::common::Singleton< ChartRendererManager >::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() [1/2]

te::color::RGBAColor ** te::map::ChartRendererManager::render	(	const Chart *	chart,
		const std::map< std::string, double > &	chartValue,
		std::size_t &	width
	)

render() [2/2]

te::color::RGBAColor ** te::map::ChartRendererManager::render	(	const Chart *	chart,
		const te::da::DataSet *	dataset,
		std::size_t &	width
	)

It generates the image pattern from the given chart and dataset.

Parameters

chart	The chart informations that will be used.
dataset	The dataset that will be used.
width	An output parameter that will be filled with the width of generated image pattern.

Returns

The RGBA image that represents the chart.

Note

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.

set()

void te::map::ChartRendererManager::set

(

AbstractChartRenderer *

renderer

)

It sets the chart renderer to the manager.

Parameters

renderer

The renderer that will be set.

Note

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

Friends And Related Function Documentation

te::common::Singleton< ChartRendererManager >

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

friend

Definition at line 61 of file ChartRendererManager.h.

Member Data Documentation

m_renderer

AbstractChartRenderer* te::map::ChartRendererManager::m_renderer

private

The chart renderer in the manager.

Definition at line 107 of file ChartRendererManager.h.

sm_mtx

::boost::recursive_mutex te::common::ClassLevelLockable< ChartRendererManager , ::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/ChartRendererManager.h