Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
AnimalFactory Class Referenceabstract

#include <AnimalsFactory.h>

Inheritance diagram for AnimalFactory:
te::common::AbstractFactory< Animal, std::string > KillerWhaleFactory MyrmecophagidaeFactory PlatypusFactory

Public Types

typedef FactoryDictionary< AbstractFactory< Animal, 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 ~AnimalFactory ()
 

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 Animal * make (const std::string &factoryKey)
 It creates an object with the appropriated factory. More...
 

Protected Member Functions

 AnimalFactory (const std::string &factoryKey)
 
virtual Animal * 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...
 

Detailed Description

Definition at line 10 of file AnimalsFactory.h.

Member Typedef Documentation

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

Definition at line 73 of file AbstractFactory.h.

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

Definition at line 77 of file AbstractFactory.h.

Constructor & Destructor Documentation

virtual AnimalFactory::~AnimalFactory ( )
inlinevirtual

Definition at line 15 of file AnimalsFactory.h.

References AnimalFactory().

AnimalFactory::AnimalFactory ( const std::string &  factoryKey)
protected

Definition at line 12 of file AnimalsFactory.cpp.

Referenced by ~AnimalFactory().

Member Function Documentation

virtual Animal * te::common::AbstractFactory< Animal , 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 MyrmecophagidaeFactory, PlatypusFactory, and KillerWhaleFactory.

Referenced by KillerWhaleFactory::~KillerWhaleFactory(), MyrmecophagidaeFactory::~MyrmecophagidaeFactory(), and PlatypusFactory::~PlatypusFactory().

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

Referenced by main().

Member Data Documentation

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