Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

ERRcontributionIterator Class Reference

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

#include <ERRcontributionIterator.h>

Collaboration diagram for ERRcontributionIterator:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ERRcontributionIterator (EBFevent *event, TEMcontribution *contribution, TWRmap *map)
 ERRcontributionIterator constructor initializing the class according to the passed in parameters.
 ERRcontributionIterator (EBFevent *event, TEMcontribution *contribution)
 ERRcontributionIterator constructor initializing the class according to the passed in parameters.
virtual int handleError (TEMcontribution *contribution, unsigned code, unsigned p1=0, unsigned p2=0) const
 Handle all errors possible in ERRcontributionIterator.
 ERRcontributionIterator ()
 ERRcontributionIterator constructor initializing the class to an invalid state.
unsigned iterate ()
 Iterate over error contributions.
unsigned iterate (EBFevent *event, TEMcontribution *contribution)
 Iterate over error contributions.
unsigned iterate (EBFevent *event, TEMcontribution *contribution, TWRmap *map)
 Iterate over error contributions.
const EBFevent * event () const
const TEMcontribution * contribution () const
const TWRmap * map () const
int status () const
unsigned size () const
void offset (unsigned o)
 Set the offset into the TEM contribution where the diagnostic data starts.
const ErrorSummary theError ()
virtual int gcccError (unsigned tower, unsigned gccc, GCCCerror err)
 Dispatch function for GCCC errors.
virtual int gtccError (unsigned tower, unsigned gtcc, GTCCerror err)
 Dispatch function for GTCC errors.
virtual int phaseError (unsigned tower, unsigned short err)
 Dispatch function for cable phase errors.
virtual int timeoutError (unsigned tower, unsigned short err)
 Dispatch function for cable timeout errors.
virtual int gtrcPhaseError (unsigned tower, unsigned gtcc, unsigned gtrc, GTRCerror err)
 Dispatch function for GTCC "GTRC phase error" errors.
virtual int gtfePhaseError (unsigned tower, unsigned gtcc, unsigned gtrc, unsigned short err1, unsigned short err2, unsigned short err3, unsigned short err4, unsigned short err5)
 Dispatch function for GTCC "GTFE phase error" errors.
virtual int gtccFIFOerror (unsigned tower, unsigned gtcc, unsigned short err)
 Dispatch function for GTCC "FIFO full error" errors.
virtual int gtccTMOerror (unsigned tower, unsigned gtcc)
 Dispatch function for GTCC "cable timeout error" errors.
virtual int gtccHDRParityError (unsigned tower, unsigned gtcc)
 Dispatch function for GTCC "header parity error" errors.
virtual int gtccWCParityError (unsigned tower, unsigned gtcc)
 Dispatch function for GTCC "word count parity error" errors.
virtual int gtrcSummaryError (unsigned tower, unsigned gtcc)
 Dispatch function for GTCC "GTRC summary error" errors.
virtual int gtccDataParityError (unsigned tower, unsigned gtcc)
 Dispatch function for GTCC "data parity error" errors.

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.7
Date:
November 25, 2003 -- Created
Id
ERRcontributionIterator.h,v 1.7 2005/03/15 18:59:39 panetta Exp

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

Constructor & Destructor Documentation

ERRcontributionIterator::ERRcontributionIterator (  EBFevent *  event,
TEMcontribution *  contribution,
TWRmap *  map
)  [inline]
 

ERRcontributionIterator constructor initializing the class according to the passed in parameters.

Parameters:
event - The event containing the error contribution
contribution - The TEM contribution containing the error contribution
map - The electronic space to detector space map for a tower

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

ERRcontributionIterator constructor initializing the class according to the passed in parameters.

Parameters:
event - A pointer to the event containing the error contribution
contribution - A pointer to the TEM contribution containing the error contribution

Member Function Documentation

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

Return a pointer to the start of this contribution

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

Return a pointer to the EBFevent containing this contribution

int ERRcontributionIterator::gcccError (  unsigned  tower,
unsigned  gccc,
GCCCerror  err
)  [inline, virtual]
 

Dispatch function for GCCC errors.

These may be implemented by the user. These are *not* pure virtual because the user doesn't need to always implement them.

Parameters:
tower The remapped tower number
gccc The remapped GCCC number (see _GCCC())
err The error message
Returns:
A status value, which, if non-zero, disables further error callbacks

int ERRcontributionIterator::gtccDataParityError (  unsigned  tower,
unsigned  gtcc
)  [inline, virtual]
 

Dispatch function for GTCC "data parity error" errors.

These may be implemented by the user. These are *not* pure virtual because the user doesn't need to always implement them.

Parameters:
tower The remapped tower number
gtcc The remapped GTCC number (see _GTCC())
Returns:
A status value, which, if non-zero, disables further error callbacks

int ERRcontributionIterator::gtccError (  unsigned  tower,
unsigned  gtcc,
GTCCerror  err
)  [inline, virtual]
 

Dispatch function for GTCC errors.

These may be implemented by the user. These are *not* pure virtual because the user doesn't need to always implement them.

Parameters:
tower The remapped tower number
gtcc The remapped GTCC number (see _GTCC())
err The error message
Returns:
A status value, which, if non-zero, disables further error callbacks

int ERRcontributionIterator::gtccFIFOerror (  unsigned  tower,
unsigned  gtcc,
unsigned short  err
)  [inline, virtual]
 

Dispatch function for GTCC "FIFO full error" errors.

These may be implemented by the user. These are *not* pure virtual because the user doesn't need to always implement them.

