BinToColorFactory Class Reference

#include <BinToColorFactory.h>

Inheritance diagram for BinToColorFactory:

Inheritance graph
Factory\< hippodraw::BinToColor \>
[legend]
Collaboration diagram for BinToColorFactory:

Collaboration graph
Factory\< hippodraw::BinToColor \>
[legend]

List of all members.


Detailed Description

A factory for creation of objects whose class is derived from BinToColor.

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

Definition at line 28 of file BinToColorFactory.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
BinToColorFactory
instance ()
 Returns a pointer to the singleton instance.

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

 BinToColorFactory ()
 A default constructor for prevent creation except by itself.
 BinToColorFactory (const BinToColorFactory &)
 A private copy constructor to avoid copying.
void initialize ()
 Initializes the factory with a set of default BinToColors.

Static Private Attributes

static
BinToColorFactory
s_instance = 0
 A pointer to the singleton object.

Constructor & Destructor Documentation

BinToColorFactory ( const BinToColorFactory  )  [private]

A private copy constructor to avoid copying.

BinToColorFactory (  )  [private]

A default constructor for prevent creation except by itself.

Definition at line 66 of file BinToColorFactory.cxx.

Referenced by BinToColorFactory::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().

bool exists ( const std::string &  name  )  const [inline, inherited]

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

Definition at line 136 of file Factory.h.

References Factory::m_types.

Referenced by FitterFactory::setDefault().

void initialize (  )  [private]

Initializes the factory with a set of default BinToColors.

Definition at line 79 of file BinToColorFactory.cxx.

Referenced by BinToColorFactory::instance().

BinToColorFactory * instance (  )  [static]

Returns a pointer to the singleton instance.

Definition at line 70 of file BinToColorFactory.cxx.

References BinToColorFactory::BinToColorFactory(), BinToColorFactory::initialize(), and BinToColorFactory::s_instance.

Referenced by DisplayController::addValueTransform(), ColorBoxPointRep::ColorBoxPointRep(), ColorSymbolPointRep::ColorSymbolPointRep(), PointRepXML::createObject(), BinToColorXML::createObject(), DisplayController::getValueTransformTypes(), ContourPointRep::init(), DisplayController::removeValueTransform(), QtDisplay::setColorMap(), and DisplayController::setValueTransform().

const std::vector< std::string > & names (  )  const [inline, inherited]

Returns the list of available prototype names.

Definition at line 170 of file Factory.h.

References Factory::m_names, and Factory::m_types.

Referenced by hippodraw::Python::export_FitterFactory(), hippodraw::Python::export_FunctionFactory(), hippodraw::Python::export_PointRepFactory(), FitterFactory::getDefault(), and DisplayController::getTextTypes().

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

Definition at line 148 of file Factory.h.

References Factory::m_types.

Referenced by DataRepController::bindingOptions(), Factory::create(), DisplayController::createDisplay(), TransformFactory::createTransform(), TransformFactory::createXY(), TransformFactory::createXYZ(), and DisplayController::isCompatible().

void remove ( const std::string &  name  )  [inline, inherited]

Removes the named prototype object from the list of prototypes.

Definition at line 125 of file Factory.h.

References Factory::m_types.


Member Data Documentation

std::vector< std::string > m_names [mutable, 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 58 of file Factory.h.

Referenced by Factory::names().

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

A list of available types.

Definition at line 53 of file Factory.h.

Referenced by Factory::add(), Factory::exists(), Factory::names(), Factory::prototype(), Factory::remove(), and Factory::~Factory().

BinToColorFactory * s_instance = 0 [static, private]

A pointer to the singleton object.

Definition at line 34 of file BinToColorFactory.h.

Referenced by BinToColorFactory::instance().


The documentation for this class was generated from the following files:
Generated for HippoDraw Class Library by doxygen