DigitSink.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_DEVIO_DIGITS_DIGIT_SINK_H
#define O2_MCH_DEVIO_DIGITS_DIGIT_SINK_H
 
#include <iosfwd>
#include <gsl/span>
#include "DigitFileFormat.h"
#include <memory>
#include <numeric>
 
namespace o2::mch
{
class ROFRecord;
class Digit;
 
namespace io
{
namespace impl
{
class DigitSinkImpl;
}
class DigitSink
{
 public:
  DigitSink(std::ostream& os);
 
  DigitSink(std::ostream& os, DigitFileFormat format,
            size_t maxSize = std::numeric_limits<size_t>::max());
 
  /* defined in the implementation file, where mImpl is a complete type */
  ~DigitSink();
 
  bool write(gsl::span<const Digit> digits,
             gsl::span<const ROFRecord> rofs = {});
 
 private:
  std::ostream& mOutput;                      // underlying stream used for output
  bool mBinary;                               // whether to output in binary mode or text mode
  DigitFileFormat mFileFormat{};              // version information for the binary case
  std::unique_ptr<impl::DigitSinkImpl> mImpl; // actual implementation of the writer
  size_t mMaxSize;                            // max size written to output
};
} // namespace io
} // namespace o2::mch
 
#endif