TKRcontributionIterator Class Reference

Class for iterating over contributions to a TKRcontribution. More...

#include <TKRcontributionIterator.h>

Collaboration diagram for TKRcontributionIterator:

Collaboration graph
[legend]
List of all members.

Public Types

 ERR_WrongOrder = 1
 ERR_PastEnd = 2
 iterateStrips() was not called before iterateTOTs()
enum  { ERR_WrongOrder = 1, ERR_PastEnd = 2 }

Public Member Functions

 TKRcontributionIterator (EBFevent *, TKRcontribution *, TKRmap *)
 Constructor for iterating over the tracker contribution.
 TKRcontributionIterator (EBFevent *, TKRcontribution *)
 Constructor for iterating over the tracker contribution.
 TKRcontributionIterator (TKRmap *)
 Constructor for setting up the electronic space to detector space map.
 TKRcontributionIterator ()
 Do nothing constructor.
unsigned iterateStrips ()
 Iterate over tracker strip data.
unsigned iterateStrips (EBFevent *, TKRcontribution *)
 Iterate over tracker strip hits.
unsigned iterateStrips (EBFevent *, TKRcontribution *, TKRmap *)
 Class for iterating over contributions to a TKR contributionIterate over tracker strip hits. This method calls the strip() virtual function back with every strip hit it finds. Strip data _must_ be iterated over before TOTs can be iterated over. This method uses the event and contribution provided by the caller and the map established by the caller.
unsigned iterateTOTs ()
 Iterate over tracker TOT data.
unsigned iterateTOTs (TKRcontribution *)
 Iterate over tracker TOT data.
unsigned iterateTOTs (TKRcontribution *, TKRmap *)
 Iterate over tracker TOT data.
virtual int handleError (TKRcontribution *, unsigned code, unsigned p1=0, unsigned p2=0) const
 Handle all errors possible in TKRcontributionIterator.
const EBFevent * event () const
const TKRcontribution * contribution () const
const TKRmap * map () const
const unsigned stripCount () const
 Return the number of strip hits found by TKRcontributionIterator::iterateStrips().
const unsigned diagnostic () const
 Return the start of the diagnostic data.
const unsigned error () const
 Return the start of the error data.
virtual void strip (unsigned tower, unsigned layerEnd, unsigned hit)=0
 Pure virtual method for calling the application back with a tracker strip hit value.
virtual void TOT (unsigned tower, unsigned layerEnd, unsigned tot)=0
 Pure virtual method for calling the application back with a tracker TOT value.
const void endTots (unsigned offset)

Detailed Description

Class for iterating over contributions to a TKRcontribution.

Author:
R. Claus -- GLAST LAT I&T/Online - (claus@slac.stanford.edu)
Revision
1.15
Date:
January 27, 2003 -- Created
Id
TKRcontributionIterator.h,v 1.15 2006/02/10 22:13:30 claus Exp

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

Member Enumeration Documentation

anonymous enum

Enumerator:
ERR_PastEnd  iterateStrips() was not called before iterateTOTs()

Constructor & Destructor Documentation

TKRcontributionIterator::TKRcontributionIterator ( EBFevent *  event,
TKRcontribution *  contribution,
TKRmap *  map 
) [inline]

Constructor for iterating over the tracker contribution.

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

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

TKRcontributionIterator::TKRcontributionIterator ( EBFevent *  event,
TKRcontribution *  contribution 
) [inline]

Constructor for iterating over the tracker contribution.

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

Parameters:
event A pointer to the EBFevent containing the contribution
contribution A pointer to the contribution to iterate over

Member Function Documentation

const TKRcontribution* TKRcontributionIterator::contribution (  )  const [inline]

Return a pointer to the start of this contribution

const unsigned TKRcontributionIterator::diagnostic (  )  const [inline]

Return the start of the diagnostic data.

Returns:
The start of the diagnostic data

const void TKRcontributionIterator::endTots ( unsigned  offset  )  [inline]

