A concrete factory that builds a graphic widget used to configure a graphic associate with an one well-known mark element. More...

#include <WellKnownGraphicWidgetFactory.h>

Inheritance diagram for 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.

Public Destructor
Destructor.
	~WellKnownGraphicWidgetFactory ()
	Destructor.

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.

static AbstractGraphicWidget *	make (const std::string &factoryKey)
	It creates an object with the appropriated factory.

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.

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

Public Destructor
Destructor.
static void	RegisteredWidgets (std::vector< std::string > &keys)
	It informs the key of each registered graphic widget factory.

Protected Member Functions
Re-implementation of Pure Virtual Method
Concrete factory methods.
AbstractGraphicWidget *	build ()
	Concrete factories (derived from this one) must implement this method in order to create objects.

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

Protected Initializers
Initializers.
static std::string	sm_factoryKey
	The factory key.

static WellKnownGraphicWidgetFactory *	sm_factory
	A pointer to the global factory.

	WellKnownGraphicWidgetFactory ()
	It creates the factory.

Detailed Description

A concrete factory that builds a graphic widget used to configure a graphic associate with an one well-known mark element.

See also: AbstractGraphicWidgetFactory

Definition at line 46 of file WellKnownGraphicWidgetFactory.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

◆ ~WellKnownGraphicWidgetFactory()

te::qt::widgets::WellKnownGraphicWidgetFactory::~WellKnownGraphicWidgetFactory ( )

Destructor.

Note: It will automatically unregister the factory from the dictionary.

◆ WellKnownGraphicWidgetFactory()

te::qt::widgets::WellKnownGraphicWidgetFactory::WellKnownGraphicWidgetFactory ( )

protected

It creates the factory.

The key of a WellKnownGraphicWidgetFactory is a string.

Parameters

factoryKey The key that identifies the factory.

Member Function Documentation

◆ build()

AbstractGraphicWidget * te::qt::widgets::WellKnownGraphicWidgetFactory::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::WellKnownGraphicWidgetFactory::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 108 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 106 of file AbstractFactory.h.

◆ getKey()

const std::string & te::common::AbstractFactory< AbstractGraphicWidget , std::string , std::less<std::string > >::getKey

inlineinherited

It returns the factory key associated to the concreate factory.

Returns: The factory key associated to the concreate factory.

Definition at line 84 of file AbstractFactory.h.

◆ initialize()

static void te::qt::widgets::WellKnownGraphicWidgetFactory::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

factoryKey A key that identifies the factory used to build the object.

Returns: It returns a new object created by the given factory.

Exceptions

Exception If 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 97 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

keys	A 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

WellKnownGraphicWidgetFactory* te::qt::widgets::WellKnownGraphicWidgetFactory::sm_factory

staticprivate

A pointer to the global factory.

Definition at line 109 of file WellKnownGraphicWidgetFactory.h.

◆ sm_factoryKey

std::string te::qt::widgets::WellKnownGraphicWidgetFactory::sm_factoryKey

staticprivate

The factory key.

Definition at line 108 of file WellKnownGraphicWidgetFactory.h.

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

/home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/qt/widgets/se/WellKnownGraphicWidgetFactory.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Protected Initializers

Detailed Description

Member Typedef Documentation

◆ dictionary_type

◆ factory_type

Constructor & Destructor Documentation

◆ ~WellKnownGraphicWidgetFactory()

◆ WellKnownGraphicWidgetFactory()

Member Function Documentation

◆ build()

◆ finalize()

◆ find()

◆ getDictionary()

◆ getKey()

◆ initialize()

◆ make()

◆ RegisteredWidgets()

Member Data Documentation

◆ m_factoryKey

◆ sm_factory

◆ sm_factoryKey