CModuleCreator Class Reference

#include <CModuleCreator.h>

Inheritance diagram for CModuleCreator:

[legend]List of all members.

Public Member Functions
	CModuleCreator (const string &rType)
	//!< Module type string.
virtual	~CModuleCreator ()
	CModuleCreator (const CModuleCreator &aCModuleCreator)
CModuleCreator &	operator= (const CModuleCreator &rhs)
int	operator== (const CModuleCreator &rhs) const
int	operator!= (const CModuleCreator &rhs) const
string	getModuleType () const
bool	Match (const string &rType) const
virtual CReadableObject *	Create (CTCLInterpreter &rInterp, CTCLResult &rResult, int nArgs, char **pArgs)=0
virtual string	Help ()=0
	CModuleCreator (const string &rType)
	//!< Module type string.
virtual	~CModuleCreator ()
	CModuleCreator (const CModuleCreator &aCModuleCreator)
CModuleCreator &	operator= (const CModuleCreator &aCModuleCreator)
int	operator== (const CModuleCreator &aCModuleCreator) const
int	operator!= (const CModuleCreator &rhs) const
string	getModuleType () const
bool	Match (const string &rType)
virtual CDigitizerModule *	Create (CTCLInterpreter &rInterp, CTCLResult &rResult, int nArgs, char **pArgs)=0
virtual string	Help ()=0
Protected Member Functions
void	setModuleType (const string am_sModuleType)
void	setModuleType (const string am_sModuleType)
Private Attributes
string	m_sModuleType

---

Detailed Description

Abstract base class of a set of factory like (creational) modules that make data acquisition module classes. Each of these has a string module type. And the following key members:

• Match - return true if an input string matches the module type.
• Create - Returns a new module.
• Help - Returns stringified help about the type of module created by this class.

Definition at line 321 of file CModuleCreator.h.

---

Constructor & Destructor Documentation

CModuleCreator::CModuleCreator (  const string &  rType  )

//!< Module type string. Constructor: The only thing we need to do is initialize the module type field: Parameters: rType  const string& [in] Type name of the parameter. This turns out to be the module_type for tcl commands of the form: module create module_type Definition at line 308 of file CModuleCreator.cpp.

CModuleCreator::~CModuleCreator (   )  [virtual]

There is nothing interesting to do for the destructor. Definition at line 317 of file CModuleCreator.cpp.

CModuleCreator::CModuleCreator (  const CModuleCreator &  rhs  )

Copy construction. We are constructed as an exact copy of the parameter Definition at line 324 of file CModuleCreator.cpp.

CModuleCreator::CModuleCreator (  const string &  rType  )

//!< Module type string.

virtual CModuleCreator::~CModuleCreator (   )  [virtual]

CModuleCreator::CModuleCreator (  const CModuleCreator &  aCModuleCreator  )

---

Member Function Documentation

virtual CDigitizerModule* CModuleCreator::Create (  CTCLInterpreter &  rInterp, CTCLResult &  rResult, int  nArgs, char **  pArgs )  [pure virtual]

Implemented in CCAENV775Creator, CCAENV785Creator, CCAENV792Creator, CCAENV830Creator, CPacketCreator, CCAENV775Creator, CCAENV785Creator, CCAENV792Creator, and CCAENV830Creator.

virtual CReadableObject* CModuleCreator::Create (  CTCLInterpreter &  rInterp, CTCLResult &  rResult, int  nArgs, char **  pArgs )  [pure virtual]

Implemented in CCAENV775Creator, CCAENV785Creator, CCAENV792Creator, CCAENV830Creator, CPacketCreator, CCAENV775Creator, CCAENV785Creator, CCAENV792Creator, and CCAENV830Creator.

string CModuleCreator::getModuleType (   )  const [inline]

Definition at line 338 of file include/CModuleCreator.h. References m_sModuleType.

string CModuleCreator::getModuleType (   )  const [inline]

