RawCOPPERFormat_v2.h

/**************************************************************************
 * basf2 (Belle II Analysis Software Framework)                           *
 * Author: The Belle II Collaboration                                     *
 *                                                                        *
 * See git log for contributors and copyright holders.                    *
 * This file is licensed under LGPL-3.0, see LICENSE.md.                  *
 **************************************************************************/
 
#ifndef RAWCOPPERFORMAT_V2_H
#define RAWCOPPERFORMAT_V2_H
 
// Includes
#include <rawdata/dataobjects/RawCOPPERFormat.h>
#include <rawdata/dataobjects/RawHeader_v2.h>
#include <rawdata/dataobjects/RawTrailer_v2.h>
#include <rawdata/CRCCalculator.h>
 
/* #include <framework/datastore/DataStore.h> */
/* #include <TObject.h> */
 
//#define USE_B2LFEE_FORMAT_BOTH_VER1_AND_2
 
 
namespace Belle2 {

 
  class RawCOPPERFormat_v2 : public RawCOPPERFormat {
  public:
    RawCOPPERFormat_v2();

    //RawCOPPERFormat_v2(int* bufin, int nwords);
    virtual ~RawCOPPERFormat_v2();
 
    //
    // Get position of or pointer to data
    //
    // POINTER TO "DETECTOR BUFFER"
    //( after removing "B2link headers" from "FINESSE buffer". THIS IS THE RAW DATA FROM A DETECTOR
 

    /* cppcheck-suppress missingOverride */
    int Get1stDetectorNwords(int n) OVERRIDE_CPP17;

    /* cppcheck-suppress missingOverride */
    int Get2ndDetectorNwords(int n) OVERRIDE_CPP17;

    /* cppcheck-suppress missingOverride */
    int Get3rdDetectorNwords(int n) OVERRIDE_CPP17;

    /* cppcheck-suppress missingOverride */
    int Get4thDetectorNwords(int n) OVERRIDE_CPP17;


    /* cppcheck-suppress missingOverride */
    int* GetRawTrlBufPtr(int n) OVERRIDE_CPP17;
 
    //
    // Get information from "RawCOPPERFormat_v2 header" attached by DAQ software
    //
 
    /* cppcheck-suppress missingOverride */
    int GetExpNo(int n) OVERRIDE_CPP17;    
 
    /* cppcheck-suppress missingOverride */
    unsigned int GetExpRunSubrun(int n) OVERRIDE_CPP17;    
 
    /* cppcheck-suppress missingOverride */
    int GetRunNo(int n) OVERRIDE_CPP17;    
 
    /* cppcheck-suppress missingOverride */
    int GetSubRunNo(int n) OVERRIDE_CPP17;    
 
    /* cppcheck-suppress missingOverride */
    unsigned int GetEveNo(int n) OVERRIDE_CPP17;    
 
    /* cppcheck-suppress missingOverride */
    int GetDataType(int n) OVERRIDE_CPP17;    
 
    /* cppcheck-suppress missingOverride */
    int GetTruncMask(int n) OVERRIDE_CPP17;    

    /* cppcheck-suppress missingOverride */
    unsigned int GetErrorBitFlag(int n) OVERRIDE_CPP17;

    /* cppcheck-suppress missingOverride */
    void AddErrorBitFlag(int n, unsigned int error_bit_flag) OVERRIDE_CPP17;

    /* cppcheck-suppress missingOverride */
    int GetPacketCRCError(int n) OVERRIDE_CPP17;

    /* cppcheck-suppress missingOverride */
    int GetEventCRCError(int n) OVERRIDE_CPP17;

    /* cppcheck-suppress missingOverride */
    unsigned int GetNodeID(int n) OVERRIDE_CPP17;
 
    //
    // Get information from 13words "COPPER header" attached by COPPER board
    //

    /* cppcheck-suppress missingOverride */
    virtual int GetNumFINESSEBlock(int n) OVERRIDE_CPP17;

    /* cppcheck-suppress missingOverride */
    int Get1stFINESSENwords(int n) OVERRIDE_CPP17;

    /* cppcheck-suppress missingOverride */
    int Get2ndFINESSENwords(int n) OVERRIDE_CPP17;

    /* cppcheck-suppress missingOverride */
    int Get3rdFINESSENwords(int n) OVERRIDE_CPP17;

    /* cppcheck-suppress missingOverride */
    int Get4thFINESSENwords(int n) OVERRIDE_CPP17;
 
    //
    // Get information from "B2link(attached by FEE and HLSB) header"
    //
    //    virtual int* GetFTSW2Words(int n);
 
#ifdef USE_B2LFEE_FORMAT_BOTH_VER1_AND_2
    /* cppcheck-suppress missingOverride */
    void CheckB2LFEEHeaderVersion(int  n) OVERRIDE_CPP17;
#endif

    /* cppcheck-suppress missingOverride */
    unsigned int GetTTCtimeTRGType(int n) OVERRIDE_CPP17;

    /* cppcheck-suppress missingOverride */
    unsigned int GetTTUtime(int n) OVERRIDE_CPP17;
 
    /*     //! calc COPPER driver's checksum value */
    /*     virtual unsigned int CalcDriverChkSum(int n) = 0; */
 

    /* cppcheck-suppress missingOverride */
    int GetTTCtime(int n) OVERRIDE_CPP17;

    /* cppcheck-suppress missingOverride */
    int GetTRGType(int n) OVERRIDE_CPP17;

    /* cppcheck-suppress missingOverride */
    void GetTTTimeVal(int n, struct timeval* tv) OVERRIDE_CPP17;

    /* cppcheck-suppress missingOverride */
    int GetMaxNumOfCh(int n) OVERRIDE_CPP17;

