---

CEventSegment Class Reference

#include <CEventSegment.h>

Inheritance diagram for CEventSegment:

List of all members.

Public Methods
	CEventSegment ()
	Default constructor.
virtual	~CEventSegment ()
	Destructor.
virtual void	Initialize ()=0
virtual DAQWordBufferPtr &	Read (DAQWordBufferPtr &rBuffer)=0
virtual void	Clear ()=0
virtual unsigned int	MaxSize ()=0
Private Methods
	CEventSegment (const CEventSegment &rhs)
	Copy constructor.
CEventSegment &	operator= (const CEventSegment &rhs)
int	operator== (const CEventSegment &rhs) const
int	operator!= (const CEventSegment &rhs) const

---

Detailed Description

Abstract base class for event segments. An event segment is responsible for managing, and reading the hardware associated with a chunk of an event. Event segments allow the user to build the readout system. Users will need to subclass this in general to make use of it, however there are two concrete pre-defined subclasses:

• CTraditionalEventSegment - Allows a single old mash style readout program to exist as a segment.
• CCompoundEventSegment - Allows a set of event segements to be composed into a single event segment for organizational or packet nesting purposes. modularly. This has the advantage of allowing experiments to be composed of sub apparatus without cross 'infecting' the readout code associated with each sub apparatus. Event segments do not enforce a packet structure. That must be done by including packets in each event segment, or by writing the subclass of CEventSegment such that it contains a single packet.

Definition at line 308 of file CEventSegment.h.

---

Constructor & Destructor Documentation

CEventSegment::CEventSegment (    )  [inline]

Default constructor. Definition at line 315 of file CEventSegment.h.

virtual CEventSegment::~CEventSegment (    )  [inline, virtual]

Destructor. Definition at line 316 of file CEventSegment.h.

CEventSegment::CEventSegment (  const CEventSegment &    rhs )  [inline, private]

Copy constructor. Definition at line 318 of file CEventSegment.h.

---

Member Function Documentation

virtual void CEventSegment::Clear (    )  [pure virtual]

Implemented in CCompoundEventSegment, CTraditionalEventSegment, MySegment, and CCountingEventSegment.

virtual void CEventSegment::Initialize (    )  [pure virtual]

Implemented in CCompoundEventSegment, CTraditionalEventSegment, MySegment, and CCountingEventSegment.

virtual unsigned int CEventSegment::MaxSize (    )  [pure virtual]

Implemented in CCompoundEventSegment, CTraditionalEventSegment, MySegment, and CCountingEventSegment.

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

Reimplemented in CCountingEventSegment.

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

Reimplemented in CCountingEventSegment.

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

Reimplemented in CCountingEventSegment.

virtual DAQWordBufferPtr& CEventSegment::Read (  DAQWordBufferPtr &    rBuffer )  [pure virtual]

Implemented in CCompoundEventSegment, CTraditionalEventSegment, MySegment, Hierarchy, and CCountingEventSegment.

---

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

• CEventSegment.h

---