DIAGcontributionIterator Class Reference

Class for iterating over parts of a Diagnostic contribution. More...

#include <DIAGcontributionIterator.h>

Collaboration diagram for DIAGcontributionIterator:

[legend]List of all members.

Public Member Functions
	DIAGcontributionIterator (EBFevent *event, TEMcontribution *contribution, CALmap *calMap, TKRmap *tkrMap)
	DIAGcontributionIterator constructor initializing the class according to the passed in parameters.
	DIAGcontributionIterator (EBFevent *event, TEMcontribution *contribution)
	DIAGcontributionIterator constructor initializing the class according to the passed in parameters.
virtual int	handleError (TEMcontribution *, unsigned code, unsigned p1=0, unsigned p2=0) const
	Handle all errors possible in DIAGcontributionIterator.
	DIAGcontributionIterator ()
	DIAGcontributionIterator constructor initializing the class to an invalid state.
unsigned	iterateCAL ()
	Iterate over CAL diagnostic contributions.
unsigned	iterateCAL (EBFevent *event, TEMcontribution *contribution)
	Iterate over CAL diagnostic contributions.
unsigned	iterateCAL (EBFevent *event, TEMcontribution *contribution, CALmap *map)
	Iterate over CAL diagnostic contributions.
unsigned	iterateTKR ()
	Iterate over TKR diagnostic contributions.
unsigned	iterateTKR (EBFevent *event, TEMcontribution *contribution)
	Iterate over TKR diagnostic contributions.
unsigned	iterateTKR (EBFevent *event, TEMcontribution *contribution, TKRmap *map)
	Iterate over a TKR diagnostic contribution.
const EBFevent *	event () const
const TEMcontribution *	contribution () const
const CALmap *	calMap () const
const TKRmap *	tkrMap () const
int	status () const
unsigned	size () const
void	offset (unsigned o)
	Set the offset into the TEM contribution where the diagnostic data starts.
virtual int	CALdiag (unsigned tower, unsigned layer, CALdiagnostic diag)
	Non-pure virtual method for calling the application back with CAL diagnostic data.
virtual int	TKRdiag (unsigned tower, unsigned gtcc, TKRdiagnostic diag)
	Non-pure virtual method for calling the application back with TKR diagnostic data.

---

Detailed Description

Class for iterating over parts of a Diagnostic contribution.

Author:

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

Revision

1.8

Date:

November 25, 2003 -- Created

Id

DIAGcontributionIterator.h,v 1.8 2005/03/18 05:20:36 panetta Exp

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

---

Constructor & Destructor Documentation

DIAGcontributionIterator::DIAGcontributionIterator (  EBFevent *  event, TEMcontribution *  contribution, CALmap *  calMap, TKRmap *  tkrMap )  [inline]

DIAGcontributionIterator constructor initializing the class according to the passed in parameters. Parameters: event  - The event containing the DIAG contribution contribution  - The TEM contribution containing the DIAG contribution calMap  - The electronic space to detector space map for CAL tkrMap  - The electronic space to detector space map for TKR

DIAGcontributionIterator::DIAGcontributionIterator (  EBFevent *  event, TEMcontribution *  contribution )  [inline]

DIAGcontributionIterator constructor initializing the class according to the passed in parameters. Parameters: event  - A pointer to the event containing the DIAG contribution contribution  - A pointer to the TEM contribution containing the DIAG contribution

---

Member Function Documentation

int DIAGcontributionIterator::CALdiag (  unsigned  tower, unsigned  layer, CALdiagnostic  diag )  [inline, virtual]

Non-pure virtual method for calling the application back with CAL diagnostic data. If this method is not overridden by the application, it defaults to a do-nothing method. Parameters: tower  - The tower (in detector space) the diagnostic data came from layer  - The layer (in detector space) the diagnostic data came from diag  - The CAL diagnostic object Returns: A status value. If non-zero, iteration is terminated.

const CALmap * DIAGcontributionIterator::calMap (   )  const [inline]

Return a pointer to the CAL map

const TEMcontribution * DIAGcontributionIterator::contribution (   )  const [inline]

Return a pointer to the start of this contribution

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

Return a pointer to the EBFevent containing this contribution

int DIAGcontributionIterator::handleError (  TEMcontribution *  contribution, unsigned  code, unsigned  p1 = 0, unsigned  p2 = 0 )  const [inline, virtual]

Handle all errors possible in DIAGcontributionIterator. This method is used to handle errors occurring during the iteration over an DIAGcontribution. 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 DIAGcontributionIterator::iterateCAL (  EBFevent *  event, TEMcontribution *  contribution, CALmap *  map )

Iterate over CAL diagnostic contributions. This method calls the CALdiag() virtual function back for every CAL diagnostic word. 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 contributions handled

unsigned DIAGcontributionIterator::iterateCAL (  EBFevent *  event, TEMcontribution *  contribution )  [inline]

Iterate over CAL diagnostic contributions. This method iterates over the supplied contribution using the cached map. Parameters: event  A pointer to the EBFevent containing the contribution contribution  A pointer to the contribution to iterate over Returns: The number of contributions handled

unsigned DIAGcontributionIterator::iterateCAL (   )  [inline]

Iterate over CAL diagnostic contributions. This method uses the cached contribution and map to interate over. Returns: The number of contributions handled

unsigned DIAGcontributionIterator::iterateTKR (  EBFevent *  event, TEMcontribution *  contribution, TKRmap *  map )

Iterate over a TKR diagnostic contribution. This method calls the TKRdiag() virtual function back for every TKR diagnostic word. It also defines the end of the diagnostic part of the TEMcontribution 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 contributions handled

unsigned DIAGcontributionIterator::iterateTKR (  EBFevent *  event, TEMcontribution *  contribution )  [inline]

Iterate over TKR diagnostic contributions. This method iterates over the supplied contribution using the cached map. Parameters: event  A pointer to the EBFevent containing the contribution contribution  A pointer to the contribution to iterate over Returns: The number of contributions handled

unsigned DIAGcontributionIterator::iterateTKR (   )  [inline]

Iterate over TKR diagnostic contributions. This method uses the cached contribution and map to interate over. Returns: The number of contributions handled

unsigned DIAGcontributionIterator::size (   )  const [inline]

Return the size of the diagnostic contribution

int DIAGcontributionIterator::status (   )  const [inline]

Return the iteration status code

int DIAGcontributionIterator::TKRdiag (  unsigned  tower, unsigned  gtcc, TKRdiagnostic  diag )  [inline, virtual]

Non-pure virtual method for calling the application back with TKR diagnostic data. If this method is not overridden by the application, it defaults to a do-nothing method. Parameters: tower  - The tower (in detector space) the diagnostic data came from gtcc  - The GTCC (in detector space) the diagnostic data came from diag  - The TKR diagnostic object Returns: A status value. If non-zero, iteration is terminated.

const TKRmap * DIAGcontributionIterator::tkrMap (   )  const [inline]

Return a pointer to the TKR map

---

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

• DIAGcontributionIterator.h
• DIAGcontributionIterator.cpp

---