te::process::TaskFactory Class Reference

Wrapper function used to create taks. Used to avoid C++ to create multiple instances of the factory singleton on Windows. More...

#include <Task.h>

Inheritance diagram for te::process::TaskFactory:

Public Types
typedef FactoryDictionary< AbstractFactory< te::process::Task, 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...
	TaskFactory (const std::string &taskType, const std::string &category)
	Constructor. More...
virtual	~TaskFactory ()
	Gets all registered categories. More...

Static Public Member Functions
static const factory_type *	find (const std::string &factoryKey)
static std::vector< std::string >	getCategories ()
	Gets all tasks from the give category. More...
static dictionary_type &	getDictionary ()
	It returns a reference to the internal dictionary of concrete factories. More...
static std::vector< std::string >	getTasksFromCategory (const std::string &category)
static te::process::Task *	make (const std::string &factoryKey)
	It creates an object with the appropriated factory. More...

Protected Member Functions
virtual te::process::Task *	build ()=0
	Concrete factories (derived from this one) must implement this method in order to create objects. 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 Protected Attributes
static std::map< std::string, std::vector< std::string > >	m_mapCategories

Detailed Description

Wrapper function used to create taks. Used to avoid C++ to create multiple instances of the factory singleton on Windows.

Abstract factory used to create Tasks.

Definition at line 161 of file Task.h.

Member Typedef Documentation

dictionary_type

typedef FactoryDictionary<AbstractFactory<te::process::Task , std::string , std::less<std::string > >, std::string , std::less<std::string > > te::common::AbstractFactory< te::process::Task , std::string , std::less<std::string > >::dictionary_type

inherited

Definition at line 73 of file AbstractFactory.h.

factory_type

typedef AbstractFactory te::common::AbstractFactory< te::process::Task , std::string , std::less<std::string > >::factory_type

inherited

Definition at line 77 of file AbstractFactory.h.

Constructor & Destructor Documentation

TaskFactory()

te::process::TaskFactory::TaskFactory	(	const std::string &	taskType,
		const std::string &	category
	)

Constructor.

Parameters

factoryKey

The key that identifies the factory. Destructor

~TaskFactory()

virtual te::process::TaskFactory::~TaskFactory ( )

virtual

Gets all registered categories.

Member Function Documentation

build()

virtual te::process::Task * te::common::AbstractFactory< te::process::Task , 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::process::DataStoreTaskFactory, and te::process::DataAccessTaskFactory.

find()

const AbstractFactory< te::process::Task , std::string , std::less<std::string > >::factory_type * te::common::AbstractFactory< te::process::Task , std::string , std::less<std::string > >::find ( const TFACTORYKEY &  factoryKey )

inlinestaticinherited

Definition at line 108 of file AbstractFactory.h.

getCategories()

static std::vector<std::string> te::process::TaskFactory::getCategories ( )

static

Gets all tasks from the give category.

getDictionary()

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

getTasksFromCategory()

static std::vector<std::string> te::process::TaskFactory::getTasksFromCategory ( const std::string &  category )

static

make()

te::process::Task * te::common::AbstractFactory< te::process::Task , std::string , std::less<std::string > >::make ( const TFACTORYKEY &  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.

Member Data Documentation

m_factoryKey

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

m_mapCategories

std::map<std::string, std::vector<std::string> > te::process::TaskFactory::m_mapCategories

staticprotected

Definition at line 183 of file Task.h.

---

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

• /home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/process/Task.h