New base for all classes in HLT/PHOS

[u/mrichter/AliRoot.git] / STEER / AliHitMap.h

#ifndef ALIHITMAP_H
#define ALIHITMAP_H

/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
 * See cxx source for full Copyright notice                               */

/* $Id$ */

#include <TObject.h>

typedef enum {kEmpty, kUsed, kUnused} FlagType;

class AliHitMap :
public TObject {
 public:
    // Virtual destructor -- it is necessary
    virtual ~AliHitMap() {}
    // Fill hits from list of digits into hit map
    virtual  void  FillHits()                                      =0;
    // Clear the hit map
    virtual  void  Clear(const char *opt = "")                     =0;
    // Set a single hit
    virtual  void  SetHit(Int_t ix, Int_t iy, Int_t idigit)        =0;
    // Delete a single hit
    virtual  void  DeleteHit(Int_t ix, Int_t iy)                   =0;
    // Get index of hit in the list of digits
    virtual Int_t  GetHitIndex(Int_t ix, Int_t iy) const           =0;
    // Get pointer to digit
    virtual TObject * GetHit(Int_t ix, Int_t iy) const             =0;
    // Flag a hit as used
    virtual void   FlagHit(Int_t ix, Int_t iy)                     =0;
    // Validate
    virtual  Bool_t ValidateHit(Int_t ix, Int_t iy)                =0;
     // Test hit status
    virtual FlagType TestHit(Int_t ix, Int_t iy)                   =0;
    
    ClassDef(AliHitMap,2) //virtual base class for HitMap
};
#endif