RunHeader.h

Go to the documentation of this file.

#pragma once

// -- std headers
#include <string>
#include <map>

// -- marlinmt headers
#include <marlinmt/Extensions.h>
#include <marlinmt/Utils.h>

namespace marlinmt {

  class RunHeader {
    using ParameterMap = std::map<std::string, std::string> ;
    
  public:
    RunHeader() = default ;
    ~RunHeader() = default ;
    RunHeader(const RunHeader &) = delete ;
    RunHeader &operator=(const RunHeader &) = delete ;
    RunHeader(RunHeader &&) = default ;
    RunHeader &operator=(RunHeader &&) = default ;

    int runNumber() const ;

    RunHeader &setRunNumber( int n ) ;

    const std::string &description() const ;

    RunHeader &setDescription( const std::string &desc ) ;

    const std::string &detectorName() const ;

    RunHeader &setDetectorName( const std::string &det ) ;

    const ParameterMap &parameters() const ;

    ParameterMap &parameters() ;
    
    template <typename T>
    std::optional<T> parameter( const std::string &name ) const ;
    
    template <typename T>
    RunHeader &setParameter( const std::string &name, const T &value ) ;

    Extensions &extensions() ;

    const Extensions &extensions() const ;

  private:
    int                         _runNumber {0} ;
    std::string                 _detectorName {} ;
    std::string                 _description {} ;
    ParameterMap                _parameters {} ;
    Extensions                  _extensions {} ;
  };

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

  inline int RunHeader::runNumber() const {
    return _runNumber ;
  }

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

  inline RunHeader &RunHeader::setRunNumber( int n ) {
    _runNumber = n ;
    return *this ;
  }

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

  inline const std::string &RunHeader::description() const {
    return _description ;
  }

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

  inline RunHeader &RunHeader::setDescription( const std::string &desc ) {
    _description = desc ;
    return *this ;
  }

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

  inline const std::string &RunHeader::detectorName() const {
    return _detectorName ;
  }

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

  inline RunHeader &RunHeader::setDetectorName( const std::string &det ) {
    _detectorName = det ;
    return *this ;
  }

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

  inline const RunHeader::ParameterMap &RunHeader::parameters() const {
    return _parameters ;
  }

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

  inline RunHeader::ParameterMap &RunHeader::parameters() {
    return _parameters ;
  }
  
  //--------------------------------------------------------------------------
  
  template <typename T>
  inline std::optional<T> RunHeader::parameter( const std::string &name ) const {
    auto iter = _parameters.find( name ) ;
    if( _parameters.end() != iter ) {
      return details::convert<T>::from_string( iter->second ) ;
    }
    return std::nullopt ;
  }
  
  //--------------------------------------------------------------------------
  
  template <typename T>
  inline RunHeader &RunHeader::setParameter( const std::string &name, const T &value ) {
    _parameters[name] = details::convert<T>::to_string( value ) ;
    return *this ;
  }

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

  inline Extensions &RunHeader::extensions() {
    return _extensions ;
  }

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

  inline const Extensions &RunHeader::extensions() const {
    return _extensions ;
  }

}