#include <FSMCommand.hpp>

Inheritance diagram for dunedaq::confmodel::FSMCommand:

Collaboration diagram for dunedaq::confmodel::FSMCommand:

Public Member Functions
virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the FSMCommand object.

virtual std::vector< const dunedaq::conffwk::DalObject * >	get (const std::string &name, bool upcast_unregistered=true) const
	Get values of relationships and results of some algorithms as a vector of dunedaq::conffwk::DalObject pointers.

const std::string &	get_cmd () const
	Get "cmd" attribute value.

void	set_cmd (const std::string &value)
	Set "cmd" attribute value.

bool	get_optional () const
	Get "optional" attribute value.

void	set_optional (bool value)
	Set "optional" attribute value.

virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the FSMCommand object.

virtual std::vector< const dunedaq::conffwk::DalObject * >	get (const std::string &name, bool upcast_unregistered=true) const
	Get values of relationships and results of some algorithms as a vector of dunedaq::conffwk::DalObject pointers.

const std::string &	get_cmd () const
	Get "cmd" attribute value.

void	set_cmd (const std::string &value)
	Set "cmd" attribute value.

bool	get_optional () const
	Get "optional" attribute value.

void	set_optional (bool value)
	Set "optional" attribute value.

Public Member Functions inherited from dunedaq::conffwk::DalObject
const std::string &	UID () const noexcept

const std::string &	class_name () const noexcept

bool	castable (const std::string &target) const noexcept

bool	castable (const std::string *target) const noexcept

template<class TARGET >
const TARGET *	cast () const noexcept
	Casts object to different class.

std::string	full_name () const noexcept

const ConfigObject &	config_object () const

DalRegistry &	registry () const noexcept

Configuration &	configuration () const noexcept

void	unread ()

void	set (const ConfigObject &o) noexcept

void	move (const std::string &at)

void	rename (const std::string &new_id)

void	p_hdr (std::ostream &s, unsigned int indent, const std::string &cl, const char *nm=nullptr) const
	print object headers

std::ostream &	print_object (std::ostream &s) const
	print object details

