Updated comments for Doxygen

[u/mrichter/AliRoot.git] / MUON / mapping / AliMpSectorReader.h

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

// $Id$
// $MpId: AliMpSectorReader.h,v 1.6 2006/05/23 13:07:44 ivana Exp $

/// \ingroup sector
/// \class AliMpSectorReader
/// \brief Class that takes care of reading the sector data.
///
/// Authors: David Guez, Ivana Hrivnacova; IPN Orsay

#ifndef ALI_MP_SECTOR_READER_H
#define ALI_MP_SECTOR_READER_H

#include <TObject.h>

#include "AliMpStationType.h"
#include "AliMpPlaneType.h"
#include "AliMpXDirection.h"
#include "AliMpIntPair.h"

#include <TString.h>

#include <fstream>

class AliMpSector;
class AliMpZone;
class AliMpSubZone;
class AliMpRow;
class AliMpVRowSegmentSpecial;
class AliMpMotifReader;
class AliMpVMotif;
class AliMpMotifSpecial;
class AliMpMotifType;

class AliMpSectorReader : public TObject
{
  public:
    AliMpSectorReader(AliMpStationType station, AliMpPlaneType plane);
    AliMpSectorReader();
    virtual ~AliMpSectorReader();
  
    // methods   
    AliMpSector*  BuildSector();
    
  protected:
    AliMpSectorReader(const AliMpSectorReader& right);
    AliMpSectorReader&  operator = (const AliMpSectorReader& right);

  private:  
    // methods
    void  ReadSectorData(ifstream& in);
    void  ReadZoneData(ifstream& in);
    void  ReadSubZoneData(ifstream& in, AliMpZone* zone);
    void  ReadRowSegmentsData(ifstream& in,
                          AliMpZone* zone, AliMpSubZone* subZone);
    AliMpVMotif*  ReadMotifData(ifstream& in, AliMpZone* zone);
    void  ReadSectorSpecialData(ifstream& in, AliMpXDirection direction);
    void  ReadMotifsSpecialData(ifstream& in);
    void  ReadRowSpecialData(ifstream& in, AliMpXDirection direction);
    void  ReadRowSegmentSpecialData(ifstream& in,
                          AliMpVRowSegmentSpecial* segment,
			  AliMpXDirection direction);
    
    // static data members
    static const TString  fgkSectorKeyword;        ///< sector keyword
    static const TString  fgkZoneKeyword;          ///< zone keyword
    static const TString  fgkSubZoneKeyword;       ///< subzone keyword
    static const TString  fgkRowKeyword;           ///< row keyword
    static const TString  fgkEofKeyword;           ///< eof keyword
    static const TString  fgkSectorSpecialKeyword; ///< sector special keyword
    static const TString  fgkMotifKeyword;         ///< motif keyword
    static const TString  fgkRowSpecialKeyword;    ///< row special keyword
    static const TString  fgkPadRowsKeyword;       ///< pad rows keyword
    static const TString  fgkPadRowSegmentKeyword; ///< pad row segment keyword
  
    // data members  
    AliMpStationType  fStationType; ///< station type 
    AliMpPlaneType    fPlaneType;   ///< plane type 
    AliMpSector*      fSector;      ///< sector
    AliMpMotifReader* fMotifReader; ///< motif reader

  ClassDef(AliMpSectorReader,1)  // Data reader
};

#endif //ALI_MP_READER_H