Add some class-docs.

[u/mrichter/AliRoot.git] / MUON / AliMUONTriggerIO.h

#ifndef ALIMUONTRIGGERIO_H
#define ALIMUONTRIGGERIO_H

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

// $Id$

/// \ingroup trigger
/// \class AliMUONTriggerIO
/// \brief Handles read/write of masks and LUT to/from online files
/// 
//  Author Laurent Aphecetche, Subatech

#ifndef ROOT_TArrayI
#  include <TArrayI.h>
#endif

#ifndef ROOT_TObject
#  include <TObject.h>
#endif

#include <Riostream.h>

class AliMUONTriggerLut;
class AliMUONVCalibParam;
class AliMUONVStore;

class AliMUONTriggerIO : public TObject
{
public:
  AliMUONTriggerIO();
  AliMUONTriggerIO(const char* regionalFileToRead);
  virtual ~AliMUONTriggerIO();

  Bool_t ReadMasks(const char* localFile,
                   const char* regionalFile,
                   const char* globalFile,
                   AliMUONVStore* localMasks,
                   AliMUONVStore* regionalMasks,
                   AliMUONVCalibParam* globalMasks);
  
  Bool_t ReadLUT(const char* lutFileToRead, AliMUONTriggerLut& lut);
  
  Bool_t WriteLUT(const AliMUONTriggerLut& lut,
                  const char* lutFileToWrite);
  
//  void SetLocalBoardIds(const TArrayI& localBoardIds);
  
//  Bool_t WriteMasks(AliMUONVStore* localMasks,
//                    AliMUONVStore* regionalMasks,
//                    AliMUONVCalibParam* globalMasks) const;
  
private:
  
  void DeCompAddress(UChar_t &ypos, UChar_t &ytri, UChar_t &xdev, UChar_t &xpos, 
                     UShort_t address) const;
    
  void FillLut(AliMUONTriggerLut& lut,
               Int_t icirc, UChar_t istripX, UChar_t idev,  
               Int_t lutLpt[16][2], Int_t lutHpt[16][2]) ;
  
  Int_t LocalBoardId(Int_t index) const;
  
  /// Return number of local boards
  Int_t NofLocalBoards() const { return fNofLocalBoards; }
  
  Int_t ReadRegional(const char* regionalFile, AliMUONVStore* regionalMasks);

  Int_t ReadLocalMasks(const char* localFile, AliMUONVStore& localMasks) const;
  
  void ReadLocalLUT(AliMUONTriggerLut& lut, Int_t localBoardId, FILE* flut);
  
  void WriteLocalLUT(const AliMUONTriggerLut& lut, Int_t localBoardId, 
                       FILE* flut);
    
//  void WriteRegional() const;
  
private:
  TArrayI fLocalBoardIds; //!< order of the localboards
  Int_t fNofLocalBoards; //!< number of local boards
  
  ClassDef(AliMUONTriggerIO,0) // Read/Write trigger masks and LUT to/from online files
};

#endif