TEMcontributionIterator Class Reference

Class for iterating over contributions to a TEMcontribution. More...

#include <TEMcontributionIterator.h>

Inheritance diagram for TEMcontributionIterator:

[legend]Collaboration diagram for TEMcontributionIterator:

[legend]List of all members.

Public Member Functions
	TEMcontributionIterator (EBFevent *, TEMcontribution *)
	Constructor setting up the iterator with an EBFevent and a TEMcontribution.
	TEMcontributionIterator ()
unsigned	iterate ()
	Iterate over the contributions in a cached TEMcontribution.
unsigned	iterate (EBFevent *, TEMcontribution *)
	Class for iterating over contributions to a TEM contributionIterate over the contributions in a TEMcontribution.
virtual int	handleError (TEMcontribution *contribution, unsigned code, unsigned p1=0, unsigned p2=0) const
	Handle all errors possible in TEMcontributionIterator.
virtual int	CAL (EBFevent *event, TEMcontribution *contribution)=0
virtual int	TKR (EBFevent *event, TEMcontribution *contribution)=0
virtual int	diagnostic (EBFevent *event, TEMcontribution *contribution)=0
virtual int	error (EBFevent *event, TEMcontribution *contribution)=0
virtual int	cleanup (EBFevent *event, TEMcontribution *contribution)=0
const EBFevent *	event () const
const TEMcontribution *	contribution () const
unsigned	CALend () const
unsigned	TKRend () const
unsigned	diagnosticEnd () const
unsigned	errorEnd () const
int	status () const
void	CALend (unsigned offset)
	Set the offset to the end of the calorimeter data from the start of the contribution. Counted in bytes.
void	TKRend (unsigned offset)
	Set the offset to the end of the tracker data from the start of the contribution. Counted in bytes.
void	diagnosticEnd (unsigned offset)
	Set the offset to the end of the TEM diagnostic data from the start of the contribution. Counted in bytes.
void	errorEnd (unsigned offset)
	Set the offset to the end of the TEM error data from the start of the contribution. Counted in bytes.

---

Detailed Description

Class for iterating over contributions to a TEMcontribution.

Author:

R. Claus -- GLAST LAT I&T/Online - (claus@slac.stanford.edu)

Revision

1.10

Date:

January 23, 2003 -- Created

Id

TEMcontributionIterator.h,v 1.10 2005/03/15 18:59:41 panetta Exp

Copyright: Copyright 2004 by The Board of Trustees of the Leland Stanford Junior University. All rights reserved.

---

Constructor & Destructor Documentation

TEMcontributionIterator::TEMcontributionIterator	(	EBFevent *	event,
		TEMcontribution *	contribution
	)			[inline]

Constructor setting up the iterator with an EBFevent and a TEMcontribution.

Parameters:

	event	- A pointer to an EBFevent
	contribution	- A pointer to a TEMcontribution in the event

TEMcontributionIterator::TEMcontributionIterator

(

)

[inline]

Default constructor

---

Member Function Documentation

virtual int TEMcontributionIterator::CAL	(	EBFevent *	event,
		TEMcontribution *	contribution
	)			[pure virtual]

CAL contribution handler

Implemented in LATcomponentIterator.

unsigned TEMcontributionIterator::CALend

(

)

const [inline]

Return the offset in bytes to then of the calorimeter data

virtual int TEMcontributionIterator::cleanup	(	EBFevent *	event,
		TEMcontribution *	contribution
	)			[pure virtual]

Clean-up handler

Implemented in LATcomponentIterator.

const TEMcontribution * TEMcontributionIterator::contribution

(

)

const [inline]

Return a pointer to the TEMcontribution being iterated over

virtual int TEMcontributionIterator::diagnostic	(	EBFevent *	event,
		TEMcontribution *	contribution
	)			[pure virtual]

Diagnostic contribution handler

Implemented in LATcomponentIterator.

unsigned TEMcontributionIterator::diagnosticEnd

(

)

const [inline]

Return the offset in bytes to then of the diagnostic data

virtual int TEMcontributionIterator::error	(	EBFevent *	event,
		TEMcontribution *	contribution
	)			[pure virtual]

Error contribution handler

Implemented in LATcomponentIterator.

unsigned TEMcontributionIterator::errorEnd

(

)

const [inline]

Return the offset in bytes to then of the error data

const EBFevent * TEMcontributionIterator::event

(

)

const [inline]

Return a pointer to the EBFevent containing this contribution

int TEMcontributionIterator::handleError	(	TEMcontribution *	contribution,
		unsigned	code,
		unsigned	p1 = 0,
		unsigned	p2 = 0
	)			const [inline, virtual]

Handle all errors possible in TEMcontributionIterator.

This method is used to handle errors occurring during the iteration over an TEMcontribution. By default it does nothing, however it is virtual and is able to be overridden by the user.

Parameters:

	contribution	The contribution in error
	code	The error code
	p1	a parameter associated with the error code
	p2	a parameter associated with the error code

unsigned TEMcontributionIterator::iterate	(	EBFevent *	event,
		TEMcontribution *	contribution
	)

Class for iterating over contributions to a TEM contributionIterate over the contributions in a TEMcontribution.

Parameters:

	event	- The EBFevent containing the TEMcontribution
	contribution	- The TEMcontribution to be iterated over

Returns:

The number of contributions treated

unsigned TEMcontributionIterator::iterate

(

)

[inline]

Iterate over the contributions in a cached TEMcontribution.

Returns:

The number of contributions treated

int TEMcontributionIterator::status

(

)

const [inline]

Return the iteration status code

virtual int TEMcontributionIterator::TKR	(	EBFevent *	event,
		TEMcontribution *	contribution
	)			[pure virtual]

TKR contribution handler

Implemented in LATcomponentIterator.

unsigned TEMcontributionIterator::TKRend

(

)

const [inline]

Return the offset in bytes to then of the tracker data

---

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

• TEMcontributionIterator.h
• TEMcontributionIterator.cpp

---