ByteStreamDataWriter.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef BYTESTREAMCNVSVC_BYTESTREAMDATAWRITER_H
#define BYTESTREAMCNVSVC_BYTESTREAMDATAWRITER_H

 
#include <cstdint>
#include <memory>
#include <string>
#include <vector>
 
#include "EventStorage/DWError.h"
#include "EventStorage/ESCompression.h"
#include "EventStorage/EventStorageRecords.h"
#include "EventStorage/FileNameCallback.h"
#include "boost/shared_ptr.hpp"
 
struct DataWriterParameters;

 
class ByteStreamDataWriter {
public:

    static std::unique_ptr<ByteStreamDataWriter>
    makeWriter(int version,
               const std::string& writingPath,
               const std::string& fileNameCore,
               const EventStorage::run_parameters_record& rPar,
               const std::vector<std::string>& fmdStrings,
               unsigned int maxFileNE = 0,
               unsigned int maxFileMB = 0,
               unsigned int startIndex = 1,
               EventStorage::CompressionType compression = EventStorage::NONE,
               unsigned int compLevel = 1);

    static std::unique_ptr<ByteStreamDataWriter>
    makeWriter(int version,
               const std::string& writingPath,
               boost::shared_ptr<EventStorage::FileNameCallback> theFNCB,
               const EventStorage::run_parameters_record& rPar,
               const std::string& project,
               const std::string& streamType,
               const std::string& streamName,
               const std::string& stream,
               unsigned int lumiBlockNumber,
               const std::string& applicationName,
               const std::vector<std::string>& fmdStrings,
               unsigned int maxFileNE = 0,
               unsigned int maxFileMB = 0,
               EventStorage::CompressionType compression = EventStorage::NONE,
               unsigned int compLevel = 1);

    static std::unique_ptr<ByteStreamDataWriter>
        makeWriter(const DataWriterParameters& parameters);
 
 
    ByteStreamDataWriter() {}
    virtual ~ByteStreamDataWriter() = default;
 
    // abstract class cannot be copied
    ByteStreamDataWriter(const ByteStreamDataWriter&) = delete;
    ByteStreamDataWriter& operator=(const ByteStreamDataWriter&) = delete;

    virtual EventStorage::DWError putData(unsigned int dataSize, const void *data) = 0;

     virtual bool good() const = 0;
 
};
 

struct DataWriterParameters {
  int version{0};

  std::string writingPath{""};

  std::string fileNameCore{""};

  EventStorage::run_parameters_record rPar{
    0, 0, 0, 0, 0, 0, 0xFFFFFFFFFFFFFFFFULL, 0xFFFFFFFFFFFFFFFFULL, 0, 0 };

  std::vector<std::string> fmdStrings;

  unsigned int maxFileNE{0};

  unsigned int maxFileMB{0};

  unsigned int startIndex{1};

  EventStorage::CompressionType compression{EventStorage::NONE};

  unsigned int compLevel{1};

  boost::shared_ptr<EventStorage::FileNameCallback> theFNCB;

  std::string project{""};

  std::string streamType{""};

  std::string streamName{""};

  std::string stream{""};
  
  unsigned int lumiBlockNumber{0};

  std::string applicationName{""};
};
 
#endif // BYTESTREAMCNVSVC_BYTESTREAMDATAWRITER_H