metrics.h

Go to the documentation of this file.

#ifndef PRESIO_METRIC_PLUGIN
#define PRESIO_METRIC_PLUGIN
 
#include <memory>
#include <vector>
#include "configurable.h"
#include "errorable.h"
#include "versionable.h"
#include <std_compat/span.h>
 
 
struct pressio_options;
struct pressio_data;
 
class libpressio_metrics_plugin : public pressio_configurable {
  public:
  libpressio_metrics_plugin();
  virtual ~libpressio_metrics_plugin()=default;
  int begin_check_options(struct pressio_options const* options);
  int end_check_options(struct pressio_options const* options, int rc);
  int begin_get_options();
  int end_get_options(struct pressio_options const* ret);
 
  int begin_get_documentation();
  int end_get_documentation(struct pressio_options const& ret);
  int begin_get_configuration();
  int end_get_configuration(struct pressio_options const& ret);
  int begin_set_options(struct pressio_options const& options);
  int end_set_options(struct pressio_options const& options, int rc);
 
  int begin_compress(const struct pressio_data * input, struct pressio_data const * output);
  int end_compress(struct pressio_data const* input, pressio_data const * output, int rc);
  int begin_decompress(struct pressio_data const* input, pressio_data const* output);
  int end_decompress(struct pressio_data const* input, pressio_data const* output, int rc);
 
  int begin_compress_many(compat::span<const pressio_data* const> const& inputs,
                                       compat::span<const pressio_data* const> const& outputs);
 
  int end_compress_many(compat::span<const pressio_data* const> const& inputs,
                                     compat::span<const pressio_data* const> const& outputs, int rc);
 
  int begin_decompress_many(compat::span<const pressio_data* const> const& inputs,
                                         compat::span<const pressio_data* const> const& outputs);
 
  int end_decompress_many(compat::span<const pressio_data* const> const& inputs,
                                       compat::span<const pressio_data* const> const& outputs, int rc);
 
  virtual pressio_options get_documentation_impl() const=0;
 
  virtual pressio_options get_documentation() const final;
 
  void set_name(std::string const& new_name) override final;
 
  virtual pressio_options get_metrics_results(pressio_options const &options)=0;
 
  virtual std::unique_ptr<libpressio_metrics_plugin> clone()=0;
 
protected:
  virtual int begin_check_options_impl(struct pressio_options const* options);
  virtual int end_check_options_impl(struct pressio_options const* options, int rc);
  virtual int begin_get_options_impl();
  virtual int end_get_options_impl(struct pressio_options const* ret);
 
  virtual int begin_get_documentation_impl();
  virtual int end_get_documentation_impl(struct pressio_options const& ret);
  virtual int begin_get_configuration_impl();
  virtual int end_get_configuration_impl(struct pressio_options const& ret);
  virtual int begin_set_options_impl(struct pressio_options const& options);
  virtual int end_set_options_impl(struct pressio_options const& options, int rc);
 
  virtual int begin_compress_impl(const struct pressio_data * input, struct pressio_data const * output);
  virtual int end_compress_impl(struct pressio_data const* input, pressio_data const * output, int rc);
  virtual int begin_decompress_impl(struct pressio_data const* input, pressio_data const* output);
  virtual int end_decompress_impl(struct pressio_data const* input, pressio_data const* output, int rc);
 
  virtual int begin_compress_many_impl(compat::span<const pressio_data* const> const& inputs,
                                   compat::span<const pressio_data* const> const& outputs);
 
  virtual int end_compress_many_impl(compat::span<const pressio_data* const> const& inputs,
                                   compat::span<const pressio_data* const> const& outputs, int rc);
 
  virtual int begin_decompress_many_impl(compat::span<const pressio_data* const> const& inputs,
                                   compat::span<const pressio_data* const> const& outputs);
 
  virtual int end_decompress_many_impl(compat::span<const pressio_data* const> const& inputs,
                                   compat::span<const pressio_data* const> const& outputs, int rc);
 
 
//  virtual pressio_options get_metrics_results_impl(pressio_options const &options)=0;
};
 
struct pressio_metrics {
 
  pressio_metrics(std::unique_ptr<libpressio_metrics_plugin>&& metrics): plugin(std::move(metrics)) {}
  pressio_metrics(std::shared_ptr<libpressio_metrics_plugin>&& metrics): plugin(std::move(metrics)) {}
 
  pressio_metrics()=default;
  pressio_metrics(pressio_metrics const& metrics): plugin(metrics->clone()) {}
  pressio_metrics& operator=(pressio_metrics const& metrics) {
    if(&metrics == this) return *this;
    plugin = metrics->clone();
    return *this;
  }
  pressio_metrics(pressio_metrics&& metrics)=default;
  pressio_metrics& operator=(pressio_metrics&& metrics)=default;
 
 
  libpressio_metrics_plugin* operator->() const noexcept {return plugin.get();}
  libpressio_metrics_plugin& operator*() const noexcept {return *plugin;}
  operator bool() const { return plugin.get() != nullptr; }
 
  private:
  std::shared_ptr<libpressio_metrics_plugin> plugin;
};
 
std::unique_ptr<libpressio_metrics_plugin> make_m_composite(std::vector<pressio_metrics>&& plugins); 
 
 
#endif