Parameters:
tower The remapped tower number
gtcc The remapped GTCC number (see _GTCC())
err The projected word count
Returns:
A status value, which, if non-zero, disables further error callbacks

int ERRcontributionIterator::gtccHDRParityError (  unsigned  tower,
unsigned  gtcc
)  [inline, virtual]
 

Dispatch function for GTCC "header parity error" errors.

These may be implemented by the user. These are *not* pure virtual because the user doesn't need to always implement them.

Parameters:
tower The remapped tower number
gtcc The remapped GTCC number (see _GTCC())
Returns:
A status value, which, if non-zero, disables further error callbacks

int ERRcontributionIterator::gtccTMOerror (  unsigned  tower,
unsigned  gtcc
)  [inline, virtual]
 

Dispatch function for GTCC "cable timeout error" errors.

These may be implemented by the user. These are *not* pure virtual because the user doesn't need to always implement them.

Parameters:
tower The remapped tower number
gtcc The remapped GTCC number (see _GTCC())
Returns:
A status value, which, if non-zero, disables further error callbacks

int ERRcontributionIterator::gtccWCParityError (  unsigned  tower,
unsigned  gtcc
)  [inline, virtual]
 

Dispatch function for GTCC "word count parity error" errors.

These may be implemented by the user. These are *not* pure virtual because the user doesn't need to always implement them.

Parameters:
tower The remapped tower number
gtcc The remapped GTCC number (see _GTCC())
Returns:
A status value, which, if non-zero, disables further error callbacks

int ERRcontributionIterator::gtfePhaseError (  unsigned  tower,
unsigned  gtcc,
unsigned  gtrc,
unsigned short  err1,
unsigned short  err2,
unsigned short  err3,
unsigned short  err4,
unsigned short  err5
)  [inline, virtual]
 

Dispatch function for GTCC "GTFE phase error" errors.

These may be implemented by the user. These are *not* pure virtual because the user doesn't need to always implement them.

Five GTFE tag words for FEphase error. Ugly construction because passing a ushort to Python is hard in SIP. The GTFE tags are supplied in the generated order, i.e. not reversed.

Parameters:
tower The remapped tower number
gtcc The remapped GTCC number (see _GTCC())
gtrc The GTRC number
err1 The first GTFE tag word
err2 The second GTFE tag word
err3 The third GTFE tag word
err4 The fourth GTFE tag word
err5 The fifth GTFE tag word
Returns:
A status value, which, if non-zero, disables further error callbacks

int ERRcontributionIterator::gtrcPhaseError (  unsigned  tower,
unsigned  gtcc,
unsigned  gtrc,
GTRCerror  err
)  [inline, virtual]
 

Dispatch function for GTCC "GTRC phase error" errors.

These may be implemented by the user. These are *not* pure virtual because the user doesn't need to always implement them.

Parameters:
tower The remapped tower number
gtcc The remapped GTCC number (see _GCCC())
gtrc The GTRC number
err A GTRC tag mismatch structure
Returns:
A status value, which, if non-zero, disables further error callbacks

int ERRcontributionIterator::gtrcSummaryError (  unsigned  tower,
unsigned  gtcc
)  [inline, virtual]
 

Dispatch function for GTCC "GTRC summary error" errors.

These may be implemented by the user. These are *not* pure virtual because the user doesn't need to always implement them.

Parameters:
tower The remapped tower number
gtcc The remapped GTCC number (see _GTCC())
Returns:
A status value, which, if non-zero, disables further error callbacks

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

Handle all errors possible in ERRcontributionIterator.

This method is used to handle errors occurring during the iteration over an ERRcontribution. By default it does nothing, however it is virtual and is able to be overridden by the user.

Parameters:
contrib 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 ERRcontributionIterator::iterate (  EBFevent *  event,
TEMcontribution *  contribution,
TWRmap *  map
) 
 

Iterate over error contributions.

Parameters:
event A pointer to the EBFevent containing the contribution
contribution A pointer to the TEMcontribution to iterate over
map A pointer to a tower map
Returns:
The number of contributions handled

unsigned ERRcontributionIterator::iterate (  EBFevent *  event,
TEMcontribution *  contribution
)  [inline]
 

Iterate over error 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 ERRcontributionIterator::iterate (   )  [inline]
 

Iterate over error contributions.

This method uses the cached contribution to interate over.

Returns:
The number of contributions handled

const TWRmap * ERRcontributionIterator::map (   )  const [inline]
 

Return a pointer to the tower map

int ERRcontributionIterator::phaseError (  unsigned  tower,
unsigned short  err
)  [inline, virtual]
 

Dispatch function for cable phase errors.

These may be implemented by the user. These are *not* pure virtual because the user doesn't need to always implement them.

Parameters:
tower The remapped tower number
err The error message
Returns:
A status value, which, if non-zero, disables further error callbacks

unsigned ERRcontributionIterator::size (   )  const [inline]
 

Return the size of the diagnostic contribution

int ERRcontributionIterator::status (   )  const [inline]
 

Return the iteration status code

const ErrorSummary ERRcontributionIterator::theError (   )  [inline]
 

Return the error summary word from the contribution

int ERRcontributionIterator::timeoutError (  unsigned  tower,
unsigned short  err
)  [inline, virtual]
 

Dispatch function for cable timeout errors.

These may be implemented by the user. These are *not* pure virtual because the user doesn't need to always implement them.

Parameters:
tower The remapped tower number
err The error message
Returns:
A status value, which, if non-zero, disables further error callbacks

The documentation for this class was generated from the following files:
Generated on Thu Sep 29 12:13:39 2005 for LDF v05-07-00 by doxygen 1.3.9.1