BinToColorFactory Class Reference

#include <BinToColorFactory.h>

Inheritance diagram for BinToColorFactory:

[legend]Collaboration diagram for BinToColorFactory:

[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 26 of file BinToColorFactory.h.

Public Member Functions
void	add (BinToColor *)
	Adds a prototype object to the list of prototypes.
void	addModel (const std::string &model_name)
	Adds a new model of type BinToUsrDefinedScale to the factory.
BinToColor *	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.
int	get_num_models ()
	Returns the number of predefined models in the factory.
const std::vector< std::string > &	names ()
	Returns the list of available prototype names.
BinToColor *	prototype (const std::string &name) const
	Returns a pointer to a prototype with name name.
Static Public Member Functions
static BinToColorFactory *	instance ()
	Returns a pointer to the singleton instance.
Protected Member Functions
	Factory ()
	The default constructor.
Protected Attributes
std::vector< std::string >	m_names
	The list of available types by names.
std::map< std::string, BinToColor * >	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.
Private Attributes
int	numModels
	Stores the number of predefined models in the factory.
Static Private Attributes
static BinToColorFactory *	s_instance = 0
	A pointer to the singleton object.

---

Constructor & Destructor Documentation

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

A private copy constructor to avoid copying.

BinToColorFactory::BinToColorFactory (   )  [private]

A default constructor for prevent creation except by itself. Definition at line 38 of file BinToColorFactory.cxx. Referenced by instance().

---

Member Function Documentation

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

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

void BinToColorFactory::addModel (  const std::string &  model_name  )

Adds a new model of type BinToUsrDefinedScale to the factory. Definition at line 71 of file BinToColorFactory.cxx. References Factory< BinToColor >::add().

BinToColor * Factory< BinToColor >::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< BinToColor >::exists (  const std::string &  name  )  const [inherited]

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

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

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

int BinToColorFactory::get_num_models (   )

Returns the number of predefined models in the factory. Definition at line 66 of file BinToColorFactory.cxx. References numModels.

void BinToColorFactory::initialize (   )  [private]

Initializes the factory with a set of default BinToColors. Definition at line 52 of file BinToColorFactory.cxx. References Factory< BinToColor >::add(), and numModels. Referenced by instance().

BinToColorFactory * BinToColorFactory::instance (   )  [static]

Returns a pointer to the singleton instance. Definition at line 42 of file BinToColorFactory.cxx. References BinToColorFactory(), initialize(), and s_instance. Referenced by ColorBoxPointRep::ColorBoxPointRep(), ColorSymbolPointRep::ColorSymbolPointRep(), PointRepXML::createObject(), BinToColorXML::createObject(), DisplayController::getValueTransformTypes(), ContourPointRep::init(), QtDisplay::setColorMap(), and DisplayController::setValueTransform().

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

Returns the list of available prototype names.

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

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

int BinToColorFactory::numModels [private]

Stores the number of predefined models in the factory. Definition at line 44 of file BinToColorFactory.h. Referenced by get_num_models(), and initialize().

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

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

---

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

• BinToColorFactory.h
• BinToColorFactory.cxx

---