BinToColorFactory Class Reference

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

#include <BinToColorFactory.h>

Inheritance diagram for BinToColorFactory:

Collaboration diagram for BinToColorFactory:

Public Member Functions
void	add (BinToColor *)
	Adds a prototype object to the list of prototypes. More...
BinToColor *	create (const std::string &name)
	Creates a new object from a prototype named name. More...
bool	exists (const std::string &name) const
	Returns true if prototype with name name exists in the factory, otherwise returns false. More...
const std::vector< std::string > &	names () const
	Returns the list of available prototype names. More...
BinToColor *	prototype (const std::string &name) const
	Returns a pointer to a prototype with name name. More...
void	remove (const std::string &name)
	Removes the named prototype object from the list of prototypes. More...

Static Public Member Functions
static BinToColorFactory *	instance ()
	Returns a pointer to the singleton instance. More...

Protected Attributes
std::vector< std::string >	m_names
	The list of available types by names. More...
std::map< std::string, BinToColor * >	m_types
	A list of available types. More...

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

Static Private Attributes
static BinToColorFactory *	s_instance = 0
	A pointer to the singleton object. More...

Detailed Description

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

Author

Paul F. Kunz Paul_.nosp@m.Kunz.nosp@m.@slac.nosp@m..sta.nosp@m.nford.nosp@m..edu

Definition at line 28 of file BinToColorFactory.h.

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 ( BinToColor *  )

inherited

Adds a prototype object to the list of prototypes.

Referenced by BinToColorFactory::initialize().

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 exists ( const std::string &  name ) const

inherited

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

void initialize ( )

private

Initializes the factory with a set of default BinToColors.

Definition at line 79 of file BinToColorFactory.cxx.

References Factory< BinToColor >::add().

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(), BinToColorXML::createObject(), PointRepXML::createObject(), DisplayController::getValueTransformTypes(), ContourPointRep::init(), DisplayController::removeValueTransform(), QtDisplay::setColorMap(), and DisplayController::setValueTransform().

const std::vector< std::string >& names ( ) const

inherited

Returns the list of available prototype names.

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.

void remove ( const std::string &  name )

inherited

Removes the named prototype object from the list of prototypes.

Member Data Documentation

std::vector< std::string > m_names

mutableprotectedinherited

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.

std::map< std::string, BinToColor * > m_types

protectedinherited

A list of available types.

Definition at line 53 of file Factory.h.

BinToColorFactory * s_instance = 0

staticprivate

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:

• BinToColorFactory.h
• BinToColorFactory.cxx