te::map::RendererFactory Class Referenceabstract

This is the abstract factory for layer renderers. More...

#include <RendererFactory.h>

Inheritance diagram for te::map::RendererFactory:
te::common::AbstractFactory< AbstractRenderer, std::string > te::map::AbstractLayerRendererFactory te::map::QueryLayerRendererFactory te::ws::ogc::wms::WMSLayerRendererFactory

Public Types

typedef FactoryDictionary< AbstractFactory< AbstractRenderer, std::string, std::less< std::string > >, std::string, std::less< std::string > > dictionary_type
 
typedef AbstractFactory factory_type
 

Public Member Functions

const std::string & getKey () const
 It returns the factory key associated to the concreate factory. More...
 
virtual ~RendererFactory ()
 Virtual destructor. More...
 

Static Public Member Functions

static const factory_typefind (const std::string &factoryKey)
 
static dictionary_typegetDictionary ()
 It returns a reference to the internal dictionary of concrete factories. More...
 
static AbstractRenderermake (const std::string &factoryKey)
 It creates an object with the appropriated factory. More...
 

Protected Member Functions

virtual AbstractRendererbuild ()=0
 Concrete factories (derived from this one) must implement this method in order to create objects. More...
 
 RendererFactory (const std::string &factoryKey)
 It creates the factory. More...
 

Protected Attributes

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

Detailed Description

This is the abstract factory for layer renderers.

See also
AbstractRenderer, DataSetLayerRendererFactory, FeatureTypeStyleRendererFactory, CoverageStyleRendererFactory

Definition at line 47 of file RendererFactory.h.

Member Typedef Documentation

◆ dictionary_type

typedef FactoryDictionary<AbstractFactory<AbstractRenderer , std::string , std::less<std::string > >, std::string , std::less<std::string > > te::common::AbstractFactory< AbstractRenderer , std::string , std::less<std::string > >::dictionary_type
inherited

Definition at line 73 of file AbstractFactory.h.

◆ factory_type

typedef AbstractFactory te::common::AbstractFactory< AbstractRenderer , std::string , std::less<std::string > >::factory_type
inherited

Definition at line 77 of file AbstractFactory.h.

Constructor & Destructor Documentation

◆ ~RendererFactory()

virtual te::map::RendererFactory::~RendererFactory ( )
virtual

Virtual destructor.

Note
It will automatically unregister the factory from the dictionary.

◆ RendererFactory()

te::map::RendererFactory::RendererFactory ( const std::string &  factoryKey)
protected

It creates the factory.

Parameters
factoryKeyThe key that identifies the factory.

Member Function Documentation

◆ build()

virtual AbstractRenderer * te::common::AbstractFactory< AbstractRenderer , std::string , std::less<std::string > >::build ( )
protectedpure virtualinherited

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.

Implemented in te::map::AbstractLayerRendererFactory, te::map::QueryLayerRendererFactory, and te::ws::ogc::wms::WMSLayerRendererFactory.

◆ find()

const AbstractFactory< AbstractRenderer , std::string , std::less<std::string > >::factory_type * te::common::AbstractFactory< AbstractRenderer , std::string , std::less<std::string > >::find ( const std::string &  factoryKey)
inlinestaticinherited

Definition at line 164 of file AbstractFactory.h.

◆ getDictionary()

AbstractFactory< AbstractRenderer , std::string , std::less<std::string > >::dictionary_type & te::common::AbstractFactory< AbstractRenderer , std::string , std::less<std::string > >::getDictionary ( )
inlinestaticinherited

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

The dictionary is a singleton.

Returns
A reference to the internal dictionary.

Definition at line 157 of file AbstractFactory.h.

◆ getKey()

const std::string & te::common::AbstractFactory< AbstractRenderer , std::string , std::less<std::string > >::getKey ( ) const
inlineinherited

It returns the factory key associated to the concreate factory.

Returns
The factory key associated to the concreate factory.

Definition at line 140 of file AbstractFactory.h.

◆ make()

AbstractRenderer * te::common::AbstractFactory< AbstractRenderer , std::string , std::less<std::string > >::make ( const std::string &  factoryKey)
inlinestaticinherited

It creates an object with the appropriated factory.

Parameters
factoryKeyA key that identifies the factory used to build the object.
Returns
It returns a new object created by the given factory.
Exceptions
ExceptionIf the concrete factory is not specified or the object can not be built for any reason this methiod may throws an exception.
Note
The caller of this method will take the ownership of the returned object.

Definition at line 146 of file AbstractFactory.h.

Member Data Documentation

◆ m_factoryKey

std::string te::common::AbstractFactory< AbstractRenderer , std::string , std::less<std::string > >::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.


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