ASCcontributionIterator Class Reference

Class for iterating over the parts of an ASCcontribution. More...

#include <ASCcontributionIterator.h>

Collaboration diagram for ASCcontributionIterator:

[legend]List of all members.

Public Member Functions
	ASCcontributionIterator (ASCcontribution *, ACDmap *)
	Constructor for iterating over the ACD contribution.
	ASCcontributionIterator ()
	Do nothing constructor.
unsigned	iterate ()
	Iterate over the ACD contribution.
unsigned	iterate (ASCcontribution *)
	Iterate over the ACD contribution.
unsigned	iterate (ASCcontribution *, ACDmap *)
	Iterate over the ACD contribution.
virtual int	handleError (ASCcontribution *, unsigned code, unsigned p1=0, unsigned p2=0) const
	Handle all errors possible in ASCcontributionIterator.
ASCcontribution *	contribution () const
const ACDmap *	map () const
virtual void	summary (ASCsummary &summary)=0
	Pure virtual method for calling the application back with an ACSsummary object.
virtual void	cno (ASCcno &cno)=0
	Pure virtual method for calling the application back with an ACDcno object.
virtual void	tiles (ASCtileContribution &tiles)=0
	Pure virtual method for calling the application back with an ACDtileContribution object.
int	status () const

---

Detailed Description

Class for iterating over the parts of an ASCcontribution.

Author:

Eric Charles -- GLAST LAT I&T/SVAC (echarles@slac.stanford.edu)

Revision

1.1

Date:

September 21, 2005 -- Created

Id

ASCcontributionIterator.h,v 1.1 2005/09/28 22:04:13 echarles Exp

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

---

Constructor & Destructor Documentation

ASCcontributionIterator::ASCcontributionIterator	(	ASCcontribution *	contribution,
		ACDmap *	map
	)			[inline]

Constructor for iterating over the ACD contribution.

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

Parameters:

	contribution	A pointer to the contribution to iterate over
	map	A pointer to the electronic space to detector space map

---

Member Function Documentation

virtual void ASCcontributionIterator::cno

(

ASCcno &

cno

)

[pure virtual]

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

Parameters:

cno

- The cno object

ASCcontribution* ASCcontributionIterator::contribution

(

)

const [inline]

Return a pointer to the start of this contribution

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

Handle all errors possible in ASCcontributionIterator.

This method is used to handle errors occurring during the iteration over an ASCcontribution. 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 ASCcontributionIterator::iterate	(	ASCcontribution *	contribution,
		ACDmap *	map
	)			[inline]

Iterate over the ACD contribution.

This method calls the summary(), cno() and tiles() virtual functions for the various parts of the datagram being iterated over

Parameters:

	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 ASCcontributionIterator::iterate

(

ASCcontribution *

contribution

)

[inline]

Iterate over the ACD contribution.

This method calls the summary(), cno() and tiles() virtual functions for the various parts of the datagram being iterated over

Parameters:

contribution

A pointer to the contribution to iterate over

Returns:

The number of cable contributions seen.

unsigned ASCcontributionIterator::iterate

(

)

[inline]

Iterate over the ACD contribution.

This method calls the summary(), cno() and tiles() virtual functions for the various parts of the datagram being iterated over

Returns:

The number of contributions seen.

const ACDmap* ASCcontributionIterator::map

(

)

const [inline]

Return a pointer to the ACD map

int ASCcontributionIterator::status

(

)

const [inline]

Return the status of this iterator

virtual void ASCcontributionIterator::summary

(

ASCsummary &

summary

)

[pure virtual]

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

Parameters:

summary

- The summary object

virtual void ASCcontributionIterator::tiles

(

ASCtileContribution &

tiles

)

[pure virtual]

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

Parameters:

tiles

- The tile contribution object

---

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

• ASCcontributionIterator.h
• ASCcontributionIterator.cpp

---