WriterModule.h

/*
 * RecordModule.h
 *
 *  Created on: Feb 7, 2021
 *      Author: Pawel Sznajder (NCBJ)
 */
 
#ifndef MODULES_WRITER_WRITERMODULE_H_
#define MODULES_WRITER_WRITERMODULE_H_
 
#include <ElementaryUtils/parameters/Parameters.h>
#include <string>
#include <vector>
 
#include "../../beans/physics/Event.h"
#include "../EpicModuleObject.h"
 
namespace EPIC {
class GenerationInformation;
} /* namespace EPIC */
 
namespace EPIC {
 
class WriterModule : public EpicModuleObject {
 
public:
  static const std::string
      WRITER_MODULE_CLASS_NAME; 
 
  static const std::string PARAMETER_NAME_PATH; 
 
  WriterModule(const std::string &className);
 
  WriterModule(const WriterModule &other);
 
  virtual ~WriterModule();
 
  virtual void configure(const ElemUtils::Parameters &parameters);
 
  virtual bool runTest() const;
 
  virtual void open() = 0;
 
  virtual void saveGenerationInformation(const GenerationInformation& generationInformation) = 0;
 
  virtual void close() = 0;
 
  virtual void write(const Event &event) = 0;
 
  virtual void write(const std::vector<Event> &events) = 0;
 
  //********************************************************
  //*** SETTERS AND GETTERS ********************************
  //********************************************************
 
  const std::string &getPath() const;
 
  void setPath(const std::string &path);
 
protected:
  virtual void initModule();
  virtual void isModuleWellConfigured();
 
  std::string m_path; 
};
 
} /* namespace EPIC */
 
#endif /* MODULES_WRITER_WRITERMODULE_H_ */