PlexScintMdlId.h

Go to the documentation of this file.

// $Id: PlexScintMdlId.h,v 1.12 2005/08/26 18:47:04 rhatcher Exp $
//
// PlexScintMdlId
//
// PlexScintMdlId encapsulates scint module encoding
//
// Author:  R. Hatcher 2002.06.26
//

#ifndef PLEXSCINTMDLID_H
#define PLEXSCINTMDLID_H

#include <iosfwd>

#include "Plex/PlexPlaneId.h"

class PlexScintMdlId;
std::ostream& operator<<(std::ostream& os, const PlexScintMdlId& p);

class PlexScintMdlId : public PlexPlaneId {

 public:

   PlexScintMdlId();                        // necessary for streamer io
   PlexScintMdlId(PlexPlaneId plnid, Int_t module);
   PlexScintMdlId(Detector::Detector_t detector,
                  Int_t plane, Int_t module,
                  PlaneView::PlaneView_t view=PlaneView::kUnknown,
                  PlaneCoverage::PlaneCoverage_t cover=PlaneCoverage::kUnknown);

   virtual ~PlexScintMdlId() { ; } // no owned data members

   // use these two with caution as they work on the rawest level
   explicit PlexScintMdlId(const UInt_t encoded);
   inline UInt_t            GetEncoded() const { return fEncoded; }

   const char              *AsString(Option_t *option="") const;

   UShort_t                 GetModule() const;
   UChar_t                  GetModuleType() const;

   // compactified plane,module (assuming only east/west ends)
   // packed tightly, not simple bit shifts
   // 18 bits or less (unless Far has more than 682 planes)
   Int_t                    BuildPlnMdlKey() const;
   static PlexScintMdlId    UnbuildPlnMdlKey(Detector::Detector_t det, Int_t key);

   void                     Print(Option_t *option="") const;

   void                     SetModule(UInt_t module);

   friend Bool_t operator< (const PlexScintMdlId &lhs, const PlexScintMdlId &rhs);
   friend Bool_t operator<=(const PlexScintMdlId &lhs, const PlexScintMdlId &rhs);
   friend Bool_t operator==(const PlexScintMdlId &lhs, const PlexScintMdlId &rhs);
   friend Bool_t operator!=(const PlexScintMdlId &lhs, const PlexScintMdlId &rhs);
   friend Bool_t operator> (const PlexScintMdlId &lhs, const PlexScintMdlId &rhs);
   friend Bool_t operator>=(const PlexScintMdlId &lhs, const PlexScintMdlId &rhs);

   // these use a pseudo-database to hold info about different
   // plane configurations (mostly having to do with scint modules)
   // this first on is not to be confused w/ ctor
   // Get[Mapper]StripInMdl returns -1 for nonsense input
   static PlexScintMdlId StripToScintMdl(const PlexPlaneId& plnid, Int_t strip);
   static Short_t  GetStripInMdl(const PlexPlaneId& plnid, UInt_t strip);
   static Short_t  GetMapperStripInMdl(const PlexPlaneId& plnid, UInt_t strip);
   static UShort_t GetNumStripsInPln(const PlexPlaneId& plnid);
   static UShort_t GetNumScintMdlsInPln(const PlexPlaneId& plnid);

 protected:

 private:

   // hide PlexPlaneId's version of this member function
   // as this doesn't make sense for a PlexScintMdlId
   void                     SetIsSteel(Bool_t /* isSteel */) {;}

   ClassDef(PlexScintMdlId,1)
};

#ifndef __CINT__
inline PlexScintMdlId::PlexScintMdlId() { fEncoded = defaultPlexScintMdlId; }
inline PlexScintMdlId::PlexScintMdlId(const UInt_t encoded) 
{ fEncoded = encoded; }
#endif /* __CINT__ */

#endif // PLEXSCINTMDLID_H

---