Component.h

Go to the documentation of this file.

#pragma once

// -- std headers
#include <typeindex>

// -- marlinmt headers
#include <marlinmt/Logging.h>
#include <marlinmt/Parameter.h>

namespace marlinmt {
  
  class Application ;
  
  class Component : public Configurable {
  public:    
    friend class Application ; 
    using LoggerPtr = Logging::Logger ;
    
  public:
    Component() = delete ;
    Component(const Component &) = delete ;
    Component &operator=(const Component &) = delete ;

    virtual ~Component() = default ;
    
    Component( const std::string &type ) ;
    
    const std::string &type() const ;
    
    const std::string &name() const ;
    
    void setName( const std::string &n ) ;
    
    const std::string &description() const ;
    
    void setDescription( const std::string &desc ) ;
    
    virtual void initialize() { /*nop*/ }
    
    const Application &application() const ;
    
    Application &application() ;
    
    template <class T>
    inline Logging::StreamType log() const {
      return _logger->log<T>() ;
    }
    
    Logging::StreamType debug() const ;
    
    Logging::StreamType message() const ;
    
    Logging::StreamType warning() const ;
    
    Logging::StreamType error() const ;
    
    void setVerbosity( const std::string &level ) ;
    
    const std::string &verbosity() const ;
    
    bool isInitialized() const ;
    
    void setup( Application *app ) ;
    
    void printParameters() const ;
    
    template <class T>
    void printParameters() const ;
    
    void setParameters( const ConfigSection &section, bool throwIfNotFound = false ) ;
    
    void getParameters( ConfigSection &section, const std::set<std::string> &exclude = {} ) const ;
        
  protected:
    std::string              _type {} ;
    std::string              _name {} ;
    std::string              _description {"No description"} ;
    Application             *_application {nullptr} ;
    LoggerPtr                _logger {nullptr} ;
    StringParameter          _verbosity { *this, "Verbosity", "The component verbosity level", "MESSAGE" } ;
  };
  
  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  
  template <class T>
  void Component::printParameters() const {
    log<T>() << name() << " (" << type() << ") parameters:" << std::endl ;
    for( auto iter : _parameters ) {
      auto paramStr = iter.second->isSet() ? iter.second->str() : ( iter.second->hasDefault() ? iter.second->defaultStr() :"[undefined]" ) ;
      log<T>() << iter.first << " (" << iter.second->typeStr() << "): " << paramStr << std::endl ;
    }
  }
  
}