dunedaq::oks::OksMethodImplementation Class Reference

OKS method implementation class. More...

#include <method.hpp>

Collaboration diagram for dunedaq::oks::OksMethodImplementation:

Public Member Functions
	OksMethodImplementation (const std::string &language, const std::string &prototype, const std::string &body, OksMethod *p=nullptr)
	OKS method implementation constructor.
bool	operator== (const class OksMethodImplementation &) const
const std::string &	get_language () const noexcept
void	set_language (const std::string &language)
	Set method implementation language.
const std::string &	get_prototype () const noexcept
void	set_prototype (const std::string &prototype)
	Set method implementation prototype.
const std::string &	get_body () const noexcept
void	set_body (const std::string &body)
	Set method implementation body.

Private Member Functions
	OksMethodImplementation (OksXmlInputStream &, OksMethod *)
void	save (OksXmlOutputStream &) const

Private Attributes
std::string	p_language
std::string	p_prototype
std::string	p_body
OksMethod *	p_method

Static Private Attributes
static const char	method_impl_xml_tag [] = "method-implementation"
static const char	language_xml_attr [] = "language"
static const char	prototype_xml_attr [] = "prototype"
static const char	body_xml_attr [] = "body"

Friends
class	OksKernel
class	OksMethod
std::ostream &	operator<< (std::ostream &s, const OksMethodImplementation &i)

Detailed Description

OKS method implementation class.

An OKS method may have implementations on different languages (e.g. "c++", "java", etc.). Implementations linked with a method shall have different languages. The method implementations are used by oksdalgen package generating DAL.

Definition at line 38 of file method.hpp.

Constructor & Destructor Documentation

OksMethodImplementation() [1/2]

dunedaq::oks::OksMethodImplementation::OksMethodImplementation	(	const std::string &	language,
		const std::string &	prototype,
		const std::string &	body,
		OksMethod *	p = nullptr )

OKS method implementation constructor.

Create new OKS method implementation providing language, method prototype and body.

The parameters are:

Parameters

