LATdatagramIterator Class Reference

Class for iterating over a list of LATdatagrams. More...

#include <LATdatagramIterator.h>

Inheritance diagram for LATdatagramIterator:

[legend]Collaboration diagram for LATdatagramIterator:

[legend]List of all members.

Public Types
enum	{ ERR_IDmismatch = 1 }
Public Member Functions
	LATdatagramIterator (LATdatagram *start, LATdatagram *end)
	Constructor for iterating over a list of datagrams.
	LATdatagramIterator ()
	Default constructor for iterating over a list of datagrams.
unsigned	iterate ()
	Iterate over a list of LATdatagrams from start to end.
unsigned	iterate (LATdatagram *start, LATdatagram *end)
	Iterate over a list of LATdatagrams from start to end.
LATdatagram *	start () const
LATdatagram *	end () const
int	status () const
virtual int	handleError (LATdatagram *datagram, unsigned code, unsigned p1=0, unsigned p2=0) const
	Handle all errors possible in LATdatagramIterator.
virtual int	process (LATdatagram *)=0

---

Detailed Description

Class for iterating over a list of LATdatagrams.

Author:

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

Revision

1.6

Date:

March 14, 2003 -- Created

Id

LATdatagramIterator.h,v 1.6 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

LATdatagramIterator::LATdatagramIterator (  LATdatagram *  start, LATdatagram *  end )  [inline]

Constructor for iterating over a list of datagrams. This constructor caches the start and end pointers of the list provided by the caller. Parameters: start  A pointer to the start of a LATdatagram list end  A pointer to the end of a LATdatagram list

---

Member Function Documentation

LATdatagram * LATdatagramIterator::end (   )  const [inline]

Return the cached pointer to the end of the LATdatagram list

int LATdatagramIterator::handleError (  LATdatagram *  datagram, unsigned  code, unsigned  p1 = 0, unsigned  p2 = 0 )  const [virtual]

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

unsigned LATdatagramIterator::iterate (  LATdatagram *  start, LATdatagram *  end )

Iterate over a list of LATdatagrams from start to end. Parameters: start  The start of the LATdatagram list end  The end of the LAT datagram list Returns: The number of LATdatagrams handled

unsigned LATdatagramIterator::iterate (   )  [inline]

Iterate over a list of LATdatagrams from start to end. This method uses the LATdatagram list parameters cached at construction time. Returns: The number of LATdatagrams handled

virtual int LATdatagramIterator::process (  LATdatagram *   )  [pure virtual]

Virtual method for calling the application back with a LATdatagram Implemented in LDBI_LATdatagramIterator.

LATdatagram * LATdatagramIterator::start (   )  const [inline]

Return the cached pointer to the start of the LATdatagram list

int LATdatagramIterator::status (   )  const [inline]

Return the completion status from the iteration

---

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

• LATdatagramIterator.h
• LATdatagramIterator.cpp

---