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

AEMheader Class Reference

Class for accessing fields in the AEM header words. More...

#include <AEMheader.h>

List of all members.

Public Types

enum  { NUM_CABLES = 12, NUM_CHANNELS = 18 }

Public Member Functions

 AEMheader (unsigned short *header)
 Constructor for initializing the class with raw header data.
unsigned startBit () const
 Static method to return the start bit when suppied an AEM header.
unsigned hitMap () const
 Static method to return the hit map when suppied an AEM header.
unsigned acceptMap () const
 Static method to return the accept map when suppied an AEM header.
unsigned phaVector () const
 Static method to return the PHA vector when suppied an AEM header.
unsigned parityError () const
 Static method to return the parity error when suppied an AEM header.
unsigned endOfCables () const
 Static method to return the end of cables indicator when suppied an AEM header.
unsigned cableNumber () const
 Static method to return the cable number when suppied an AEM header.

Static Public Member Functions

unsigned startBit (unsigned short *header)
 Static method to return the start bit when suppied an AEM header.
unsigned hitMap (unsigned short *header)
 Static method to return the hit map when suppied an AEM header.
unsigned acceptMap (unsigned short *header)
 Static method to return the accept map when suppied an AEM header.
unsigned phaVector (unsigned short *header)
 Static method to return the PHA vector when suppied an AEM header.
unsigned parityError (unsigned short *header)
 Static method to return the parity error when suppied an AEM header.
unsigned endOfCables (unsigned short *header)
 Static method to return the end of cables indicator when suppied an AEM header.
unsigned cableNumber (unsigned short *header)
 Static method to return the cable number when suppied an AEM header.

Detailed Description

Class for accessing fields in the AEM header words.

Format of AEM header is defined in the AEM primer: "The ACD Electronics Module (AEM): Programming ICD specification" LAT-TD-00639 - rev 2.6, section 3.2.1

Author:
Ric Claus, Jim Panetta -- GLAST LAT I&T/Online - (claus@slac.stanford.edu)
Revision
1.5
Date:
February 11, 2003 -- Created January 22, 2004 -- Bug in bit ordering of hitMap and acceptMap fixed See LIT Issue 37
Id
AEMheader.h,v 1.5 2004/04/14 03:52:46 claus Exp

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

Constructor & Destructor Documentation

AEMheader::AEMheader (  unsigned short *  header  )  [inline]
 

Constructor for initializing the class with raw header data.

Parameters:
header - A pointer to the AEM header data

Member Function Documentation

unsigned AEMheader::acceptMap (   )  const [inline]
 

Static method to return the accept map when suppied an AEM header.

Returns:
The acceptMap value

unsigned AEMheader::acceptMap (  unsigned short *  header  )  [inline, static]
 

Static method to return the accept map when suppied an AEM header.

Parameters:
header - A pointer to the AEM header data
Returns:
The acceptMap value

unsigned AEMheader::cableNumber (   )  const [inline]
 

Static method to return the cable number when suppied an AEM header.

Returns:
The cableNumber value

unsigned AEMheader::cableNumber (  unsigned short *  header  )  [inline, static]
 

Static method to return the cable number when suppied an AEM header.

Parameters:
header - A pointer to the AEM header data
Returns:
The cableNumber value

unsigned AEMheader::endOfCables (   )  const [inline]
 

Static method to return the end of cables indicator when suppied an AEM header.

Returns:
The EndOfCables value

unsigned AEMheader::endOfCables (  unsigned short *  header  )  [inline, static]
 

Static method to return the end of cables indicator when suppied an AEM header.

Parameters:
header - A pointer to the AEM header data
Returns:
The EndOfCables value

unsigned AEMheader::hitMap (   )  const [inline]
 

Static method to return the hit map when suppied an AEM header.

Returns:
The hitMap value

unsigned AEMheader::hitMap (  unsigned short *  header  )  [inline, static]
 

Static method to return the hit map when suppied an AEM header.

Parameters:
header - A header pointer to the AEM header data
Returns:
The hitMap value

unsigned AEMheader::parityError (   )  const [inline]
 

Static method to return the parity error when suppied an AEM header.

Returns:
The parityError value

unsigned AEMheader::parityError (  unsigned short *  header  )  [inline, static]
 

Static method to return the parity error when suppied an AEM header.

Parameters:
header - A pointer to the AEM header data
Returns:
The parityError value

unsigned AEMheader::phaVector (   )  const [inline]
 

Static method to return the PHA vector when suppied an AEM header.

Returns:
The startBit value

unsigned AEMheader::phaVector (  unsigned short *  header  )  [inline, static]
 

Static method to return the PHA vector when suppied an AEM header.

Parameters:
header - A pointer to the AEM header data
Returns:
The startBit value

unsigned AEMheader::startBit (   )  const [inline]
 

Static method to return the start bit when suppied an AEM header.

Returns:
The startBit value

unsigned AEMheader::startBit (  unsigned short *  header  )  [inline, static]
 

Static method to return the start bit when suppied an AEM header.

Parameters:
header - A pointer to the AEM header data
Returns:
The startBit value

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