---

CDocumentedPacketManager Class Reference

#include <CDocumentedPacketManager.h>

List of all members.

Public Methods
	CDocumentedPacketManager ()
	Default constructor.
	~CDocumentedPacketManager ()
	Destructor.
DocumentationPacketList	getDefinitions ()
void	AddPacket (CDocumentedPacket &rPacket)
void	DeletePacket (const string &rName)
DocumentationPacketIterator	begin ()
DocumentationPacketIterator	end ()
unsigned int	size ()
vector< string >	Format ()
Static Public Methods
CDocumentedPacketManager *	getInstance ()
Protected Methods
void	setDefinitions (DocumentationPacketList Packets)
Private Methods
	CDocumentedPacketManager (const CDocumentedPacketManager &rhs)
	Copy constructor.
CDocumentedPacketManager &	operator= (const CDocumentedPacketManager &rhs)
	Assignment.
int	operator== (const CDocumentedPacketManager &rhs) const
	Comparison for equality.
int	operator!= (const CDocumentedPacketManager &rhs) const
Private Attributes
DocumentationPacketList	m_PacketDefinitions
	List of packet types.
Static Private Attributes
CDocumentedPacketManager *	m_ptheInstance = 0
	Instance pointer to singleton packet manager.

---

Constructor & Destructor Documentation

CDocumentedPacketManager::CDocumentedPacketManager (    )

Default constructor. Default constructor. This is called when declarations of the form e.g.: CDocumentedPacketManager object are performed. We don't allow construction if m_ptheInstance is already defined. In that case a duplicate singletonexception is thrown. Definition at line 334 of file CDocumentedPacketManager.cpp. References m_ptheInstance.

CDocumentedPacketManager::~CDocumentedPacketManager (    )  [inline]

Destructor. Definition at line 330 of file CDocumentedPacketManager.h.

CDocumentedPacketManager::CDocumentedPacketManager (  const CDocumentedPacketManager &    rhs )  [private]

Copy constructor.

---

Member Function Documentation

void CDocumentedPacketManager::AddPacket (  CDocumentedPacket &    rPacket )

Adds a packet definition to the list of defined packets. Parameters: CDocumentedPack&  rPacket Definition at line 354 of file CDocumentedPacketManager.cpp. References m_PacketDefinitions. Referenced by CDocumentedPacket::CDocumentedPacket().

DocumentationPacketIterator CDocumentedPacketManager::begin (    )

Returns a loop iterator pointing at the first documented packet registered. Definition at line 384 of file CDocumentedPacketManager.cpp. References m_PacketDefinitions. Referenced by Format(), and CExperiment::TriggerDocBuffer().

void CDocumentedPacketManager::DeletePacket (  const string &    rName )

Removes a packet from the list. Parameters: rName  - const string& [in] Name of the packet to remove. Definition at line 366 of file CDocumentedPacketManager.cpp. References DocumentationPacketIterator, and m_PacketDefinitions. Referenced by CDocumentedPacket::~CDocumentedPacket().

DocumentationPacketIterator CDocumentedPacketManager::end (    )

Returns an end loop iterator to for the set of packets defined. Definition at line 396 of file CDocumentedPacketManager.cpp. References m_PacketDefinitions. Referenced by Format(), and CExperiment::TriggerDocBuffer().

vector< string > CDocumentedPacketManager::Format (    )

Returns the set of descriptions of each registered packet in a format suitable for inclusion in a data buffer. Definition at line 421 of file CDocumentedPacketManager.cpp. References begin(), DocumentationPacketIterator, and end().

DocumentationPacketList CDocumentedPacketManager::getDefinitions (    )  [inline]

Definition at line 344 of file CDocumentedPacketManager.h. References DocumentationPacketList, and m_PacketDefinitions.

CDocumentedPacketManager * CDocumentedPacketManager::getInstance (    )  [static]

Returns the singleton instance pointer. Definition at line 436 of file CDocumentedPacketManager.cpp. References m_ptheInstance. Referenced by CDocumentedPacket::CDocumentedPacket(), CExperiment::TriggerDocBuffer(), and CDocumentedPacket::~CDocumentedPacket().

int CDocumentedPacketManager::operator!= (  const CDocumentedPacketManager &    rhs )  const [private]

CDocumentedPacketManager& CDocumentedPacketManager::operator= (  const CDocumentedPacketManager &    rhs )  [private]

Assignment.

int CDocumentedPacketManager::operator== (  const CDocumentedPacketManager &    rhs )  const [private]

Comparison for equality.

void CDocumentedPacketManager::setDefinitions (  DocumentationPacketList    Packets )  [inline, protected]

Definition at line 353 of file CDocumentedPacketManager.h. References DocumentationPacketList, and m_PacketDefinitions.

unsigned int CDocumentedPacketManager::size (    )

Returns the number of documented packets currently registered. Definition at line 408 of file CDocumentedPacketManager.cpp. References m_PacketDefinitions.

---

Member Data Documentation

DocumentationPacketList CDocumentedPacketManager::m_PacketDefinitions [private]

List of packet types. Definition at line 325 of file CDocumentedPacketManager.h. Referenced by AddPacket(), begin(), DeletePacket(), end(), getDefinitions(), setDefinitions(), and size().

CDocumentedPacketManager * CDocumentedPacketManager::m_ptheInstance = 0 [static, private]

Instance pointer to singleton packet manager. Header: /usr/TruCluster/users/daqcvs/repository/NewClients/Readout/CDocumentedPacketManager.cpp,v 1.4 2002/10/22 12:38:15 fox Exp Modification History: Log: CDocumentedPacketManager.cpp,v Revision 1.4 2002/10/22 12:38:15 fox Straighten out dates in internal copyright notices. Revision 1.3 2002/10/15 12:48:22 fox 1. Initial testing 2. Add const variable and make tkloaded const. 3. Add TclServer functionality. Revision 1.2 2002/10/09 11:22:23 fox Stamp with copyright/gpl license notice Definition at line 305 of file CDocumentedPacketManager.cpp. Referenced by CDocumentedPacketManager(), and getInstance().

---

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

• CDocumentedPacketManager.h
• CDocumentedPacketManager.cpp

---