Set the byte offset from the start of the TKRcontribution at which the TOT data ends

const unsigned TKRcontributionIterator::error (  )  const [inline]

Return the start of the error data.

Returns:
The start of the error data

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

Return a pointer to the EBFevent containing this contribution

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

Handle all errors possible in TKRcontributionIterator.

This method is used to handle errors occurring during the iteration over an TKRcontribution. 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 TKRcontributionIterator::iterateStrips ( EBFevent *  event,
TKRcontribution *  contribution,
TKRmap *  map 
)

Class for iterating over contributions to a TKR contributionIterate over tracker strip hits. This method calls the strip() virtual function back with every strip hit it finds. Strip data _must_ be iterated over before TOTs can be iterated over. This method uses the event and contribution provided by the caller and the map established by the caller.

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 strips handled

unsigned TKRcontributionIterator::iterateStrips ( EBFevent *  event,
TKRcontribution *  contribution 
) [inline]

Iterate over tracker strip hits.

This method calls the strip() virtual function back with every strip hit it finds. Strip data _must_ be iterated over before TOTs can be iterated over. This method uses the event and contribution provided by the caller and the map established by the ctor.

Parameters:
event A pointer to the EBFevent containing the contribution
contribution A pointer to the contribution to iterate over
Returns:
The number of strips handled

unsigned TKRcontributionIterator::iterateStrips (  )  [inline]

Iterate over tracker strip data.

This method calls the strip() virtual function back with every strip it finds. This method uses the event, contribution and map established by the ctor.

Returns:
The number of strips handled

unsigned TKRcontributionIterator::iterateTOTs ( TKRcontribution *  contribution,
TKRmap *  map 
)

Iterate over tracker TOT data.

This method calls the TOT() virtual function back with every TOT datum it finds. Strip data _must_ be iterated over before TOTs can be iterated over in order to find where the TOT data begins. This method uses the 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
Returns:
The number of TOTs handled

unsigned TKRcontributionIterator::iterateTOTs ( TKRcontribution *  contribution  )  [inline]

Iterate over tracker TOT data.

This method calls the TOT() virtual function back with every TOT datum it finds. Strip data _must_ be iterated over before TOTs can be iterated over in order to find where the TOT data begins. This method uses the contribution provided by the caller and the map established by the ctor.

Parameters:
contribution A pointer to the contribution to iterate over
Returns:
The number of TOTs handled

unsigned TKRcontributionIterator::iterateTOTs (  )  [inline]

Iterate over tracker TOT data.

This method calls the TOT() virtual function back with every TOT datum it finds. Strip data _must_ be iterated over before TOTs can be iterated over in order to find where the TOT data begins. This method uses the contribution and map established by the ctor.

Returns:
The number of TOTs handled

const TKRmap* TKRcontributionIterator::map (  )  const [inline]

Return a pointer to the tracker map

virtual void TKRcontributionIterator::strip ( unsigned  tower,
unsigned  layerEnd,
unsigned  hit 
) [pure virtual]

Pure virtual method for calling the application back with a tracker strip hit value.

Parameters:
tower - The tower (in detector space) the strip hit came from
layerEnd - The layer-end (in detector space) the strip hit came from
hit - The strip hit value

const unsigned TKRcontributionIterator::stripCount (  )  const [inline]

Return the number of strip hits found by TKRcontributionIterator::iterateStrips().

Returns:
The number of strip hits found by TKRcontributionIterator::iterateStrips()

virtual void TKRcontributionIterator::TOT ( unsigned  tower,
unsigned  layerEnd,
unsigned  tot 
) [pure virtual]

Pure virtual method for calling the application back with a tracker TOT value.

Parameters:
tower - The tower (in detector space) the TOT came from
layerEnd - The layer-end (in detector space) the TOT came from
tot - The TOT value

The documentation for this class was generated from the following files:
Generated on Mon Jul 31 17:48:21 2006 for LDF v06-02-00 by doxygen 1.4.7