Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
te::vp::OperationFactory Class Referenceabstract

Abstract factory used to create Operations. More...

#include <AbstractOperation.h>

Inheritance diagram for te::vp::OperationFactory:
te::common::AbstractFactory< te::vp::AbstractOperation, std::string > te::vp::DifferenceOperationFactory te::vp::DissolveOperationFactory te::vp::DissolveSubdivisionOperationFactory te::vp::IdentityOperationFactory te::vp::IntersectionOperationFactory te::vp::MakeValidOperationFactory te::vp::SubdivideOperationFactory te::vp::UnionOperationFactory

Public Types

typedef FactoryDictionary< AbstractFactory< te::vp::AbstractOperation, 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...
 

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

Protected Member Functions

virtual te::vp::AbstractOperation * build ()=0
 Concrete factories (derived from this one) must implement this method in order to create objects. More...
 
 OperationFactory (const std::string &factoryKey)
 Constructor. More...
 
virtual ~OperationFactory ()
 

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

Abstract factory used to create Operations.

Definition at line 311 of file AbstractOperation.h.

Member Typedef Documentation

◆ dictionary_type

typedef FactoryDictionary<AbstractFactory<te::vp::AbstractOperation , std::string , std::less<std::string > >, std::string , std::less<std::string > > te::common::AbstractFactory< te::vp::AbstractOperation , 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::vp::AbstractOperation , std::string , std::less<std::string > >::factory_type
inherited

Definition at line 77 of file AbstractFactory.h.

Constructor & Destructor Documentation

◆ OperationFactory()

te::vp::OperationFactory::OperationFactory ( const std::string &  factoryKey)
protected

Constructor.

Parameters
factoryKeyThe key that identifies the factory. Destructor

◆ ~OperationFactory()

virtual te::vp::OperationFactory::~OperationFactory ( )
protectedvirtual

Member Function Documentation

◆ build()

virtual te::vp::AbstractOperation * te::common::AbstractFactory< te::vp::AbstractOperation , 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::vp::UnionOperationFactory, te::vp::SubdivideOperationFactory, te::vp::MakeValidOperationFactory, te::vp::IntersectionOperationFactory, te::vp::IdentityOperationFactory, te::vp::DissolveSubdivisionOperationFactory, te::vp::DissolveOperationFactory, and te::vp::DifferenceOperationFactory.

◆ find()

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

Definition at line 108 of file AbstractFactory.h.

◆ getDictionary()

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

◆ make()

te::vp::AbstractOperation * te::common::AbstractFactory< te::vp::AbstractOperation , std::string , std::less<std::string > >::make ( const TFACTORYKEY &  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 97 of file AbstractFactory.h.

Member Data Documentation

◆ m_factoryKey

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