AEMcontributionIterator Class Reference

Class for iterating over contributions to an AEMcontribution. More...

#include <AEMcontributionIterator.h>

Collaboration diagram for AEMcontributionIterator:

[legend]List of all members.

Public Types
	ERR_TooManyPhas = 1
enum	{ ERR_TooManyPhas = 1 }
Public Member Functions
	AEMcontributionIterator (EBFevent *, AEMcontribution *, ACDmap *)
	Constructor for iterating over the ACD contribution.
	AEMcontributionIterator (EBFevent *, AEMcontribution *)
	Constructor for iterating over the ACD contribution.
	AEMcontributionIterator (ACDmap *)
	Constructor for setting up the electronic space to detector space map.
	AEMcontributionIterator ()
	Do nothing constructor.
unsigned	iterate ()
	Iterate over the ACD contribution.
unsigned	iterate (EBFevent *, AEMcontribution *)
	Iterate over the ACD contribution.
unsigned	iterate (EBFevent *, AEMcontribution *, ACDmap *)
	Iterate over the ACD contribution.
virtual int	handleError (AEMcontribution *, unsigned code, unsigned p1=0, unsigned p2=0) const
	Handle all errors possible in AEMcontributionIterator.
const EBFevent *	event () const
const AEMcontribution *	contribution () const
const ACDmap *	map () const
virtual void	header (unsigned cable, AEMheader hdr)=0
	Pure virtual method for calling the application back with an ACD cable header.
virtual void	pha (unsigned cable, unsigned channel, ACDpha pha)=0
	Pure virtual method for calling the application back with an ACD PHA object.

---

Detailed Description

Class for iterating over contributions to an AEMcontribution.

Author:

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

Revision

1.8

Date:

January 27, 2004 -- Created

Id

AEMcontributionIterator.h,v 1.8 2005/03/15 18:59:37 panetta Exp

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

---

Constructor & Destructor Documentation

AEMcontributionIterator::AEMcontributionIterator	(	EBFevent *	event,
		AEMcontribution *	contribution,
		ACDmap *	map
	)			[inline]

Constructor for iterating over the ACD 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

AEMcontributionIterator::AEMcontributionIterator	(	EBFevent *	event,
		AEMcontribution *	contribution
	)			[inline]

Constructor for iterating over the ACD 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

---

Member Function Documentation

const AEMcontribution* AEMcontributionIterator::contribution

(

)

const [inline]

Return a pointer to the start of this contribution

const EBFevent* AEMcontributionIterator::event

(

)

const [inline]

Return a pointer to the EBFevent containing this contribution

int AEMcontributionIterator::handleError	(	AEMcontribution *	contribution,
		unsigned	code,
		unsigned	p1 = 0,
		unsigned	p2 = 0
	)			const [virtual]

Handle all errors possible in AEMcontributionIterator.

This method is used to handle errors occurring during the iteration over an AEMcontribution. 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

virtual void AEMcontributionIterator::header	(	unsigned	cable,
		AEMheader	hdr
	)			[pure virtual]

Pure virtual method for calling the application back with an ACD cable header.

Parameters:

	cable	- The physical cable header came from
	hdr	- The header object

unsigned AEMcontributionIterator::iterate	(	EBFevent *	event,
		AEMcontribution *	contribution,
		ACDmap *	map
	)			[inline]

Iterate over the ACD contribution.

This method calls the header() virtual function for each cable contribution encountered and the pha() virtual function with every hit it finds.

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 cable contributions seen.

unsigned AEMcontributionIterator::iterate	(	EBFevent *	event,
		AEMcontribution *	contribution
	)			[inline]

Iterate over the ACD contribution.

This method calls the header() virtual function for each cable contribution encountered and the pha() virtual function 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 cable contributions seen.

unsigned AEMcontributionIterator::iterate

(

)

[inline]

Iterate over the ACD contribution.

This method calls the header() virtual function for each cable contribution encountered and the pha() virtual function with every hit it finds. This method uses the event, contribution and map established by the ctor.

Returns:

The number of cable contributions seen.

const ACDmap* AEMcontributionIterator::map

(

)

const [inline]

Return a pointer to the ACD map

virtual void AEMcontributionIterator::pha	(	unsigned	cable,
		unsigned	channel,
		ACDpha	pha
	)			[pure virtual]

Pure virtual method for calling the application back with an ACD PHA object.

Parameters:

	cable	- The physical cable PHA value came from
	channel	- The physical channel the PHA value came from
	pha	- The PHA object

---

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

• AEMcontributionIterator.h
• AEMcontributionIterator.cpp

---