ProcessorApi.h

Go to the documentation of this file.

#ifndef MARLINMT_PROCESSORAPI_h
#define MARLINMT_PROCESSORAPI_h 1

// -- std headers
#include <array>
#include <filesystem>
#include <optional>
#include <string>

// -- marlinmt headers
#include <marlinmt/Processor.h>
#include <marlinmt/Application.h>
#include <marlinmt/GeometryManager.h>
#include <marlinmt/BookStoreManager.h>
#include <marlinmt/MarlinMTConfig.h>


namespace marlinmt {

  class Processor ;

  class InternalClass;

  class ProcessorApi {
  public:
    // only static API
    ProcessorApi() = delete ;
    ~ProcessorApi() = delete ;

    class Book {
    public:
      // book histogram float

      [[nodiscard]] static H1FEntry bookHist1F (
        Processor *proc, 
        const std::filesystem::path &path, 
        const std::string_view &name,
        const std::string_view &title,
        const AxisConfigD &axisconfig,
        const BookFlag_t &flags  = BookFlags::Default ) ; 

      [[nodiscard]] static H2FEntry bookHist2F (
        Processor *proc, 
        const std::filesystem::path &path, 
        const std::string_view &name,
        const std::string_view &title,
        const AxisConfigD &axisconfigX,
        const AxisConfigD &axisconfigY,
        const BookFlag_t &flags  = BookFlags::Default ) ; 

      [[nodiscard]] static H3FEntry bookHist3F (
        Processor *proc, 
        const std::filesystem::path &path, 
        const std::string_view &name,
        const std::string_view &title,
        const AxisConfigD &axisconfigX,
        const AxisConfigD &axisconfigY,
        const AxisConfigD &axisconfigZ,
        const BookFlag_t &flags  = BookFlags::Default ) ; 

      // book histogram double

      [[nodiscard]] static H1DEntry bookHist1D (
        Processor *proc, 
        const std::filesystem::path &path, 
        const std::string_view &name,
        const std::string_view &title,
        const AxisConfigD &axisconfig,
        const BookFlag_t &flags  = BookFlags::Default ) ; 

      [[nodiscard]] static H2DEntry bookHist2D (
        Processor *proc, 
        const std::filesystem::path &path, 
        const std::string_view &name,
        const std::string_view &title,
        const AxisConfigD &axisconfigX,
        const AxisConfigD &axisconfigY,
        const BookFlag_t &flags  = BookFlags::Default ) ; 

      [[nodiscard]] static H3DEntry bookHist3D (
        Processor *proc, 
        const std::filesystem::path &path, 
        const std::string_view &name,
        const std::string_view &title,
        const AxisConfigD &axisconfigX,
        const AxisConfigD &axisconfigY,
        const AxisConfigD &axisconfigZ,
        const BookFlag_t &flags  = BookFlags::Default ) ; 

      // book histogram integer 
      
      [[nodiscard]] static H1IEntry bookHist1I (
        Processor *proc, 
        const std::filesystem::path &path, 
        const std::string_view &name,
        const std::string_view &title,
        const AxisConfigD &axisconfig,
        const BookFlag_t &flags  = BookFlags::Default ) ; 

      [[nodiscard]] static H2IEntry bookHist2I (
        Processor *proc, 
        const std::filesystem::path &path, 
        const std::string_view &name,
        const std::string_view &title,
        const AxisConfigD &axisconfigX,
        const AxisConfigD &axisconfigY,
        const BookFlag_t &flags  = BookFlags::Default ) ; 

      [[nodiscard]] static H3IEntry bookHist3I (
        Processor *proc, 
        const std::filesystem::path &path, 
        const std::string_view &name,
        const std::string_view &title,
        const AxisConfigD &axisconfigX,
        const AxisConfigD &axisconfigY,
        const AxisConfigD &axisconfigZ,
        const BookFlag_t &flags  = BookFlags::Default ) ; 

      // get histogram float

      [[nodiscard]] static H1FEntry getHist1F (
        const Processor *proc,
        const std::filesystem::path &path,
        const std::string_view &name ) ;

      [[nodiscard]] static H2FEntry getHist2F (
        const Processor *proc,
        const std::filesystem::path &path,
        const std::string_view &name ) ;

      [[nodiscard]] static H3FEntry getHist3F (
        const Processor *proc,
        const std::filesystem::path &path,
        const std::string_view &name ) ;

      // get histogram double

      [[nodiscard]] static H1DEntry getHist1D (
        const Processor *proc,
        const std::filesystem::path &path,
        const std::string_view &name ) ;

      [[nodiscard]] static H2DEntry getHist2D (
        const Processor *proc,
        const std::filesystem::path &path,
        const std::string_view &name ) ;

      [[nodiscard]] static H3DEntry getHist3D (
        const Processor *proc,
        const std::filesystem::path &path,
        const std::string_view &name ) ;

      // get histogram integer

      [[nodiscard]] static H1IEntry getHist1I (
        const Processor *proc,
        const std::filesystem::path &path,
        const std::string_view &name ) ;

      [[nodiscard]] static H2IEntry getHist2I (
        const Processor *proc,
        const std::filesystem::path &path,
        const std::string_view &name ) ;

      [[nodiscard]] static H3IEntry getHist3I (
        const Processor *proc,
        const std::filesystem::path &path,
        const std::string_view &name ) ;



      static void write(
          Processor * proc, 
          const std::filesystem::path &path,
          const std::string_view &name) ;

      static void dontWrite(
          Processor * proc, 
          const std::filesystem::path &path,
          const std::string_view &name) ;

      static void write(
          Processor *proc,
          const book::EntryKey &key) ;

      static void dontWrite(
          Processor *proc,
          const book::EntryKey &key) ;
    };

    static void registerForRandomSeeds( Processor *const proc ) ;

    static unsigned int getRandomSeed( const Processor *const proc, EventStore *event ) ;

    static void setReturnValue( const Processor *const proc, EventStore *event, bool value ) ;

    static void setReturnValue( const Processor *const proc, EventStore *event, const std::string &name, bool value ) ;

    static bool isFirstEvent( EventStore *event ) ;

    template <typename HANDLER>
    static const HANDLER* geometry( const Processor *const proc ) ;

    static void skipCurrentEvent( const Processor *const proc ) ;

    static void abort( const Processor *const proc, const std::string &reason ) ;
  };

  //--------------------------------------------------------------------------

  template <typename HANDLER>
  inline const HANDLER* ProcessorApi::geometry( const Processor *const proc ) {
    return proc->application().geometryManager().geometry<HANDLER>() ;
  }

}

#endif