void	throw_init_ex (dunedaq::conffwk::Exception &ex)
	throw object initialisation exception (i.e.

Static Public Member Functions
static const std::string &	__get_cmd_str () noexcept

static const std::string &	__get_optional_str () noexcept

static const std::string &	__get_cmd_str () noexcept

static const std::string &	__get_optional_str () noexcept

Static Public Member Functions inherited from dunedaq::conffwk::DalObject
static void	p_null (std::ostream &s)
	print "(null)"

static void	p_rm (std::ostream &s)
	print "(deleted object)"

static void	p_error (std::ostream &s, dunedaq::conffwk::Exception &ex)
	print error text

static void	throw_get_ex (const std::string &what, const std::string &class_name, const DalObject *obj)
	throw exception in generated get method (i.e.

static bool	is_null (const DalObject *ref) noexcept
	check a pointer on DAL object is null

Static Public Attributes
static const std::string &	s_class_name

static const std::string	s_cmd = "cmd"

static const std::string	s_optional = "optional"

Protected Member Functions
	FSMCommand (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept

virtual	~FSMCommand () noexcept

virtual void	init (bool init_children)

bool	get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const

	FSMCommand (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept

virtual	~FSMCommand () noexcept

virtual void	init (bool init_children)

bool	get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const

Protected Member Functions inherited from dunedaq::conffwk::DalObject
	DalObject (DalRegistry &db, const ConfigObject &o) noexcept

virtual	~DalObject ()

void	clear () noexcept

void	check () const

bool	is_deleted () const

void	increment_created () noexcept

void	increment_read () noexcept

void	check_init () const
	Check and initialize object if necessary.

template<typename T >
void	_set_object (const std::string &name, const T *value)
	Helper method for generated set single-value relationship methods.

template<typename T >
void	_set_objects (const std::string &name, const std::vector< const T * > &value)
	Helper method for generated set multi-value relationship methods.

bool	get_rel_objects (const std::string &name, bool upcast_unregistered, std::vector< const DalObject * > &objs) const
	Read relationship values as DAL objects using DAL factory.

bool	get_algo_objects (const std::string &name, std::vector< const DalObject * > &objs) const
	Run algorithm and return result as DAL objects using DAL factory.

Private Attributes
std::string	m_cmd

bool	m_optional

Friends
class	conffwk::Configuration

class	conffwk::DalObject

class	conffwk::DalFactory

class	conffwk::DalRegistry

Additional Inherited Members
Protected Attributes inherited from dunedaq::conffwk::DalObject
std::mutex	m_mutex
	Used to protect changes of DAL object.

bool	p_was_read
	is true, if the object was read

DalRegistry &	p_registry
	Configuration object.

ConfigObject	p_obj
	Config object used by given template object.

std::string	p_UID
	Is used for template objects (see dqm_conffwk)

Detailed Description

Definition at line 20 of file FSMCommand.hpp.

Constructor & Destructor Documentation

◆ FSMCommand() [1/2]

dunedaq::confmodel::FSMCommand::FSMCommand	(	conffwk::DalRegistry &	db,
		const conffwk::ConfigObject &	obj )

protectednoexcept

Definition at line 26 of file FSMCommand.cpp.

                                                                                        :
      dunedaq::conffwk::DalObject(db, o)
    {
      ;
    }

◆ ~FSMCommand() [1/2]

dunedaq::confmodel::FSMCommand::~FSMCommand ( )

protectedvirtualnoexcept

Definition at line 70 of file FSMCommand.cpp.

71 {

72 }

◆ FSMCommand() [2/2]

dunedaq::confmodel::FSMCommand::FSMCommand	(	conffwk::DalRegistry &	db,
		const conffwk::ConfigObject &	obj )

protectednoexcept

◆ ~FSMCommand() [2/2]

virtual dunedaq::confmodel::FSMCommand::~FSMCommand ( )

protectedvirtualnoexcept

Member Function Documentation

◆ __get_cmd_str() [1/2]

static const std::string & dunedaq::confmodel::FSMCommand::__get_cmd_str ( )

inlinestaticnoexcept

Definition at line 82 of file FSMCommand.hpp.

82{ return s_cmd; }

dunedaq::confmodel::FSMCommand::s_cmd

static const std::string s_cmd

Definition FSMCommand.hpp:79

◆ __get_cmd_str() [2/2]

static const std::string & dunedaq::confmodel::FSMCommand::__get_cmd_str ( )

inlinestaticnoexcept

Definition at line 82 of file FSMCommand.hpp.

82{ return s_cmd; }

◆ __get_optional_str() [1/2]

static const std::string & dunedaq::confmodel::FSMCommand::__get_optional_str ( )

inlinestaticnoexcept

Definition at line 83 of file FSMCommand.hpp.

83{ return s_optional; }

dunedaq::confmodel::FSMCommand::s_optional

static const std::string s_optional

Definition FSMCommand.hpp:80

◆ __get_optional_str() [2/2]

static const std::string & dunedaq::confmodel::FSMCommand::__get_optional_str ( )

inlinestaticnoexcept

Definition at line 83 of file FSMCommand.hpp.

83{ return s_optional; }

◆ get() [1/4]

std::vector< const dunedaq::conffwk::DalObject * > dunedaq::confmodel::FSMCommand::get	(	const std::string &	name,
		bool	upcast_unregistered = true ) const

virtual

Get values of relationships and results of some algorithms as a vector of dunedaq::conffwk::DalObject pointers.

Parameters are:

Parameters

name	name of the relationship or algorithm

Returns: value of relationship or result of algorithm

Exceptions

std::exception if there is no relationship or algorithm with such name in this and base classes

Implements dunedaq::conffwk::DalObject.

Definition at line 74 of file FSMCommand.cpp.

    {
      std::vector<const dunedaq::conffwk::DalObject *> vec;
 
      if (!get(name, vec, upcast_unregistered, true))
        throw_get_ex(name, s_class_name, this);
 
      return vec;
    }

◆ get() [2/4]

virtual std::vector< const dunedaq::conffwk::DalObject * > dunedaq::confmodel::FSMCommand::get	(	const std::string &	name,
		bool	upcast_unregistered = true ) const

virtual

Get values of relationships and results of some algorithms as a vector of dunedaq::conffwk::DalObject pointers.

Parameters are:

Parameters

name	name of the relationship or algorithm

Returns: value of relationship or result of algorithm

Exceptions

std::exception if there is no relationship or algorithm with such name in this and base classes

Implements dunedaq::conffwk::DalObject.

◆ get() [3/4]

bool dunedaq::confmodel::FSMCommand::get	(	const std::string &	name,
		std::vector< const dunedaq::conffwk::DalObject * > &	vec,
		bool	upcast_unregistered,
		bool	first_call ) const

protected

Definition at line 84 of file FSMCommand.cpp.

    {
      if (first_call)
        {
          std::lock_guard scoped_lock(m_mutex);
 
          check();
          check_init();
 
          if (get_rel_objects(name, upcast_unregistered, vec))
            return true;
        }
 
      if (first_call)
        return get_algo_objects(name, vec);
 
      return false;
    }

◆ get() [4/4]

bool dunedaq::confmodel::FSMCommand::get	(	const std::string &	name,
		std::vector< const dunedaq::conffwk::DalObject * > &	vec,
		bool	upcast_unregistered,
		bool	first_call ) const

protected

◆ get_cmd() [1/2]

const std::string & dunedaq::confmodel::FSMCommand::get_cmd ( ) const

inline

Get "cmd" attribute value.

Returns: the attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 93 of file FSMCommand.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            check_init();
            return m_cmd;
          }

◆ get_cmd() [2/2]

const std::string & dunedaq::confmodel::FSMCommand::get_cmd ( ) const

inline

Get "cmd" attribute value.

Returns: the attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 93 of file FSMCommand.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            check_init();
            return m_cmd;
          }

◆ get_optional() [1/2]

bool dunedaq::confmodel::FSMCommand::get_optional ( ) const

inline

Get "optional" attribute value.

Returns: the attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 124 of file FSMCommand.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            check_init();
            return m_optional;
          }

◆ get_optional() [2/2]

bool dunedaq::confmodel::FSMCommand::get_optional ( ) const

inline

Get "optional" attribute value.

Returns: the attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 124 of file FSMCommand.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            check_init();
            return m_optional;
          }

