RawRunCommentBlock.cxx

Go to the documentation of this file.

// $Id: RawRunCommentBlock.cxx,v 1.15 2004/11/11 15:33:22 rhatcher Exp $
// 
// RawRunCommentBlock 
// 
// RawRunCommentBlock holds the Run Comment info
//
// Author:  R. Hatcher 2001.06.01
//

#include "RawData/RawRunCommentBlock.h"

enum EDebugRunCommentBlock {
   kdbg_ForceHexDump  = 0x0001
};
UInt_t RawRunCommentBlock::fgDebugFlags = 0;

#include "MessageService/MsgService.h"
//CVSID("$Id: RawRunCommentBlock.cxx,v 1.15 2004/11/11 15:33:22 rhatcher Exp $");
#include "MessageService/MsgFormat.h"

#include "RawData/RawBlockRegistry.h"
REGISTERRAWBLOCK(RawRunCommentBlock,kMdBlockRunComment,0);

#include "RawData/littleendian_strings.h"

ClassImp(RawRunCommentBlock)

enum ERunStartBlkPos {
   indx_size      = 0,
   indx_checksum  = 1,
   indx_blockid   = 2,
   zzzz_last_v1   = indx_blockid+1,
   indx_run       = 3,
   indx_subrun    = 4,
   indx_runtype   = indx_subrun,
   indx_startsec  = 5,
   indx_startnsec = 6,
   zzzz_last      = 7
};


//____________________________________________________________________________
RawRunCommentBlock::RawRunCommentBlock()
   : RawDataBlock(), fRunComment(0)
{
   // Default constructor
}

//____________________________________________________________________________
RawRunCommentBlock::RawRunCommentBlock(const Int_t *block)
   : RawDataBlock(block), fRunComment(0)
{
   //  stored block format is:
   //---------------------
   //  0   # words in block
   //  1   checksum
   //  2   Block Id
   //-----
   //  3   run #
   //  4   {subrun#| run type}
   //  5   time (sec)
   //  6   time (nsec)
   //  7   comment string (padded to 4 char)

   // version < 2 had "comment" field starting at word 3
}

//____________________________________________________________________________
RawRunCommentBlock::RawRunCommentBlock(const VldContext& vldc, Int_t run,
                                       Short_t subrun, Short_t runtype,
                                       const Char_t* comment)
   : RawDataBlock(), fRunComment(0)
{
   // Component ctor (version 2)

   UInt_t nwdc  = nwords_in_string(comment);
   fSize = zzzz_last + nwdc;
   if (fRawBlock) delete [] fRawBlock;
   fRawBlock = new Int_t [fSize];  

   fRawBlock[0] = fSize;
// fRawBlock[1] = checksum... see below
 
   RawBlockRegistry& rbr = RawBlockRegistry::Instance();
   RawBlockProxy*    rbp = rbr.LookUp("RawRunCommentBlock");
 
   Bool_t isDCS   = rbp->IsDCS();
   Int_t  majorId = rbp->GetMajorId();
   Int_t  minorId = 2;
   RawBlockId rbid(majorId,minorId,isDCS,
                   vldc.GetDetector(),vldc.GetSimFlag());
   fRawBlock[2] = rbid.GetEncoded();
 
   fRawBlock[indx_run]     = run;
   fRawBlock[indx_subrun]  = (subrun&0xffff)<<16 | (runtype&0xffff);
   fRawBlock[indx_startsec]     = vldc.GetTimeStamp().GetSec();
   fRawBlock[indx_startnsec]    = vldc.GetTimeStamp().GetNanoSec();
 
   fRawBlock[fSize-1] = 0; // ensure final '\0'
   pack_string_in_lel(fRawBlock+zzzz_last,comment);

   // fill checksum
   rdxsum_fill((long*)fRawBlock,0);
}

//____________________________________________________________________________
RawRunCommentBlock::RawRunCommentBlock(const VldContext& vldc,
                                       const Char_t* comment)
                                       
   : RawDataBlock(), fRunComment(0)
{
   // Component ctor (version 1)

   UInt_t nwdc  = nwords_in_string(comment);
   fSize = zzzz_last_v1 + nwdc;
   if (fRawBlock) delete [] fRawBlock;
   fRawBlock = new Int_t [fSize];  

   fRawBlock[0] = fSize;
// fRawBlock[1] = checksum... see below
 
   RawBlockRegistry& rbr = RawBlockRegistry::Instance();
   RawBlockProxy*    rbp = rbr.LookUp("RawRunCommentBlock");
 
   Bool_t isDCS   = rbp->IsDCS();
   Int_t  majorId = rbp->GetMajorId();
   Int_t  minorId = 1;
   RawBlockId rbid(majorId,minorId,isDCS,
                   vldc.GetDetector(),vldc.GetSimFlag());
   fRawBlock[2] = rbid.GetEncoded();
 
   fRawBlock[fSize-1] = 0; // ensure final '\0'
   pack_string_in_lel(fRawBlock+zzzz_last_v1,comment);

   // fill checksum
   rdxsum_fill((long*)fRawBlock,0);
}

