CPacketCreator Class Reference

#include <CPacketCreator.h>

Inheritance diagram for CPacketCreator:

[legend]Collaboration diagram for CPacketCreator:

[legend]List of all members.

Public Member Functions
	CPacketCreator (const string &rType, CDigitizerDictionary *pDictionary)
	Construtor..
virtual	~CPacketCreator ()
	destructor
	CPacketCreator (const CPacketCreator &aCPacketCreator)
	copy
CPacketCreator &	operator= (const CPacketCreator &aCPacketCreator)
	assign
int	operator== (const CPacketCreator &aCPacketCreator) const
	compare.
int	operator!= (const CPacketCreator &aCPacketCReator) const
	inequal compare
virtual CReadableObject *	Create (CTCLInterpreter &rInterp, CTCLResult &rResult, int nArgs, char **pArgs)
	Create a module.
virtual string	Help ()
	Contribute to help.
Private Attributes
CDigitizerDictionary *	m_pModules

---

Constructor & Destructor Documentation

CPacketCreator::CPacketCreator (  const string &  rType, CDigitizerDictionary *  pDictionary )

Construtor.. Construct a module creator for the packetizing operator. Parameters: rType  (const string&) The type of the 'module' this class creates. rDictionary  (CDigitizerDictionary&) A reference to a dictionary of modules that have been constructed. We need this to construct ReadOrder modules. Definition at line 302 of file CPacketCreator.cpp. References m_pModules, and pDictionary().

CPacketCreator::~CPacketCreator (   )  [virtual]

destructor Destructor. Definition at line 319 of file CPacketCreator.cpp.

CPacketCreator::CPacketCreator (  const CPacketCreator &  aCPacketCreator  )

copy Copy constructor. Construct copy of an existing creator: Parameters: aCPacketCreator  (const CPacketCreator&) Reference to the module creational we are copying. Definition at line 329 of file CPacketCreator.cpp.

---

Member Function Documentation

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

Create a module. Returns a pointer to a readable object that is actually a CReadOrder module. Parameters: rInterp  (CTCLInterpreter& ) Reference to the interpreter that is running the creational command. rResult  (CTCLResult&) Reference to the result of the interpreter. This is the 'return value' of the command. nArgs  (int): Number of remaining command line parameters after the command string. pArgs  (char**) The remaining command line parameters after the command string. There must be at least two: name - The name of the module being created. type - The type of module being created (asserted for equality against getModuleType(). Any remaining parameters are treated as configuration parameters and passed to the module's Configure member function. Returns: CReadableObject* Pointer to the read order that was created. Implements CModuleCreator. Definition at line 411 of file CPacketCreator.cpp. References CConfigurableObject::Configure(), CModuleCreator::getModuleType(), and m_pModules.

string CPacketCreator::Help (   )  [virtual]

Contribute to help. Returns the help string associated with the module creational. Implements CModuleCreator. Definition at line 451 of file CPacketCreator.cpp.

int CPacketCreator::operator!= (  const CPacketCreator &  aCPacketCreator  )  const

inequal compare Inequality comparison operator. Parameters: aCPacketCreator  (const CPacketCreator&) Reference to the object to which we are being compared. Returns: int 1 If *this is not the same as aCPacketCreator. 0 If *this is the same as aCPacketCreator Definition at line 378 of file CPacketCreator.cpp. References operator==().

CPacketCreator & CPacketCreator::operator= (  const CPacketCreator &  aCPacketCreator  )

assign Assignment: An existing (fully constructed) object becomes a copy of another existing object. Parameters: aCPacketCreator  (Const CPacketCreator&) reference to the guy we're being assigned from. Returns: *this To support assignment chaining. Definition at line 345 of file CPacketCreator.cpp. References m_pModules, and CModuleCreator::operator=().

int CPacketCreator::operator== (  const CPacketCreator &  aCPacketCreator  )  const

compare. Equality comparison operator. Parameters: aCPacketCreator  (const CPacketCreator&) Reference to the object to which we are being compared. Returns: int 0 If *this is not the same as aCPacketCreator. 1 If *this is the same as aCPacketCreator Definition at line 364 of file CPacketCreator.cpp. References m_pModules, and CModuleCreator::operator==(). Referenced by operator!=().

---

Member Data Documentation

CDigitizerDictionary* CPacketCreator::m_pModules [private]

Definition at line 321 of file CPacketCreator.h. Referenced by CPacketCreator(), Create(), operator=(), and operator==().

---

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

• CPacketCreator.h
• CPacketCreator.cpp

---