language	programming language used for given method implementation (max 16 bytes, see #s_max_language_length variable)
prototype	prototype of method implementation for selected programming language (max 1024 bytes, see #s_max_prototype_length variable)
body	optional body of method implementation (max 2048 bytes, see #s_max_body_length variable)

Exceptions

oks::exception

is thrown in case of problems.

Definition at line 28 of file method.cpp.

  : p_language(language)
  , p_prototype(prototype)
  , p_body(body)
  , p_method(p)
{
  oks::validate_not_empty(p_language, "method implementation language");
  oks::validate_not_empty(p_prototype, "method implementation prototype");
}

OksMethodImplementation() [2/2]

dunedaq::oks::OksMethodImplementation::OksMethodImplementation ( OksXmlInputStream & s, OksMethod * parent )

private

Definition at line 77 of file method.cpp.

  : p_method(parent)
{
  try {
    while (true) {
      OksXmlAttribute attr(s);
 
      // check for close of tag
 
      if (oks::cmp_str1(attr.name(), "/")) {
        break;
      }
 
      // check for known oks-method-implementation' attributes
 
      else if (oks::cmp_str8(attr.name(), language_xml_attr))
        p_language.assign(attr.value(), attr.value_len());
      else if (oks::cmp_str9(attr.name(), prototype_xml_attr))
        p_prototype.assign(attr.value(), attr.value_len());
      else if (oks::cmp_str4(attr.name(), body_xml_attr))
        p_body.assign(attr.value(), attr.value_len());
      else {
        s.throw_unexpected_attribute(attr.name());
      }
    }
  } catch (oks::exception& e) {
    throw oks::FailedRead("xml method implementation", e);
  } catch (std::exception& e) {
    throw oks::FailedRead("xml method implementation", e.what());
  }
 
  try {
    oks::validate_not_empty(p_language, "method implementation language");
    oks::validate_not_empty(p_prototype, "method implementation prototype");
  } catch (std::exception& ex) {
    throw oks::FailedRead("oks method implementation", oks::BadFileData(ex.what(), s.get_line_no(), s.get_line_pos()));
  }
}

Member Function Documentation

get_body()

const std::string & dunedaq::oks::OksMethodImplementation::get_body ( ) const

inlinenoexcept

Get body of method implementation.

Definition at line 101 of file method.hpp.

{ return p_body; }

get_language()

const std::string & dunedaq::oks::OksMethodImplementation::get_language ( ) const

inlinenoexcept

Get method implementation language.

Definition at line 69 of file method.hpp.

{ return p_language; }

get_prototype()

const std::string & dunedaq::oks::OksMethodImplementation::get_prototype ( ) const

inlinenoexcept

Get prototype of method implementation.

Definition at line 86 of file method.hpp.

{ return p_prototype; }

operator==()

bool dunedaq::oks::OksMethodImplementation::operator==

(

const class OksMethodImplementation &

i

)

const

Definition at line 42 of file method.cpp.

{
  return ((this == &i) || (p_language == i.p_language && p_prototype == i.p_prototype && p_body == i.p_body));
}

save()

void dunedaq::oks::OksMethodImplementation::save ( OksXmlOutputStream & s ) const

private

Definition at line 64 of file method.cpp.

{
  s.put("   ");
 
  s.put_start_tag(method_impl_xml_tag, sizeof(method_impl_xml_tag) - 1);
 
  s.put_attribute(language_xml_attr, sizeof(language_xml_attr) - 1, get_language().c_str());
  s.put_attribute(prototype_xml_attr, sizeof(prototype_xml_attr) - 1, get_prototype().c_str());
  s.put_attribute(body_xml_attr, sizeof(body_xml_attr) - 1, get_body().c_str());
 
  s.put_end_tag();
}

set_body()

void dunedaq::oks::OksMethodImplementation::set_body

(

const std::string &

body

)

Set method implementation body.

Parameters

body	new method implementation body (max 2048 bytes, see #s_max_body_length variable) In case of problems the oks::exception is thrown.

Exceptions

oks::exception

is thrown in case of problems.

Definition at line 486 of file method.cpp.

{
  if (p_body != s) {
    if (p_method && p_method->p_class)
      p_method->p_class->lock_file("OksMethodImplementation::set_body");
 
    p_body = s;
 
    if (p_method && p_method->p_class) {
      p_method->p_class->registrate_class_change(OksClass::ChangeMethodImplementation, (const void*)this);
    }
  }
}

set_language()

void dunedaq::oks::OksMethodImplementation::set_language

(

const std::string &

language

)

Set method implementation language.

Implementations linked with a method shall have different languages.

Parameters

language

new method implementation language (max 16 bytes, see #s_max_language_length variable) In case of problems the oks::exception is thrown.

Exceptions

oks::exception

is thrown in case of problems.

Definition at line 434 of file method.cpp.

{
  if (p_language != s) {
    if (p_method) {
      if (p_method->find_implementation(s) != 0) {
        std::ostringstream text;
        text << "cannot rename \"" << p_method->p_name << "\" method implementation to language \"" << s
             << "\" "
                "since the method already has implementation with such language.";
        throw oks::SetOperationFailed("OksMethodImplementation::set_language", text.str());
      }
 
      try {
        oks::validate_not_empty(s, "language");
      } catch (std::exception& ex) {
        throw oks::SetOperationFailed("OksMethodImplementation::set_language", ex.what());
      }
 
      if (p_method->p_class)
        p_method->p_class->lock_file("OksMethodImplementation::set_language");
    }
 
    p_language = s;
 
    if (p_method && p_method->p_class) {
      p_method->p_class->registrate_class_change(OksClass::ChangeMethodImplementation, (const void*)this);
    }
  }
}

set_prototype()

void dunedaq::oks::OksMethodImplementation::set_prototype

(

const std::string &

prototype

)

Set method implementation prototype.

Parameters

prototype

new method implementation prototype (max 1024 bytes, see #s_max_prototype_length variable) In case of problems the oks::exception is thrown.

Exceptions

oks::exception

is thrown in case of problems.

Definition at line 465 of file method.cpp.

{
  if (p_prototype != s) {
    try {
      oks::validate_not_empty(s, "prototype");
    } catch (std::exception& ex) {
      throw oks::SetOperationFailed("OksMethodImplementation::set_prototype", ex.what());
    }
 
    if (p_method && p_method->p_class)
      p_method->p_class->lock_file("OksMethodImplementation::set_prototype");
 
    p_prototype = s;
 
    if (p_method && p_method->p_class) {
      p_method->p_class->registrate_class_change(OksClass::ChangeMethodImplementation, (const void*)this);
    }
  }
}

Friends And Related Symbol Documentation

OksKernel

friend class OksKernel

friend

Definition at line 40 of file method.hpp.

OksMethod

friend class OksMethod

friend

Definition at line 41 of file method.hpp.

operator<<

std::ostream & operator<< ( std::ostream & s, const OksMethodImplementation & i )

friend

Definition at line 47 of file method.cpp.

{
  s << "  Method implementation:\n"
       "    language:  \""
    << i.get_language()
    << "\"\n"
       "    prototype: \""
    << i.get_prototype()
    << "\"\n"
       "    body:      \""
    << i.get_body() << "\"\n";
 
  return s;
}

Member Data Documentation

body_xml_attr

const char dunedaq::oks::OksMethodImplementation::body_xml_attr = "body"

staticprivate

Definition at line 131 of file method.hpp.

language_xml_attr

const char dunedaq::oks::OksMethodImplementation::language_xml_attr = "language"

staticprivate

Definition at line 129 of file method.hpp.

method_impl_xml_tag

const char dunedaq::oks::OksMethodImplementation::method_impl_xml_tag = "method-implementation"

staticprivate

Definition at line 128 of file method.hpp.

p_body

std::string dunedaq::oks::OksMethodImplementation::p_body

private

Definition at line 117 of file method.hpp.

p_language

std::string dunedaq::oks::OksMethodImplementation::p_language

private

Definition at line 115 of file method.hpp.

p_method

OksMethod* dunedaq::oks::OksMethodImplementation::p_method

private

Definition at line 119 of file method.hpp.

p_prototype

std::string dunedaq::oks::OksMethodImplementation::p_prototype

private

Definition at line 116 of file method.hpp.

prototype_xml_attr

const char dunedaq::oks::OksMethodImplementation::prototype_xml_attr = "prototype"

staticprivate

Definition at line 130 of file method.hpp.

---

The documentation for this class was generated from the following files:

• /github/workspace/dunedaq/sourcecode/oks/include/oks/method.hpp
• /github/workspace/dunedaq/sourcecode/oks/src/method.cpp