Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
te::qt::widgets::AbstractGraphicWidgetFactory Class Referenceabstract

The abstract factory of widgets used to configure Symbology Enconding Graphic element. More...

#include <AbstractGraphicWidgetFactory.h>

Inheritance diagram for te::qt::widgets::AbstractGraphicWidgetFactory:
te::common::AbstractFactory< AbstractGraphicWidget, std::string > te::qt::widgets::GlyphGraphicWidgetFactory te::qt::widgets::LocalGraphicWidgetFactory te::qt::widgets::WellKnownGraphicWidgetFactory

Public Types

typedef FactoryDictionary< AbstractFactory< AbstractGraphicWidget, 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...
 
Public Destructor

Destructor.

virtual ~AbstractGraphicWidgetFactory ()
 Virtual destructor. More...
 

Static Public Member Functions

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 AbstractGraphicWidget * make (const std::string &factoryKey)
 It creates an object with the appropriated factory. More...
 
static void RegisteredWidgets (std::vector< std::string > &keys)
 It informs the key of each registered graphic widget factory. More...
 

Protected Member Functions

virtual AbstractGraphicWidget * build ()=0
 Concrete factories (derived from this one) must implement this method in order to create objects. More...
 
Protected Initializers

Initializers.

 AbstractGraphicWidgetFactory (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

The abstract factory of widgets used to configure Symbology Enconding Graphic element.

See also
AbstractFactory

Definition at line 53 of file AbstractGraphicWidgetFactory.h.

Member Typedef Documentation

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

Definition at line 73 of file AbstractFactory.h.

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

Definition at line 77 of file AbstractFactory.h.

Constructor & Destructor Documentation

virtual te::qt::widgets::AbstractGraphicWidgetFactory::~AbstractGraphicWidgetFactory ( )
virtual

Virtual destructor.

Note
It will automatically unregister the factory from the dictionary.
te::qt::widgets::AbstractGraphicWidgetFactory::AbstractGraphicWidgetFactory ( const std::string &  factoryKey)
protected

It creates the factory.

The key of a AbstractGraphicWidgetFactory is a string.

Parameters
factoryKeyThe key that identifies the factory.

Member Function Documentation

virtual AbstractGraphicWidget * te::common::AbstractFactory< AbstractGraphicWidget , 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::qt::widgets::LocalGraphicWidgetFactory, te::qt::widgets::GlyphGraphicWidgetFactory, and te::qt::widgets::WellKnownGraphicWidgetFactory.

static const factory_type* te::common::AbstractFactory< AbstractGraphicWidget , std::string , std::less<std::string > >::find ( const std::string &  factoryKey)
staticinherited
static dictionary_type& te::common::AbstractFactory< AbstractGraphicWidget , std::string , std::less<std::string > >::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< AbstractGraphicWidget , std::string , std::less<std::string > >::getKey ( ) const
inherited

It returns the factory key associated to the concreate factory.

Returns
The factory key associated to the concreate factory.
static AbstractGraphicWidget * te::common::AbstractFactory< AbstractGraphicWidget , std::string , std::less<std::string > >::make ( const std::string &  factoryKey)
staticinherited

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.
static void te::qt::widgets::AbstractGraphicWidgetFactory::RegisteredWidgets ( std::vector< std::string > &  keys)
static

It informs the key of each registered graphic widget factory.

Parameters
keysA pre-created vector of string that will be filled with the keys of each registered graphic widget factory.
Note
All registered factories will be consulted.

Member Data Documentation

std::string te::common::AbstractFactory< AbstractGraphicWidget , 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: