PointRepFactory Class Reference

#include <PointRepFactory.h>

Inheritance diagram for PointRepFactory:

[legend]Collaboration diagram for PointRepFactory:

[legend]List of all members.

---

Detailed Description

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

Author:

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

Definition at line 26 of file PointRepFactory.h.

Public Member Functions
void	add (RepBase *)
	Adds a prototype object to the list of prototypes.
RepBase *	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.
RepBase *	prototype (const std::string &name) const
	Returns a pointer to a prototype with name name.
Static Public Member Functions
static PointRepFactory *	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, RepBase * >	m_types
	A list of available types.
Private Member Functions
void	initialize ()
	Initializes the factory with a set of default PointReps.
	PointRepFactory ()
	A default constructor for prevent creation except by itself.
	PointRepFactory (const PointRepFactory &)
	A private copy constructor to avoid copying.
Static Private Attributes
static PointRepFactory *	s_instance = 0
	A pointer to the singleton object.

---

Constructor & Destructor Documentation

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

A private copy constructor to avoid copying.

PointRepFactory::PointRepFactory (   )  [private]

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

---

Member Function Documentation

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

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

RepBase * Factory< RepBase >::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. Referenced by hippodraw::Python::export_PointRepFactory().

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

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

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

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

void PointRepFactory::initialize (   )  [private]

Initializes the factory with a set of default PointReps. Definition at line 42 of file PointRepFactory.cxx. References Factory< RepBase >::add(). Referenced by instance().

PointRepFactory * PointRepFactory::instance (   )  [static]

Returns a pointer to the singleton instance. Definition at line 33 of file PointRepFactory.cxx. References initialize(), PointRepFactory(), and s_instance. Referenced by PointRepXML::createObject(), hippodraw::Python::export_PointRepFactory(), and DisplayController::setRepresentation().

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

Returns the list of available prototype names. Referenced by hippodraw::Python::export_PointRepFactory().

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

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

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

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

---

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

• PointRepFactory.h
• PointRepFactory.cxx

---