PointRepFactory Class Reference

#include <PointRepFactory.h>

Inheritance diagram for PointRepFactory:

Inheritance graph
Factory\< RepBase \>Factory
[legend]
Collaboration diagram for PointRepFactory:

Collaboration graph
Factory\< RepBase \>Factory
[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 28 of file PointRepFactory.h.

Public Member Functions

void add (RepBase *)
 Adds a prototype object to the list of prototypes.
RepBasecreate (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.
RepBaseprototype (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 PointRepFactoryinstance ()
 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, 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 PointRepFactorys_instance = 0
 A pointer to the singleton object.


Constructor & Destructor Documentation

PointRepFactory ( const PointRepFactory  )  [private]

A private copy constructor to avoid copying.

PointRepFactory (  )  [private]

A default constructor for prevent creation except by itself.

Definition at line 31 of file PointRepFactory.cxx.

Referenced by PointRepFactory::instance().


Member Function Documentation

void add ( RepBase  )  [inherited]

Adds a prototype object to the list of prototypes.

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 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 PointReps.

Definition at line 44 of file PointRepFactory.cxx.

Referenced by PointRepFactory::instance().

PointRepFactory * instance (  )  [static]

Returns a pointer to the singleton instance.

Definition at line 35 of file PointRepFactory.cxx.

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

Referenced by PointRepXML::createObject(), hippodraw::Python::export_PointRepFactory(), and DisplayController::setPointRep().

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

Returns the list of available prototype names.

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

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.

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 [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.

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

A list of available types.

Definition at line 53 of file Factory.h.

PointRepFactory * s_instance = 0 [static, private]

A pointer to the singleton object.

Definition at line 34 of file PointRepFactory.h.

Referenced by PointRepFactory::instance().


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