IModuleBase.hpp

#pragma once
 
#include <opals/OptionsShared.hpp>
#include <opals/ParamList.hpp>
#include <opals/IControlObject.hpp>
 
namespace opals {
 
  /// Sets the name of the embedding software package.
  extern "C" OPALS_API void embeddingSoftware( const char *text );
 
  /// Abstract base class of all opals modules.
  class OPALS_API IModuleBase
  {
  public:
 
    /// Make sure to delete instances after use with Delete()
    virtual ~IModuleBase() {}
 
    /// Destroy modules allocated on the heap
    /** Make sure to delete instances after use in order to avoid memory leaks.
        This is done automatically when using std::shared_ptr in combination with opals::ModuleDeleter
        to manage memory, e.g.:
        \code
        std::shared_ptr< opals::IModuleBase > module( opals::IImport::New(), opals::ModuleDeleter() );
        \endcode
        That way, Delete() is called automatically when the std::shared_ptr goes out of scope.
        \internal
        calling Delete() is only necessary when instantiating a module from outside that module's DLL
        e.g. using
        \code
        opals::IImport::New()
        \endcode
         */
    virtual void Delete() = 0;
 
    /// Starts the actual module execution.
    /// \param reset if true, calls reset() right after execution has finished, thereby closing any open (file-) handles.
    virtual ParamList run( bool reset=false ) = 0;
 
    /// Resets the module to the state after construction.
    virtual void reset() = 0;
 
    /// \name Access global options: present in all modules.
    ///@{
    virtual       opts::glob::Options &globals()       = 0;
    virtual const opts::glob::Options &globals() const = 0;
    ///@}
 
    /// \name Access common options: present in all modules.
    ///@{
    virtual       opts::comm::Options &commons()       = 0;
    virtual const opts::comm::Options &commons() const = 0;
    ///@}
 
    /// \name Access the base type of module-specific options.
    ///@{
    virtual       opts::IBase &optsBase()       = 0;
    virtual const opts::IBase &optsBase() const = 0;
    ///@}
 
    /// Returns the module name.
    virtual opals::String name()          const = 0;
 
    /// Returns the module version.
    virtual opals::String version()       const = 0;
 
    /// Returns the special build version.
    virtual opals::String special_build() const = 0;
 
    /// Returns a string representing the compilation date and time.
    virtual opals::String compilation_date_time() const = 0;
 
    /// Sets module parameters from paramList according to parameter "paramMapping".
    virtual void mapParams( const ParamList &paramList ) = 0;
 
    /// Sets control object for retrieving status information during processing.
    virtual void set_controlObject( IControlObject &obj ) = 0;
    /// remove control object from the message queue
    virtual void unset_controlObject() = 0;
  };
 
};