◆ init() [1/2]

void dunedaq::confmodel::FSMCommand::init ( bool init_children )

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children if true, initialize referenced objects

Implements dunedaq::conffwk::DalObject.

Definition at line 55 of file FSMCommand.cpp.

    {
      p_was_read = true;
      increment_read();
      TLOG_DEBUG(5) << "read object " << this << " (class " << s_class_name << ')';
 
      try {
        p_obj.get(s_cmd, m_cmd);
        p_obj.get(s_optional, m_optional);
      }
      catch (dunedaq::conffwk::Exception & ex) {
        throw_init_ex(ex);
      }
    }

◆ init() [2/2]

virtual void dunedaq::confmodel::FSMCommand::init ( bool init_children )

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children if true, initialize referenced objects

Implements dunedaq::conffwk::DalObject.

◆ print() [1/2]

void dunedaq::confmodel::FSMCommand::print	(	unsigned int	offset,
		bool	print_header,
		std::ostream &	s ) const

virtual

Print details of the FSMCommand object.

Parameters are:

Parameters

offset	number of spaces to shift object right (useful to print nested objects)
print_header	if false, do not print object header (to print attributes of base classes)
s	output stream

Implements dunedaq::conffwk::DalObject.

Definition at line 33 of file FSMCommand.cpp.

    {
      check_init();
 
      try {
        const std::string str(indent+2, ' ');
 
        if (print_header)
          p_hdr(s, indent, s_class_name, "dunedaq::confmodel");
 
 
          // print direct attributes
 
        dunedaq::conffwk::p_sv_attr(s, str, s_cmd, m_cmd);
        dunedaq::conffwk::p_sv_attr(s, str, s_optional, m_optional);
      }
      catch (dunedaq::conffwk::Exception & ex) {
        dunedaq::conffwk::DalObject::p_error(s, ex);
      }
    }

◆ print() [2/2]

virtual void dunedaq::confmodel::FSMCommand::print	(	unsigned int	offset,
		bool	print_header,
		std::ostream &	s ) const

virtual

Print details of the FSMCommand object.

Parameters are:

Parameters

