CALcontributionIterator Class Reference

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

#include <CALcontributionIterator.h>

Collaboration diagram for CALcontributionIterator:

[legend]List of all members.

Public Member Functions
	CALcontributionIterator (EBFevent *, CALcontribution *, CALmap *)
	Constructor for iterating over the calorimeter contribution.
	CALcontributionIterator (EBFevent *, CALcontribution *)
	Constructor for iterating over the calorimeter contribution.
	CALcontributionIterator (CALmap *)
	Constructor for setting up the electronic space to detector space map.
	CALcontributionIterator ()
	Do nothing constructor.
unsigned	iterate ()
	Iterate over the calorimeter contribution.
unsigned	iterate (EBFevent *, CALcontribution *)
	Iterate over the calorimeter contribution.
unsigned	iterate (EBFevent *, CALcontribution *, CALmap *)
	Class for iterating over contributions to a CAL contribution.Iterate over the calorimeter contribution.
virtual int	handleError (CALcontribution *, unsigned code, unsigned p1=0, unsigned p2=0) const
	Handle all errors possible in CALcontributionIterator.
const EBFevent *	event () const
const CALcontribution *	contribution () const
unsigned	CALend () const
const CALmap *	map () const
virtual void	log (unsigned tower, unsigned layer, CALlog log)=0
	Pure virtual method for calling the application back with a CAL log value.

---

Detailed Description

Class for iterating over contributions to a CALcontribution.

Author:

Jim Panetta -- GLAST LAT I&T/Online - (panetta@slac.stanford.edu)

Revision

1.8

Date:

July 17, 2003 -- Created

Id

CALcontributionIterator.h,v 1.8 2005/03/15 18:59:38 panetta Exp

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

---

Constructor & Destructor Documentation

CALcontributionIterator::CALcontributionIterator	(	EBFevent *	event,
		CALcontribution *	contribution,
		CALmap *	map
	)			[inline]

Constructor for iterating over the calorimeter contribution.

This constructor caches the event, contribution and map provided by the caller.

Parameters:

	event	A pointer to the EBFevent containing the contribution
	contribution	A pointer to the contribution to iterate over
	map	A pointer to the electronic space to detector space map

CALcontributionIterator::CALcontributionIterator	(	EBFevent *	event,
		CALcontribution *	contribution
	)			[inline]

Constructor for iterating over the calorimeter contribution.

This constructor caches the event and contribution provided by the caller.

Parameters:

	event	A pointer to the EBFevent containing the contribution
	contribution	A pointer to the contribution to iterate over

CALcontributionIterator::CALcontributionIterator

(

CALmap *

map

)

[inline]

Constructor for setting up the electronic space to detector space map.

Parameters:

map

A pointer to the electronic space to detector space map

---

Member Function Documentation

unsigned CALcontributionIterator::CALend

(

)

const [inline]

Return the offset to the end of the CAL portion of the contribution

const CALcontribution* CALcontributionIterator::contribution

(

)

const [inline]

Return a pointer to the start of this contribution

const EBFevent* CALcontributionIterator::event

(

)

const [inline]

Return a pointer to the EBFevent containing this contribution

int CALcontributionIterator::handleError	(	CALcontribution *	,
		unsigned	code,
		unsigned	p1 = 0,
		unsigned	p2 = 0
	)			const [inline, virtual]

Handle all errors possible in CALcontributionIterator.

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

Parameters:

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

unsigned CALcontributionIterator::iterate	(	EBFevent *	event,
		CALcontribution *	contribution,
		CALmap *	map
	)

Class for iterating over contributions to a CAL contribution.Iterate over the calorimeter contribution.

This method calls the log() virtual function back with every hit it finds. This method uses the event, contribution and map provided by the caller.

Parameters:

	event	A pointer to the EBFevent containing the contribution
	contribution	A pointer to the contribution to iterate over
	map	A pointer to the electronic space to detector space map

Returns:

The number of logs handled.

unsigned CALcontributionIterator::iterate	(	EBFevent *	event,
		CALcontribution *	contribution
	)			[inline]

Iterate over the calorimeter contribution.

This method calls the log() virtual function back with every hit it finds. This method uses the event and contribution provided by the caller and the map established by the ctor.

Parameters:

	event	A pointer to the EBFevent containing the contribution
	contribution	A pointer to the contribution to iterate over

Returns:

The number of logs handled.

unsigned CALcontributionIterator::iterate

(

)

[inline]

Iterate over the calorimeter contribution.

This method calls the log() virtual function back with every hit it finds. This method uses the event, contribution and map established by the ctor.

Returns:

The number of logs handled.

virtual void CALcontributionIterator::log	(	unsigned	tower,
		unsigned	layer,
		CALlog	log
	)			[pure virtual]

Pure virtual method for calling the application back with a CAL log value.

Parameters:

	tower	- The tower (in detector space) the log value came from
	layer	- The layer (in detector space) the log value came from
	log	- The log object

const CALmap* CALcontributionIterator::map

(

)

const [inline]

Return a pointer to the calorimeter map

---

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

• CALcontributionIterator.h
• CALcontributionIterator.cpp

---