RawReaderMemory.h

Go to the documentation of this file.

// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
// All rights not expressly granted are reserved.
//
// This software is distributed under the terms of the GNU General Public
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
#ifndef ALICEO2_CPV_RAWREADERMEMORY_H
#define ALICEO2_CPV_RAWREADERMEMORY_H
 
#include <gsl/span>
#include <Rtypes.h>
 
#include "Headers/RAWDataHeader.h"
#include "Headers/RDHAny.h"
 
namespace o2
{
 
namespace cpv
{
 
enum RawErrorType_t {
  kOK,            
  kOK_NO_PAYLOAD, 
  kRDH_DECODING,
  kRDH_INVALID,
  kNOT_CPV_RDH,
  kSTOPBIT_NOTFOUND,
  kPAGE_NOTFOUND,
  kOFFSET_TO_NEXT_IS_0,
  kPAYLOAD_INCOMPLETE,
  kNO_CPVHEADER,
  kNO_CPVTRAILER,
  kCPVHEADER_INVALID,
  kCPVTRAILER_INVALID,
  kSEGMENT_HEADER_ERROR,
  kROW_HEADER_ERROR,
  kEOE_HEADER_ERROR,
  kPADERROR,
  kUNKNOWN_WORD,
  kPadAddress,
  kWRONG_DATAFORMAT
};
 
class RawReaderMemory
{
 public:
  RawReaderMemory(const gsl::span<const char> rawmemory);
 
  ~RawReaderMemory() = default;
 
  void setRawMemory(const gsl::span<const char> rawmemory);
 
  RawErrorType_t next();
 
  RawErrorType_t nextPage();
 
  const o2::header::RDHAny& getRawHeader() const { return mRawHeader; }
 
  const std::vector<char>& getPayload() const { return mRawPayload; }
 
  int getPayloadSize() const { return mRawPayload.size(); }
 
  int getFileSize() const noexcept { return mRawMemoryBuffer.size(); }
 
  bool hasNext() const { return mCurrentPosition < mRawMemoryBuffer.size(); }
 
  uint32_t getCurrentHBFOrbit() const { return mCurrentHBFOrbit; }
 
  uint8_t getDataFormat() const { return mDataFormat; }
 
 protected:
  void init();
 
  o2::header::RDHAny decodeRawHeader(const void* headerwords);
 
 private:
  gsl::span<const char> mRawMemoryBuffer; 
  o2::header::RDHAny mRawHeader;          
  std::vector<char> mRawPayload;          
  unsigned int mCurrentPosition = 0;      
  bool mRawHeaderInitialized = false;     
  bool mPayloadInitialized = false;       
  uint32_t mCurrentHBFOrbit = 0;          
  bool mStopBitWasNotFound;               
  bool mIsJustInited = false;             
  uint8_t mDataFormat = 0x0;              
 
  ClassDefNV(RawReaderMemory, 2);
};
 
} // namespace cpv
 
} // namespace o2
 
#endif