---

LogId.h

Go to the documentation of this file.

#ifndef LogId_H
#define LogId_H

#include "TObject.h"

class LogId : public TObject {
public: 
    typedef struct TAG_STRUCT {
        UInt_t xy, 
               sequence, 
               pipeline, 
               layer, 
               column, 
               tower;
    };
private:
    /*
    LogId tag word layout
    (defined in following enum):
     ________________________________________________________________
    |31| ... |17||16|  |  |13|12|  |  |09|08|07||06|  |04|03|  |01|00|
    |__|_____|__||__|__|__|__|__|__|__|__|__|__||__|__|__|__|__|__|__|
    |           ||   TOWER   |  COLUMN   |LAYER||PIPELINE|SEQUENCE|XY|
    |RESERVERD 4||___________|___________|_____||________|________|__| 
    |FUTURE USE ||         LOG POSITION        ||   LOG ID NUMBER    |
    |___________||_____________________________||____________________| 

    ***** NOTES: *****

      (1) LAYER Field:
      The layer field contains the most significant two bits necessary
      to encode the 8 physical cal layers.  When the 'XY' bit is appended
      to this field as the LSB an actual physical layer number is obtained.
      This is done to prevent the dual storage of data which could result 
      in errors if they were to differ.
    */
    enum {
        // X/Y bit:
        CAL_K_XY = 1,
        CAL_V_XY = 0,
        CAL_M_XY = ((1 << CAL_K_XY) - 1),
        // ADC Sequence #:
        CAL_K_SEQ = 3,
        CAL_V_SEQ = (CAL_V_XY + CAL_K_XY),
        CAL_M_SEQ = ((1 << CAL_K_SEQ) - 1),
        // Pipeline #:
        CAL_K_PIPE = 3,
        CAL_V_PIPE = (CAL_V_SEQ + CAL_K_SEQ),
        CAL_M_PIPE = ((1 << CAL_K_PIPE) - 1),
        // Log ID Number as a whole:
        CAL_K_ID = (CAL_K_XY + CAL_K_SEQ + CAL_K_PIPE),
        CAL_V_ID = CAL_V_XY,
        CAL_M_ID = ((1 << CAL_K_ID) - 1),

        // Log Position (Layer):
        CAL_K_LAYER = 2,
        CAL_V_LAYER = (CAL_V_PIPE + CAL_K_PIPE),
        CAL_M_LAYER = ((1 << CAL_K_LAYER) - 1),
        // Log Position (Column):
        CAL_K_COLUMN = 4,
        CAL_V_COLUMN = (CAL_V_LAYER + CAL_K_LAYER),
        CAL_M_COLUMN = ((1 << CAL_K_COLUMN) - 1),
        // Log Position (Tower):
        CAL_K_TOWER = 4,
        CAL_V_TOWER = (CAL_V_COLUMN + CAL_K_COLUMN),
        CAL_M_TOWER = ((1 << CAL_K_TOWER) - 1),

        CAL_K_NEWID = (CAL_K_LAYER + CAL_K_COLUMN + CAL_K_TOWER),
        CAL_V_NEWID = CAL_V_LAYER,
        CAL_M_NEWID = ((1 << CAL_K_ID) - 1),

        // Upper Bounds values for bounded fields:
        // NOTE: no bounds limits for fields which use all possible values.
        BOUNDS_LAYER = 7,
        BOUNDS_COLUMN = 9,
        BOUNDS_PIPE = 4
    };
    UInt_t m_tag;   // Packed word containing log id

    static Bool_t isValidTagStruct(LogId::TAG_STRUCT ts);
    static Bool_t isValidTagWord(UInt_t tagWord);
    static Bool_t isValidColumn(UInt_t columnVal);
    static Bool_t isValidLayer(UInt_t layerVal);

    static UShort_t getTower(UInt_t tagWord);
    static UShort_t getColumn(UInt_t tagWord);
    static UShort_t getLayer(UInt_t tagWord);

    static UInt_t getId(UInt_t tagWord);
    static UShort_t getXY(UInt_t tagWord);


public:
    typedef enum {
        X = 0,
        Y
    } CALAxes;

    LogId();            
    LogId(UInt_t tag);
    LogId(UShort_t tower, UShort_t layer, UShort_t column);
    virtual ~LogId();

    static UInt_t fillTagWord(LogId::TAG_STRUCT *ts);
    static void fillTagStruct(UInt_t tagVal, LogId::TAG_STRUCT *ts);

    UInt_t getTag()         const;
    UShort_t getColumn()      const;
    UShort_t getLayer()       const;
    UShort_t getTower()       const;

    UInt_t getId()          const;
    CALAxes getXY()         const;

    Bool_t setTag(UInt_t tagVal);
    Bool_t setTag(TAG_STRUCT *ts);
    Bool_t setColumn(UInt_t columnVal);
    Bool_t setLayer(UInt_t layerVal);
    Bool_t setTower(UInt_t towerVal);
    Bool_t setXY(CALAxes xyVal);
    Bool_t setId(UShort_t tower, UShort_t layer, UShort_t column);

ClassDef(LogId,3)       // Cal log identification and readout information
};
#endif

---