BinsFactory Class Reference

#include <BinsFactory.h>

Inheritance diagram for BinsFactory:

[legend]Collaboration diagram for BinsFactory:

[legend]List of all members.

---

Detailed Description

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

These classes are used by BinningProjector objects to accumulate data into bins. They differ in how they create Projected Value objects. Some may take the accumulated total as the value while other may take the mean of the accumulation.

Author:

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

Definition at line 29 of file BinsFactory.h.

Public Member Functions
void	add (BinsBase *)
	Adds a prototype object to the list of prototypes.
BinsBase *	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.
BinsBase *	prototype (const std::string &name) const
	Returns a pointer to a prototype with name name.
Static Public Member Functions
static BinsFactory *	instance ()
	Returns a pointer to the singleton instance.
Protected Member Functions
	BinsFactory ()
	A default constructor for prevent creation except by the itself or the derived classes.
	Factory ()
	The default constructor.
Protected Attributes
std::vector< std::string >	m_names
	The list of available types by names.
std::map< std::string, BinsBase * >	m_types
	A list of available types.
Private Member Functions
	BinsFactory (const BinsFactory &)
	A private copy constructor to prevent copying.
void	initialize ()
	Initializes the factory with a set of default functions.
Static Private Attributes
static BinsFactory *	s_instance = 0
	A pointer to the singleton object.

---

Constructor & Destructor Documentation

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

A private copy constructor to prevent copying.

BinsFactory::BinsFactory (   )  [protected]

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

---

Member Function Documentation

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

Adds a prototype object to the list of prototypes. Referenced by initialize().

BinsBase * Factory< BinsBase >::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.

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

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

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

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

void BinsFactory::initialize (   )  [private]

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

BinsFactory * BinsFactory::instance (   )  [static]

Returns a pointer to the singleton instance. Definition at line 31 of file BinsFactory.cxx. References BinsFactory(), initialize(), and s_instance. Referenced by BinsBaseXML::createObject(), Hist1DProjImp::Hist1DProjImp(), Hist2DProjImp::Hist2DProjImp(), Profile2DProjector::Profile2DProjector(), and ProfileProjector::ProfileProjector().

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

Returns the list of available prototype names.

BinsBase * Factory< BinsBase >::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< BinsBase >::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, BinsBase * > Factory< BinsBase >::m_types [protected, inherited]

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

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

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

---

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

• BinsFactory.h
• BinsFactory.cxx

---