FunctionFactory Class Reference

#include <FunctionFactory.h>

Inheritance diagram for FunctionFactory:

[legend]Collaboration diagram for FunctionFactory:

[legend]List of all members.

---

Detailed Description

A Factory singleton class for creating objects whose class derives from FunctionBase.

Requests:

Be able to add new functions from a shared library.

Author:

Paul F. Kunz <Paul_Kunz@slac.stanford.edu>

Definition at line 29 of file FunctionFactory.h.

Public Member Functions
void	add (FunctionBase *)
	Adds a prototype object to the list of prototypes.
FunctionBase *	create (const std::string &name)
	Creates a new object from a prototype named name.
bool	exists (const std::string &name) const
	Returns true if prototype with name name exists in the factory, otherwise returns false.
const std::vector< std::string > &	names ()
	Returns the list of available prototype names.
FunctionBase *	prototype (const std::string &name) const
	Returns a pointer to a prototype with name name.
Static Public Member Functions
static FunctionFactory *	instance ()
	Returns a pointer to the singleton instance.
Protected Member Functions
	Factory ()
	The default constructor.
	FunctionFactory ()
	A default constructor for prevent creation except by the itself or the derived classes.
Protected Attributes
std::vector< std::string >	m_names
	The list of available types by names.
std::map< std::string, FunctionBase * >	m_types
	A list of available types.
Private Member Functions
	FunctionFactory (const FunctionFactory &)
	A private copy constructor to prevent copying.
void	initialize ()
	Initializes the factory with a set of default functions.
Static Private Attributes
static FunctionFactory *	s_instance = 0
	A pointer to the singleton object.

---

Constructor & Destructor Documentation

FunctionFactory::FunctionFactory (  const FunctionFactory &   )  [private]

A private copy constructor to prevent copying.

FunctionFactory::FunctionFactory (   )  [protected]

A default constructor for prevent creation except by the itself or the derived classes. Definition at line 36 of file FunctionFactory.cxx. Referenced by instance().

---

Member Function Documentation

void Factory< FunctionBase >::add (  FunctionBase *   )  [inherited]

Adds a prototype object to the list of prototypes. Referenced by hippodraw::Python::export_FunctionFactory(), and initialize().

FunctionBase * Factory< FunctionBase >::create (  const std::string &  name  )  [inherited]

Creates a new object from a prototype named name. If found, returns a new object by invoking the clone() member function of the prototype. If not found, throws a FactoryException object with the name not found. Referenced by hippodraw::Python::export_FunctionFactory().

bool Factory< FunctionBase >::exists (  const std::string &  name  )  const [inherited]

Returns true if prototype with name name exists in the factory, otherwise returns false.

Factory< FunctionBase >::Factory (   )  [protected, inherited]

The default constructor. Since this constructor is protected, only derived classes of Factory can be created.

void FunctionFactory::initialize (   )  [private]

Initializes the factory with a set of default functions. Definition at line 49 of file FunctionFactory.cxx. References Factory< FunctionBase >::add(). Referenced by instance().

FunctionFactory * FunctionFactory::instance (   )  [static]

Returns a pointer to the singleton instance. Definition at line 40 of file FunctionFactory.cxx. References FunctionFactory(), initialize(), and s_instance. Referenced by hippodraw::Python::export_FunctionFactory(), FunctionController::functionExists(), FunctionProjector::FunctionProjector(), FunctionController::isCompatible(), and Inspector::updateFunctionsTab().

const std::vector< std::string >& Factory< FunctionBase >::names (   )  [inherited]

Returns the list of available prototype names. Referenced by hippodraw::Python::export_FunctionFactory().

FunctionBase * Factory< FunctionBase >::prototype (  const std::string &  name  )  const [inherited]

Returns a pointer to a prototype with name name. If a prototype with name doesn't exit, throws a FactoryException object with the name not found.

---

Member Data Documentation

std::vector< std::string > Factory< FunctionBase >::m_names [protected, inherited]

The list of available types by names. This list should be identical to the list of m_types keys. It is updated when the member function names is called. Definition at line 56 of file Factory.h.

std::map< std::string, FunctionBase * > Factory< FunctionBase >::m_types [protected, inherited]

A list of available types. Definition at line 51 of file Factory.h.

FunctionFactory * FunctionFactory::s_instance = 0 [static, private]

A pointer to the singleton object. Definition at line 34 of file FunctionFactory.cxx. Referenced by instance().

---

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

• FunctionFactory.h
• FunctionFactory.cxx

---