EBFcontributionIterator Class Reference

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

#include <EBFcontributionIterator.h>

Inheritance diagram for EBFcontributionIterator:

[legend]Collaboration diagram for EBFcontributionIterator:

[legend]List of all members.

Public Types
enum	{   ERR_NumContributions = 1, ERR_PastEnd = 2, ERR_ZeroLength = 3, ERR_PacketError = 4,   ERR_NoMap = 5 }
Public Member Functions
	EBFcontributionIterator (EBFevent *event)
	Constructor for iterating over EBFcontributions.
	EBFcontributionIterator ()
	Default constructor for iterating over EBFcontributions.
unsigned	iterate ()
	Iterate over the EBF contributions in an event.
unsigned	iterate (EBFevent *event)
	Class for iterating over a EBF event contributions Iterate over the EBF contributions in an event.
const EBFevent *	event () const
int	status () const
virtual int	handleError (EBFevent *event, unsigned code, unsigned p1=0, unsigned p2=0) const
	Handle all errors possible in EBFcontributionIterator.
virtual int	GEM (EBFevent *, EBFcontribution *)=0
virtual int	GLT (EBFevent *, EBFcontribution *)=0
virtual int	AEM (EBFevent *, EBFcontribution *)=0
virtual int	TEM (EBFevent *, EBFcontribution *)=0
virtual int	OSW (EBFevent *, EBFcontribution *)=0
virtual int	UDF (EBFevent *, EBFcontribution *)=0

---

Detailed Description

Class for iterating over contributions to an EBFevent.

Author:

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

Revision

1.8

Date:

January 23, 2003 -- Created

Id

EBFcontributionIterator.h,v 1.8 2005/03/16 03:00:52 panetta Exp

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

---

Constructor & Destructor Documentation

EBFcontributionIterator::EBFcontributionIterator (  EBFevent *  event  )  [inline]

Constructor for iterating over EBFcontributions. This constructor caches the event provided by the caller. Parameters: event  A pointer to an EBFevent

---

Member Function Documentation

virtual int EBFcontributionIterator::AEM (  EBFevent *  , EBFcontribution *  )  [pure virtual]

AEM contribution handler Implemented in LATcomponentIterator.

const EBFevent * EBFcontributionIterator::event (   )  const [inline]

Return a pointer to the EBFevent containing this contribution

virtual int EBFcontributionIterator::GEM (  EBFevent *  , EBFcontribution *  )  [pure virtual]

GEM contribution handler Implemented in LATcomponentIterator.

virtual int EBFcontributionIterator::GLT (  EBFevent *  , EBFcontribution *  )  [pure virtual]

GLT contribution handler Implemented in LATcomponentIterator.

int EBFcontributionIterator::handleError (  EBFevent *  event, unsigned  code, unsigned  p1 = 0, unsigned  p2 = 0 )  const [virtual]

Handle all errors possible in EBFcontributionIterator. This method is used to handle errors occurring during the iteration over an EBFcontribution. By default it does nothing, however it is virtual and is able to be overridden by the user. Parameters: event  The event in error code  The error code p1  a parameter associated with the error code p2  a parameter associated with the error code Reimplemented in LATcomponentIterator.

unsigned EBFcontributionIterator::iterate (  EBFevent *  event  )

Class for iterating over a EBF event contributions Iterate over the EBF contributions in an event. This method calls back a virtual contribution handlers for each contribution it finds. Which handler is called back is determined by the contribution source ID and the _map method. Contribution handlers take the event and the contribution as arguments. Parameters: event  A pointer to the EBFevent to be iterated over Returns: The number of contributions handled. Reimplemented in LATcomponentIterator.

unsigned EBFcontributionIterator::iterate (   )  [inline]

Iterate over the EBF contributions in an event. This method uses the event cached by the ctor. Returns: The number of contributions handled.

virtual int EBFcontributionIterator::OSW (  EBFevent *  , EBFcontribution *  )  [pure virtual]

OSW (Online SoftWare) contribution handler Implemented in LATcomponentIterator.

int EBFcontributionIterator::status (   )  const [inline]

Return the iteration status code

virtual int EBFcontributionIterator::TEM (  EBFevent *  , EBFcontribution *  )  [pure virtual]

TEM contribution handler Implemented in LATcomponentIterator.

virtual int EBFcontributionIterator::UDF (  EBFevent *  , EBFcontribution *  )  [pure virtual]

Undefined contribution handler Implemented in LATcomponentIterator.

---

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

• EBFcontributionIterator.h
• EBFcontributionIterator.cpp

---