offset	number of spaces to shift object right (useful to print nested objects)
print_header	if false, do not print object header (to print attributes of base classes)
s	output stream

Implements dunedaq::conffwk::DalObject.

◆ set_cmd() [1/2]

void dunedaq::confmodel::FSMCommand::set_cmd ( const std::string & value )

inline

Set "cmd" attribute value.

Parameters

value new attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 108 of file FSMCommand.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            clear();
            p_obj.set_by_ref(s_cmd, value);
          }

◆ set_cmd() [2/2]

void dunedaq::confmodel::FSMCommand::set_cmd ( const std::string & value )

inline

Set "cmd" attribute value.

Parameters

value new attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 108 of file FSMCommand.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            clear();
            p_obj.set_by_ref(s_cmd, value);
          }

◆ set_optional() [1/2]

void dunedaq::confmodel::FSMCommand::set_optional ( bool value )

inline

Set "optional" attribute value.

Parameters

value new attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 139 of file FSMCommand.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            clear();
            p_obj.set_by_val(s_optional, value);
          }

◆ set_optional() [2/2]

void dunedaq::confmodel::FSMCommand::set_optional ( bool value )

inline

Set "optional" attribute value.

Parameters

value new attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 139 of file FSMCommand.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            clear();
            p_obj.set_by_val(s_optional, value);
          }

Friends And Related Symbol Documentation

◆ conffwk::Configuration

conffwk::Configuration

friend

Definition at line 22 of file FSMCommand.hpp.

◆ conffwk::DalFactory

conffwk::DalFactory

friend

Definition at line 24 of file FSMCommand.hpp.

◆ conffwk::DalObject

conffwk::DalObject

friend

Definition at line 23 of file FSMCommand.hpp.

◆ conffwk::DalRegistry

conffwk::DalRegistry

friend

Definition at line 25 of file FSMCommand.hpp.

Member Data Documentation

◆ m_cmd

std::string dunedaq::confmodel::FSMCommand::m_cmd

private

Definition at line 71 of file FSMCommand.hpp.

◆ m_optional

bool dunedaq::confmodel::FSMCommand::m_optional

private

Definition at line 72 of file FSMCommand.hpp.

◆ s_class_name

static const std::string & dunedaq::confmodel::FSMCommand::s_class_name

static

The name of the configuration class.

Definition at line 37 of file FSMCommand.hpp.

◆ s_cmd

static const std::string dunedaq::confmodel::FSMCommand::s_cmd = "cmd"

inlinestatic

Definition at line 79 of file FSMCommand.hpp.

◆ s_optional

static const std::string dunedaq::confmodel::FSMCommand::s_optional = "optional"

inlinestatic

Definition at line 80 of file FSMCommand.hpp.

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

/github/workspace/dunedaq/build/confmodel/codegen/include/confmodel/FSMCommand.hpp
/github/workspace/dunedaq/build/confmodel/codegen/src/FSMCommand.hpp
/github/workspace/dunedaq/build/confmodel/codegen/src/FSMCommand.cpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FSMCommand() [1/2]

◆ ~FSMCommand() [1/2]

◆ FSMCommand() [2/2]

◆ ~FSMCommand() [2/2]

Member Function Documentation

◆ __get_cmd_str() [1/2]

◆ __get_cmd_str() [2/2]

◆ __get_optional_str() [1/2]

◆ __get_optional_str() [2/2]

◆ get() [1/4]

◆ get() [2/4]

◆ get() [3/4]

◆ get() [4/4]

◆ get_cmd() [1/2]

◆ get_cmd() [2/2]

◆ get_optional() [1/2]

◆ get_optional() [2/2]

◆ init() [1/2]

◆ init() [2/2]

◆ print() [1/2]

◆ print() [2/2]

◆ set_cmd() [1/2]

◆ set_cmd() [2/2]

◆ set_optional() [1/2]

◆ set_optional() [2/2]

Friends And Related Symbol Documentation

◆ conffwk::Configuration

◆ conffwk::DalFactory

◆ conffwk::DalObject

◆ conffwk::DalRegistry

Member Data Documentation

◆ m_cmd

◆ m_optional

◆ s_class_name

◆ s_cmd

◆ s_optional