exporter.h

Go to the documentation of this file.

// -----------------------------------------------------------------------------
//
// Copyright (C) 2021 CERN & University of Surrey for the benefit of the
// BioDynaMo collaboration. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
//
// See the LICENSE file distributed with this work for details.
// See the NOTICE file distributed with this work for additional information
// regarding copyright ownership.
//
// -----------------------------------------------------------------------------
 
#ifndef CORE_EXPORTER_H_
#define CORE_EXPORTER_H_
 
#include <cstdint>
#include <memory>
#include <string>
 
namespace bdm {
 
class Exporter {
 public:
  virtual ~Exporter();
 
  virtual void ExportIteration(std::string filename, uint64_t iteration) = 0;
 
  virtual void ExportSummary(std::string filename, uint64_t num_iterations) = 0;
};
 
class BasicExporter : public Exporter {
 public:
  void ExportIteration(std::string filename, uint64_t iteration) override;
 
  void ExportSummary(std::string filename, uint64_t num_iterations) override;
};
 
class MatlabExporter : public Exporter {
 public:
  void ExportIteration(std::string filename, uint64_t iteration) override;
 
  void ExportSummary(std::string filename, uint64_t num_iterations) override;
};
 
class NeuroMLExporter : public Exporter {
 public:
  void ExportIteration(std::string filename, uint64_t iteration) override;
 
  void ExportSummary(std::string filename, uint64_t num_iterations) override;
};
 
class ParaviewExporter : public Exporter {
 public:
  void ExportIteration(std::string filename, uint64_t iteration) override;
 
  void ExportSummary(std::string filename, uint64_t num_iterations) override;
};
 
enum ExporterType { kBasic, kMatlab, kNeuroML, kParaview };
 
class ExporterFactory {
 public:
  static std::unique_ptr<Exporter> GenerateExporter(ExporterType type);
};
 
}  // namespace bdm
 
#endif  // CORE_EXPORTER_H_