Definition at line 345 of file CModuleCreator.h. References m_sModuleType. Referenced by CPacketCreator::Create(), CCAENV830Creator::Create(), CCAENV792Creator::Create(), CCAENV775Creator::Create(), TypesGatherer::operator()(), and CModuleCommand::TypesGatherer::operator()().

virtual string CModuleCreator::Help (   )  [pure virtual]

Implemented in CCAENV775Creator, CCAENV785Creator, CCAENV792Creator, CCAENV830Creator, CPacketCreator, CCAENV775Creator, CCAENV785Creator, CCAENV792Creator, and CCAENV830Creator.

virtual string CModuleCreator::Help (   )  [pure virtual]

Implemented in CCAENV775Creator, CCAENV785Creator, CCAENV792Creator, CCAENV830Creator, CPacketCreator, CCAENV775Creator, CCAENV785Creator, CCAENV792Creator, and CCAENV830Creator. Referenced by TypesGatherer::operator()(), and CModuleCommand::TypesGatherer::operator()().

bool CModuleCreator::Match (  const string &  rType  )

Function: Returns true if the input string matches the module type. Parameters: rType  const string& [in] The type of module being searched for. Returns: One of: true - If rType == m_sModuleType -false - if not. Definition at line 376 of file src/CModuleCreator.cpp. References m_sModuleType.

bool CModuleCreator::Match (  const string &  rType  )  const

Function: Returns true if the input string matches the module type. Parameters: rType  const string& [in] The type of module being searched for. Returns: One of: true - If rType == m_sModuleType -false - if not. Definition at line 379 of file CModuleCreator.cpp.

int CModuleCreator::operator!= (  const CModuleCreator &  rhs  )  const [inline]

Definition at line 329 of file include/CModuleCreator.h. References operator==().

int CModuleCreator::operator!= (  const CModuleCreator &  rhs  )  const [inline]

Definition at line 336 of file CModuleCreator.h. References operator==().

CModuleCreator& CModuleCreator::operator= (  const CModuleCreator &  aCModuleCreator  )

CModuleCreator & CModuleCreator::operator= (  const CModuleCreator &  rhs  )

Assignment. rhs is copied into this. The only difference between assignment and copy construction is that copy constructed objects are being created, and assignment objects have longer duration. Parameters: rhs  ConstCModuleCreator& [in] The rhs of the assignment operation. Returns: a new object that can be put into the readout subsystem. Definition at line 343 of file CModuleCreator.cpp. References m_sModuleType. Referenced by CPacketCreator::operator=(), CCAENV830Creator::operator=(), CCAENV792Creator::operator=(), CCAENV785Creator::operator=(), and CCAENV775Creator::operator=().

int CModuleCreator::operator== (  const CModuleCreator &  aCModuleCreator  )  const

int CModuleCreator::operator== (  const CModuleCreator &  rhs  )  const

Test for equality. The assumption is that there cannot be two modules with the same mdule name. Parameters: rhs  CModuleCreator& [in] rhs of the == operator. Definition at line 359 of file CModuleCreator.cpp. References m_sModuleType. Referenced by operator!=(), CPacketCreator::operator==(), CCAENV830Creator::operator==(), CCAENV792Creator::operator==(), CCAENV785Creator::operator==(), and CCAENV775Creator::operator==().

void CModuleCreator::setModuleType (  const string  am_sModuleType  )  [inline, protected]

Definition at line 348 of file include/CModuleCreator.h. References m_sModuleType.

void CModuleCreator::setModuleType (  const string  am_sModuleType  )  [inline, protected]

Definition at line 355 of file CModuleCreator.h. References m_sModuleType.

---

Member Data Documentation

string CModuleCreator::m_sModuleType [private]

Definition at line 319 of file include/CModuleCreator.h. Referenced by getModuleType(), Match(), operator=(), operator==(), and setModuleType().

---

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

• CModuleCreator.h
• include/CModuleCreator.h
• CModuleCreator.cpp
• src/CModuleCreator.cpp

---