---

CCompoundEventSegment Class Reference

#include <CCompoundEventSegment.h>

Inheritance diagram for CCompoundEventSegment:

List of all members.

Public Types
typedef list< CEventSegment * >	EventSegmentList
Public Methods
	CCompoundEventSegment ()
	Default constructor.
	~CCompoundEventSegment ()
	Destructor.
EventSegmentList	getEventSegments () const
virtual void	Initialize ()
virtual DAQWordBufferPtr &	Read (DAQWordBufferPtr &rBuffer)
virtual void	Clear ()
virtual unsigned int	MaxSize ()
void	AddSegment (CEventSegment *pSegment)
void	DeleteSegment (CEventSegment *pSegment)
void	DeleteSegment (EventSegmentList::iterator pItem)
EventSegmentList::iterator	begin () const
EventSegmentList::iterator	end () const
int	size () const
Private Methods
	CCompoundEventSegment (const CCompoundEventSegment &rhs)
	Copy constructor.
CCompoundEventSegment &	operator= (const CCompoundEventSegment &rhs)
	Assignment.
int	operator== (const CCompoundEventSegment &rhs) const
	Comparison for equality.
int	operator!= (const CCompoundEventSegment &rhs) const
Private Attributes
EventSegmentList	m_Segments

---

Detailed Description

Represents an event segment which is a list of other event segments. This allows segments to be grouped either for organizational purposes or for the purposes of packet nesting.

Definition at line 306 of file CCompoundEventSegment.h.

---

Member Typedef Documentation

typedef list<CEventSegment*> CCompoundEventSegment::EventSegmentList

Definition at line 309 of file CCompoundEventSegment.h. Referenced by getEventSegments().

---

Constructor & Destructor Documentation

CCompoundEventSegment::CCompoundEventSegment (    )

Default constructor. Default constructor. This is called when declarations of the form e.g.: CCompoundEventSegment object; are performed. Definition at line 289 of file CCompoundEventSegment.cpp.

CCompoundEventSegment::~CCompoundEventSegment (    )  [inline]

Destructor. Definition at line 317 of file CCompoundEventSegment.h.

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

Copy constructor.

---

Member Function Documentation

void CCompoundEventSegment::AddSegment (  CEventSegment *    pSegment )

Add an event segment to the compound segment. The event segment is added at the end of the event. Parameters: pSegment  - Pointer to the segment to add to the list. Definition at line 370 of file CCompoundEventSegment.cpp. References m_Segments. Referenced by CExperiment::AddEventSegment(), and CExperiment::CExperiment().

CCompoundEventSegment::EventSegmentList::iterator CCompoundEventSegment::begin (    )  const

Return an iterator to the start of the event segment list. Definition at line 405 of file CCompoundEventSegment.cpp. References m_Segments.

void CCompoundEventSegment::Clear (    )  [virtual]

Clear the hardware associated with this event. Implements CEventSegment. Definition at line 338 of file CCompoundEventSegment.cpp. References m_Segments. Referenced by CExperiment::ReadEvent(), and CExperiment::Start().

void CCompoundEventSegment::DeleteSegment (  EventSegmentList::iterator    pItem )

Deletes a segment given an iterator to the segment inside the event segment list. Parameters: pItem  Iterator to the item to delete. Definition at line 397 of file CCompoundEventSegment.cpp. References m_Segments.

void CCompoundEventSegment::DeleteSegment (  CEventSegment *    pSegment )

Deletes a segement from the list given a pointer to the segment. Parameters: -  pSegment Pointer to the segment to delete. Exceptions: CNoSuchobjectException  is thrown if the segment is not in the list. Definition at line 381 of file CCompoundEventSegment.cpp. References m_Segments. Referenced by CExperiment::RemoveEventSegment().

CCompoundEventSegment::EventSegmentList::iterator CCompoundEventSegment::end (    )  const

Return an iterator to the end of the event segment list. Definition at line 413 of file CCompoundEventSegment.cpp. References m_Segments.

EventSegmentList CCompoundEventSegment::getEventSegments (    )  const [inline]

Definition at line 329 of file CCompoundEventSegment.h. References EventSegmentList, and m_Segments.

void CCompoundEventSegment::Initialize (    )  [virtual]

Initialize the event readout. Implements CEventSegment. Definition at line 302 of file CCompoundEventSegment.cpp. References m_Segments. Referenced by CExperiment::Start().

unsigned int CCompoundEventSegment::MaxSize (    )  [virtual]

Return the maximum number of words of data this segment can read out. Implements CEventSegment. Definition at line 354 of file CCompoundEventSegment.cpp. References m_Segments.

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

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

Assignment.

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

Comparison for equality.

DAQWordBufferPtr & CCompoundEventSegment::Read (  DAQWordBufferPtr &    rBuffer )  [virtual]

Read the segment of the event for which this class is responsible. Parameters: rBuffer  - Buffer into which the data should be read in. Returns: 'Pointer' to the next free word of the buffer. Implements CEventSegment. Reimplemented in Hierarchy. Definition at line 321 of file CCompoundEventSegment.cpp. References m_Segments. Referenced by Hierarchy::Read(), and CExperiment::ReadEvent().

int CCompoundEventSegment::size (    )  const

Return the number of segments in the list. Definition at line 421 of file CCompoundEventSegment.cpp. References m_Segments. Referenced by CExperiment::ReadEvent().

---

Member Data Documentation

EventSegmentList CCompoundEventSegment::m_Segments [private]

Definition at line 312 of file CCompoundEventSegment.h. Referenced by AddSegment(), begin(), Clear(), DeleteSegment(), end(), getEventSegments(), Initialize(), MaxSize(), Read(), and size().

---

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

• CCompoundEventSegment.h
• CCompoundEventSegment.cpp

---