LATcontributionIterator Class Reference

Class for iterating over components in a LATdatagram. More...

#include <LATcontributionIterator.h>

Inheritance diagram for LATcontributionIterator:

[legend]Collaboration diagram for LATcontributionIterator:

[legend]List of all members.

Public Types
enum	{ ERR_UDFcontribution = 1 }
Public Member Functions
	LATcontributionIterator (LATdatagram *)
	Constructor for iterating over a LATdatagram.
	LATcontributionIterator ()
	Default constructor for iterating over a LATdatagram.
unsigned	iterate ()
	Iterate over the LATcontributions in a LATdatagram.
unsigned	iterate (LATdatagram *)
	Class for iterating over contributions to a LATdatagram Iterate over the LATcontributions in a LATdatagram.
virtual int	handleError (LATcontribution *contrib, unsigned code, unsigned p1=0, unsigned p2=0) const
	Handle all errors possible in LATcontributionIterator.
virtual int	EBF (EBFevent *start, EBFevent *end)=0
virtual int	ASC (ASCcontribution *start, LATcontribution *end)
	Default ASC contribution method.
virtual int	UDF (LATcontribution *start, LATcontribution *end)
	Default undefined contribution method.
const LATdatagram *	datagram () const
int	status () const

---

Detailed Description

Class for iterating over components in a LATdatagram.

Author:

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

Revision

1.5

Date:

March 6, 2003 -- Created

Id

LATcontributionIterator.h,v 1.5 2005/09/28 22:04:13 echarles Exp

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

---

Constructor & Destructor Documentation

LATcontributionIterator::LATcontributionIterator (  LATdatagram *  datagram  )  [inline]

Constructor for iterating over a LATdatagram. This constructor caches the LATdatagram provided by the caller. Parameters: datagram  A pointer to a LATdatagram

---

Member Function Documentation

int LATcontributionIterator::ASC (  ASCcontribution *  start, LATcontribution *  end )  [virtual]

Default ASC contribution method. ASC contribution handler

const LATdatagram * LATcontributionIterator::datagram (   )  const [inline]

Return a pointer to the LATdatagram containing this contribution

virtual int LATcontributionIterator::EBF (  EBFevent *  start, EBFevent *  end )  [pure virtual]

EBFevent contribution handler Implemented in LDBI_LATcontributionIterator.

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

Handle all errors possible in LATcontributionIterator. This method is used to handle errors occurring during the iteration over an LATcontribution. 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 LATcontributionIterator::iterate (  LATdatagram *  datagram  )

Class for iterating over contributions to a LATdatagram Iterate over the LATcontributions in a LATdatagram. Parameters: datagram  - The LATdatagram to iterate over Returns: The number of contributions treated

unsigned LATcontributionIterator::iterate (   )  [inline]

Iterate over the LATcontributions in a LATdatagram. This method uses the datagram cached by the ctor. Returns: The number of contributions handled.

int LATcontributionIterator::status (   )  const [inline]

Return the iteration status code

int LATcontributionIterator::UDF (  LATcontribution *  start, LATcontribution *  end )  [virtual]

Default undefined contribution method. Undefined LATcontribution handler

---

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

• LATcontributionIterator.h
• LATcontributionIterator.cpp

---