te::qt::widgets::GlyphGraphicWidgetFactory Class Reference

A concrete factory that builds a graphic widget used to configure a graphic associate with a glyph mark element. More...

#include <GlyphGraphicWidgetFactory.h>

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

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.

 ~GlyphGraphicWidgetFactory ()
 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 AbstractGraphicWidgetmake (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...
 
Public Initializer

Methods for the control of the factory singleton.

static void initialize ()
 It initializes the factory: the singleton instance will be registered in the abstract factory AbstractGraphicWidgetFactory. More...
 
static void finalize ()
 It finalizes the factory: the singleton instance will be destroyed and will be unregistered from the abstract factory AbstractGraphicWidgetFactory. More...
 

Protected Member Functions

Re-implementation of Pure Virtual Method

Concrete factory methods.

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

Initializers.

 GlyphGraphicWidgetFactory ()
 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...
 

Static Private Attributes

static GlyphGraphicWidgetFactorysm_factory
 A pointer to the global factory. More...
 
static std::string sm_factoryKey
 The factory key. More...
 

Detailed Description

A concrete factory that builds a graphic widget used to configure a graphic associate with a glyph mark element.

See also
AbstractGraphicWidgetFactory

Definition at line 46 of file GlyphGraphicWidgetFactory.h.

Member Typedef Documentation

◆ dictionary_type

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.

◆ factory_type

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

◆ ~GlyphGraphicWidgetFactory()

te::qt::widgets::GlyphGraphicWidgetFactory::~GlyphGraphicWidgetFactory ( )

Destructor.

Note
It will automatically unregister the factory from the dictionary.

◆ GlyphGraphicWidgetFactory()

te::qt::widgets::GlyphGraphicWidgetFactory::GlyphGraphicWidgetFactory ( )
protected

It creates the factory.

The key of a GlyphGraphicWidgetFactory is a string.

Parameters
factoryKeyThe key that identifies the factory.

Member Function Documentation

◆ build()

AbstractGraphicWidget* te::qt::widgets::GlyphGraphicWidgetFactory::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< AbstractGraphicWidget, std::string >.

◆ finalize()

static void te::qt::widgets::GlyphGraphicWidgetFactory::finalize ( )
static

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

◆ find()

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

Definition at line 164 of file AbstractFactory.h.

◆ getDictionary()

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

◆ initialize()

static void te::qt::widgets::GlyphGraphicWidgetFactory::initialize ( )
static

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

◆ make()

AbstractGraphicWidget * te::common::AbstractFactory< AbstractGraphicWidget , 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.

◆ RegisteredWidgets()

static void te::qt::widgets::AbstractGraphicWidgetFactory::RegisteredWidgets ( std::vector< std::string > &  keys)
staticinherited

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

◆ m_factoryKey

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.

◆ sm_factory

GlyphGraphicWidgetFactory* te::qt::widgets::GlyphGraphicWidgetFactory::sm_factory
staticprivate

A pointer to the global factory.

Definition at line 109 of file GlyphGraphicWidgetFactory.h.

◆ sm_factoryKey

std::string te::qt::widgets::GlyphGraphicWidgetFactory::sm_factoryKey
staticprivate

The factory key.

Definition at line 108 of file GlyphGraphicWidgetFactory.h.


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