PayloadEncoder.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 O2_MCH_RAW_PAYLOAD_ENCODER_H
#define O2_MCH_RAW_PAYLOAD_ENCODER_H
 
#include <memory>
#include <set>
#include "MCHRawElecMap/DsElecId.h"
#include "MCHRawCommon/SampaCluster.h"
#include "MCHRawElecMap/Mapper.h"
#include <functional>
#include <optional>
#include <set>
 
namespace o2::mch::raw
{
 
 
class PayloadEncoder
{
 public:
  virtual ~PayloadEncoder() = default;
 
  virtual void addChannelData(DsElecId dsId, DualSampaChannelId chId,
                              const std::vector<SampaCluster>& data) = 0;
 
  // startHeartbeatFrame sets the trigger (orbit,bunchCrossing) to be used
  // for all generated payload headers (until next call to this method).
  // Causes the alignment of the underlying gbts.
  virtual void startHeartbeatFrame(uint32_t orbit, uint16_t bunchCrossing) = 0;
 
  // addHeartbeatHeaders adds Heartbeat Sampa headers for each dual sampa in the
  // given set.
  virtual void addHeartbeatHeaders(const std::set<DsElecId>& dsids) = 0;
 
  virtual size_t moveToBuffer(std::vector<std::byte>& buffer) = 0;
};
 
std::unique_ptr<PayloadEncoder> createPayloadEncoder(Solar2FeeLinkMapper solar2feelink,
                                                     bool userLogic,
                                                     int version,
                                                     bool chargeSumMode);
 
} // namespace o2::mch::raw
#endif