A Factory singleton class for creating objects whose class derives from BinsBase.
More...
#include <BinsFactory.h>
Public Member Functions |
void | add (BinsBase *) |
| Adds a prototype object to the list of prototypes.
|
BinsBase * | 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 () const |
| Returns the list of available prototype names.
|
BinsBase * | 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 BinsFactory * | instance () |
| Returns a pointer to the singleton instance.
|
Protected Member Functions |
| BinsFactory () |
| A default constructor for prevent creation except by the itself or the derived classes.
|
Protected Attributes |
std::vector< std::string > | m_names |
| The list of available types by names.
|
std::map< std::string, BinsBase * > | m_types |
| A list of available types.
|
Private Member Functions |
| BinsFactory (const BinsFactory &) |
| A private copy constructor to prevent copying.
|
void | initialize () |
| Initializes the factory with a set of default functions.
|
Detailed Description
A Factory singleton class for creating objects whose class derives from BinsBase.
These classes are used by BinningProjector objects to accumulate data into bins. They differ in how they create Projected Value objects. Some may take the accumulated total as the value while other may take the mean of the accumulation.
- Author
- Paul F. Kunz Paul_.nosp@m.Kunz.nosp@m.@slac.nosp@m..sta.nosp@m.nford.nosp@m..edu
Definition at line 31 of file BinsFactory.h.
Constructor & Destructor Documentation
A private copy constructor to prevent copying.
Member Function Documentation
BinsBase * 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.
const std::vector< std::string >& names |
( |
| ) |
const |
|
inherited |
Returns the list of available prototype names.
BinsBase * 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, BinsBase * > m_types |
|
protectedinherited |
A list of available types.
Definition at line 53 of file Factory.h.
The documentation for this class was generated from the following files: