BinnerAxisFactory Class Reference

#include <BinnerAxisFactory.h>

Inheritance diagram for BinnerAxisFactory:

[legend]

Collaboration diagram for BinnerAxisFactory:

[legend]

List of all members.

Detailed Description

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

These classes are used by BinsBase objects to calculate a bin index. They differ in how the bin edges are determined. An example would be equal width bins which would be used by a simple histogram. However, the bin sizes do not have to be equal width.

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

Definition at line 31 of file BinnerAxisFactory.h.


Public Member Functions
void	add (Type *)
	Adds a prototype object to the list of prototypes.
Type *	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 () const
	Returns the list of available prototype names.
Type *	prototype (const std::string &name) const
	Returns a pointer to a prototype with name name.
void	remove (const std::string &name)
	Removes the named prototype object from the list of prototypes.
Static Public Member Functions
static BinnerAxisFactory *	instance ()
	Returns a pointer to the singleton instance.
Protected Member Functions
	BinnerAxisFactory ()
	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, Type * >	m_types
	A list of available types.
Private Member Functions
	BinnerAxisFactory (const BinnerAxisFactory &)
	A private copy constructor to prevent copying.
void	initialize ()
	Initializes the factory with a set of default functions.
Static Private Attributes
static BinnerAxisFactory *	s_instance = 0
	A pointer to the singleton object.

Constructor & Destructor Documentation

BinnerAxisFactory ( const BinnerAxisFactory & ) [private]

A private copy constructor to prevent copying.

BinnerAxisFactory ( ) [protected]

A default constructor for prevent creation except by the itself or the derived classes.

Definition at line 26 of file BinnerAxisFactory.cxx.

Referenced by BinnerAxisFactory::instance().

Member Function Documentation

void add ( Type * obj ) [inline, inherited]

Adds a prototype object to the list of prototypes.

Definition at line 116 of file Factory.h.

References Factory::m_types.

Referenced by hippodraw::Python::export_FunctionFactory().

Type * create ( const std::string & name ) [inline, 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.

Definition at line 160 of file Factory.h.

References Factory::prototype().

Referenced by CutController::createCut(), DataRepController::createDataRep(), PointRepXML::createObject(), BinsBaseXML::createObject(), BinnerAxisXML::createObject(), PlotterBaseXML::createPlotter(), DisplayController::createTextDataRep(), hippodraw::Python::export_FitterFactory(), hippodraw::Python::export_FunctionFactory(), hippodraw::Python::export_PointRepFactory(), Hist1DProjImp::Hist1DProjImp(), Hist2DProjImp::Hist2DProjImp(), and Profile2DProjector::Profile2DProjector().