    enum {
      DATA_FORMAT_VERSION = 2
    };

    RawHeader_v2 tmp_header;

    RawTrailer_v2 tmp_trailer;
 
 
  protected :
    //    ClassDefOverride(RawCOPPERFormat_v2, 2);
  };
 
 
 
 
  inline int* RawCOPPERFormat_v2::GetRawTrlBufPtr(int n)
  {
    int pos_nwords;
    if (n == (m_num_events * m_num_nodes) - 1) {
      pos_nwords = m_nwords - tmp_trailer.GetTrlNwords();
    } else {
      pos_nwords = GetBufferPos(n + 1) - tmp_trailer.GetTrlNwords();
    }
    return &(m_buffer[ pos_nwords ]);
  }
 
  inline int RawCOPPERFormat_v2::GetExpNo(int n)
  {
    tmp_header.SetBuffer(GetBuffer(n));
    return tmp_header.GetExpNo();
  }
 
 
  inline unsigned int RawCOPPERFormat_v2::GetExpRunSubrun(int n)
  {
    tmp_header.SetBuffer(GetBuffer(n));
    return tmp_header.GetExpRunSubrun();
  }
 
 
  inline int RawCOPPERFormat_v2::GetRunNo(int n)
  {
    tmp_header.SetBuffer(GetBuffer(n));
    return tmp_header.GetRunNo();
  }
 
 
  inline int RawCOPPERFormat_v2::GetSubRunNo(int n)
  {
    tmp_header.SetBuffer(GetBuffer(n));
    return tmp_header.GetSubRunNo();
  }
 
  inline unsigned int RawCOPPERFormat_v2::GetEveNo(int n)
  {
    tmp_header.SetBuffer(GetBuffer(n));
    return tmp_header.GetEveNo();
  }
 
 
  inline unsigned int RawCOPPERFormat_v2::GetNodeID(int n)
  {
    tmp_header.SetBuffer(GetBuffer(n));
    return tmp_header.GetNodeID();
  }
 
 
  inline int RawCOPPERFormat_v2::GetDataType(int n)
  {
    tmp_header.SetBuffer(GetBuffer(n));
    return tmp_header.GetDataType();
  }
 
  inline int RawCOPPERFormat_v2::GetTruncMask(int n)
  {
    tmp_header.SetBuffer(GetBuffer(n));
    return tmp_header.GetTruncMask();
  }
 
  inline unsigned int RawCOPPERFormat_v2::GetErrorBitFlag(int n)
  {
    tmp_header.SetBuffer(GetBuffer(n));
    return tmp_header.GetErrorBitFlag();
  }
 
  inline void RawCOPPERFormat_v2::AddErrorBitFlag(int n, unsigned int error_bit_flag)
  {
    tmp_header.SetBuffer(GetBuffer(n));
    tmp_header.AddErrorBitFlag(error_bit_flag);
    return;
  }
 
  inline int RawCOPPERFormat_v2::GetPacketCRCError(int n)
  {
    tmp_header.SetBuffer(GetBuffer(n));
    return tmp_header.GetPacketCRCError();
  }
 
  inline int RawCOPPERFormat_v2::GetEventCRCError(int n)
  {
    tmp_header.SetBuffer(GetBuffer(n));
    return tmp_header.GetEventCRCError();
  }
 
 
  inline int RawCOPPERFormat_v2::Get1stDetectorNwords(int n)
  {
    return GetDetectorNwords(n, 0);
  }
 
  inline int RawCOPPERFormat_v2::Get2ndDetectorNwords(int n)
  {
    return GetDetectorNwords(n, 1);
  }
 
  inline int RawCOPPERFormat_v2::Get3rdDetectorNwords(int n)
  {
    return GetDetectorNwords(n, 2);
  }
 
  inline int RawCOPPERFormat_v2::Get4thDetectorNwords(int n)
  {
    return GetDetectorNwords(n, 3);
  }
 
 
 
  inline int RawCOPPERFormat_v2::Get1stFINESSENwords(int n)
  {
    return GetFINESSENwords(n, 0);
  }
 
  inline int RawCOPPERFormat_v2::Get2ndFINESSENwords(int n)
  {
    return GetFINESSENwords(n, 1);
  }
 
  inline int RawCOPPERFormat_v2::Get3rdFINESSENwords(int n)
  {
    return GetFINESSENwords(n, 2);
  }
 
  inline int RawCOPPERFormat_v2::Get4thFINESSENwords(int n)
  {
    return GetFINESSENwords(n, 3);
  }
 
 
 
  inline unsigned int RawCOPPERFormat_v2::GetTTCtimeTRGType(int n)
  {
    tmp_header.SetBuffer(GetBuffer(n));
    return tmp_header.GetTTCtimeTRGType();
  }
 
  inline unsigned int RawCOPPERFormat_v2::GetTTUtime(int n)
  {
    tmp_header.SetBuffer(GetBuffer(n));
    return tmp_header.GetTTUtime();
  }
 
  inline int RawCOPPERFormat_v2::GetTTCtime(int n)
  {
    tmp_header.SetBuffer(GetBuffer(n));
    return tmp_header.GetTTCtime();
  }
 
  inline int RawCOPPERFormat_v2::GetTRGType(int n)
  {
    tmp_header.SetBuffer(GetBuffer(n));
    return tmp_header.GetTRGType();
  }
 
  inline void RawCOPPERFormat_v2::GetTTTimeVal(int n, struct timeval* tv)
  {
    tmp_header.SetBuffer(GetBuffer(n));
    tmp_header.GetTTTimeVal(tv);
    return ;
  }
 
  inline int RawCOPPERFormat_v2::GetMaxNumOfCh(int/* n */)
  {
    return MAX_COPPER_CH;
  }

}
#endif