TransformFactory Class Reference

#include <TransformFactory.h>

Inheritance diagram for TransformFactory:

Inheritance graph
[legend]
Collaboration diagram for TransformFactory:

Collaboration graph
[legend]

List of all members.


Detailed Description

The singleton Factory class for creating objects whose class is derived from TransformBase.

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

Oded Wurman <owurman@stanford.edu>

Definition at line 28 of file TransformFactory.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.
TransformBasecreateTransform (const std::string &name)
 Creates a returns a new TransformBase object with given name.
TransformBasecreateXYZ (const std::string &x_trans, const std::string &y_trans, const std::string &z_trans)
 Creates an XYZTransform object from independent X, Y and Z transforms designated by the 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 TransformFactoryinstance ()
 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

TransformBasecreateXY (const std::string &x_trans, const std::string &y_trans, const std::string &z_trans)
 Creates an XYTransform object from independent X, Y and Z transforms designated by the names.
void initialize ()
 Initialize the factory with a set of default Transforms.
 TransformFactory ()
 A default constructor for prevent creation except by itself.
 TransformFactory (const TransformFactory &)
 A private copy constructor to prevent copying.

Static Private Attributes

static TransformFactorys_instance = 0
 A pointer to the singleton object.

Constructor & Destructor Documentation

TransformFactory ( const TransformFactory  )  [private]

A private copy constructor to prevent copying.

TransformFactory (  )  [private]

A default constructor for prevent creation except by itself.

Definition at line 63 of file TransformFactory.cxx.

Referenced by TransformFactory::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]

TransformBase * createTransform ( const std::string &  name  ) 

Creates a returns a new TransformBase object with given name.

If the name contains a non-alphanumeric character, then an XYTransform is cnstructed by parsing the two alphanumeric parts of the name as names of UnaryTransform names.

Note that this functions name differs from the other Factory function nams becasue I (pfkeb) couldn't figure out how to override the function and yet be able to call the base class function.

Attention:
Do not try to use the given name first and if it fails catch the exception and parse the name for space. Doing so will break the Java version based on jdk-1.3.1 because of apparent incompatiblities in exception handling between the version of gcc used to compile the Java VM and gcc 2.95.3.
Todo:
Fix it so that more than one white space could be in string.
Todo:
Check of DISTANCE_DEFECT workaround works or find better way.

Definition at line 111 of file TransformFactory.cxx.

References TransformBase::clone(), TransformFactory::createXY(), and Factory::prototype().

Referenced by CompositePlotter::CompositePlotter(), TransformXML::createObject(), CompositePlotter::setFitsTransform(), DisplayController::setLog(), and DisplayController::setTransform().

TransformBase * createXY ( const std::string &  x_trans,
const std::string &  y_trans,
const std::string &  z_trans 
) [private]

Creates an XYTransform object from independent X, Y and Z transforms designated by the names.

Definition at line 141 of file TransformFactory.cxx.

References UnaryTransform::clone(), and Factory::prototype().

Referenced by TransformFactory::createTransform().

TransformBase * createXYZ ( const std::string &  x_trans,
const std::string &  y_trans,
const std::string &  z_trans 
)

Creates an XYZTransform object from independent X, Y and Z transforms designated by the name.

Definition at line 175 of file TransformFactory.cxx.

References UnaryTransform::clone(), and Factory::prototype().

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]

Initialize the factory with a set of default Transforms.

Definition at line 76 of file TransformFactory.cxx.

Referenced by TransformFactory::instance().

TransformFactory * instance (  )  [static]

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

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().

TransformFactory * s_instance = 0 [static, private]

A pointer to the singleton object.

Definition at line 34 of file TransformFactory.h.

Referenced by TransformFactory::instance().


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

Generated for HippoDraw Class Library by doxygen