method.hpp

Go to the documentation of this file.

// DUNE DAQ modification notice:
// This file has been modified from the original ATLAS oks source for the DUNE DAQ project.
// Fork baseline commit: oks-08-03-04 (2022-04-14).
// Renamed since fork: yes (from oks/method.h to include/oks/method.hpp).

 
#ifndef OKS_METHOD_H
#define OKS_METHOD_H
 
#include <string>
#include <list>
 
#include "oks/defs.hpp"
 
namespace dunedaq {
namespace oks {
 
class   OksXmlOutputStream;
class   OksXmlInputStream;
class   OksClass;
class   OksMethod;
 


 
class OksMethodImplementation
{
  friend class OksKernel;
  friend class OksMethod;
 
 
  public:

 
    OksMethodImplementation(const std::string& language, const std::string& prototype, const std::string& body, OksMethod * p = nullptr);
 
    bool operator==(const class OksMethodImplementation &) const;
    friend std::ostream& operator<<(std::ostream&, const OksMethodImplementation&);
 

 
    const std::string& get_language() const noexcept {return p_language;}
 

 
    void set_language(const std::string& language);
 

 
    const std::string& get_prototype() const noexcept {return p_prototype;}
 

 
    void set_prototype(const std::string& prototype);
 

 
    const std::string& get_body() const noexcept {return p_body;}
 

 
    void set_body(const std::string& body);
 
 
  private:
 
    std::string p_language;
    std::string p_prototype;
    std::string p_body;
    
    OksMethod * p_method;
 
 
      // to be used by OksMethod only
 
    OksMethodImplementation(OksXmlInputStream &, OksMethod *);
    void save(OksXmlOutputStream &) const;
 
 
      // valid xml tags and attributes
 
    static const char method_impl_xml_tag[];
    static const char language_xml_attr[];
    static const char prototype_xml_attr[];
    static const char body_xml_attr[];
 
 
};
 


 
class OksMethod
{
  friend class OksKernel;
  friend class OksClass;
  friend class OksMethodImplementation;
 
 
  public:

      
    OksMethod(const std::string& name, OksClass * p = nullptr);
 

 
    OksMethod(const std::string& name, const std::string& description, OksClass * p = nullptr);
 
 
    ~OksMethod();
 
    bool operator==(const class OksMethod &) const;
    friend std::ostream& operator<<(std::ostream&, const OksMethod&);
 

 
    const std::string& get_name() const noexcept {return p_name;}
 

 
    void set_name(const std::string& name);
 

 
    const std::string& get_description() const noexcept {return p_description;}
 

 
    void set_description(const std::string& description);
 

 
    const std::list<OksMethodImplementation *> * implementations() const noexcept {return p_implementations;}
 

 
    OksMethodImplementation * find_implementation(const std::string& language) const;
 
 

 
    void add_implementation(const std::string& language, const std::string& prototype, const std::string& body);
 

 
    void remove_implementation(const std::string& language);
 
 
  private:
 
    OksClass *  p_class;
    std::string p_name;
    std::string p_description;
    std::list<OksMethodImplementation *> * p_implementations;
 
 
      // to be used by OksClass only
 
    OksMethod (OksXmlInputStream &, OksClass*);
    void save(OksXmlOutputStream &) const;
 
 
      // valid xml tags and attributes
 
    static const char method_xml_tag[];
    static const char name_xml_attr[];
    static const char description_xml_attr[];
 
};
 
} // namespace oks
} // namespace dunedaq
 
#endif