//____________________________________________________________________________
RawRunCommentBlock::~RawRunCommentBlock()
{
   // dtor
   if (fRunComment) {
      delete [] fRunComment;
      fRunComment = 0;
   }
}

//____________________________________________________________________________
RawRunCommentBlock& RawRunCommentBlock::operator=(const RawRunCommentBlock& rhs)
{
   // deep copy assignment 
  if (this != &rhs) {
    RawDataBlock::operator=(rhs);
    if (fRunComment) { delete [] fRunComment; fRunComment = 0; }
  }
  return *this;
}

//____________________________________________________________________________
VldTimeStamp RawRunCommentBlock::GetTime() const
{
   // get the trigger time

   Int_t minor = GetBlockId().GetMinor();

   if ( fSize >= zzzz_last && minor>=2 )
      return VldTimeStamp(fRawBlock[indx_startsec],fRawBlock[indx_startnsec]);
 
   return VldTimeStamp((time_t)0,(Int_t)0);
}
 
//____________________________________________________________________________
Int_t RawRunCommentBlock::GetRun() const
{
   // get the run number

   Int_t minor = GetBlockId().GetMinor();

   if ( fSize >= zzzz_last && minor>=2 ) return fRawBlock[indx_run];
   return -1;
}
 
//____________________________________________________________________________
Short_t RawRunCommentBlock::GetSubRun() const
{
   // get the subrun number

   Int_t minor = GetBlockId().GetMinor();

   if ( fSize >= zzzz_last && minor>=2 ) 
      return (fRawBlock[indx_subrun]>>16)&0xffff;
   return -1;
}
 
//____________________________________________________________________________
Short_t RawRunCommentBlock::GetRunType() const
{
   // get the run type

   Int_t minor = GetBlockId().GetMinor();

   if ( fSize >= zzzz_last && minor>= 2 ) 
      return fRawBlock[indx_runtype]&0xffff;
   return -1;
}

//____________________________________________________________________________
VldContext RawRunCommentBlock::GetVldContext() const
{
   // build validity context
   RawBlockId rbid = GetBlockId();
   return VldContext(rbid.GetDetector(),rbid.GetSimFlag(),GetTime());
}

//____________________________________________________________________________
const Char_t* RawRunCommentBlock::GetRunComment() const
{
   // return the run comment

   if (!fRunComment) {

      Int_t minor = GetBlockId().GetMinor();

      Int_t*       insitu = fRawBlock+zzzz_last;
      if (minor<2) insitu = fRawBlock+zzzz_last_v1;

      UInt_t nwd = (fRawBlock+fSize) - insitu;
      fRunComment = unpack_lel_to_string(insitu,nwd);

      // replace non-printable, non-newline characters with blanks
      // leave final null (which should be there ... but make sure it is).
      int nchar = nwd*sizeof(Int_t)/sizeof(Char_t) - 1;
      fRunComment[nchar] = '\0';
      for (int i=0; i<nchar; ++i) {
        Char_t c = fRunComment[i];
        if ( !isprint(c) && '\n'!=c ) fRunComment[i] = ' ';
      }

   }
   return fRunComment;
}

//____________________________________________________________________________
std::ostream& RawRunCommentBlock::FormatToOStream(std::ostream& os, 
                                                  Option_t *option) const
{
   if (fgDebugFlags & kdbg_ForceHexDump) option = "x";

   RawDataBlock::FormatToOStream(os,option);
   if (option[0] == 'X') return os;
   
   // additional block specific formatted output is done here

   Int_t minor = GetBlockId().GetMinor();
   if (minor >= 2) {
      os << "Time " << GetTime().AsString("c") << endl;
      os << " Run " << GetRun()
         << " SubRun " << GetSubRun()
         << " RunType " << GetRunType() << endl;
   }
//   os << "'" << GetRunComment() << "'" << endl;
   const Char_t* cmt = GetRunComment();
   const Char_t* linestart = " | ";
   os << linestart;
   while (*cmt != '\0') {
      os << *cmt;
      if (*cmt == '\n' && *(cmt+1) != '\0') os << linestart;
      ++cmt;
   }
   os << endl;

   return os;
}

//____________________________________________________________________________

---