dunedaq::confmodel::DummyApplication Class Reference

#include <DummyApplication.hpp>

Inheritance diagram for dunedaq::confmodel::DummyApplication:

Collaboration diagram for dunedaq::confmodel::DummyApplication:

Public Member Functions
virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the DummyApplication 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.
virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the DummyApplication 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.
Public Member Functions inherited from dunedaq::confmodel::Application
const std::string &	get_application_name () const
	Get "application_name" attribute value. Name of the application binary to run.
void	set_application_name (const std::string &value)
	Set "application_name" attribute value. Name of the application binary to run.
const std::vector< std::string > &	get_commandline_parameters () const
	Get "commandline_parameters" attribute value. command line parameters to add when starting the application.
void	set_commandline_parameters (const std::vector< std::string > &value)
	Set "commandline_parameters" attribute value. command line parameters to add when starting the application.
const std::string &	get_log_path () const
	Get "log_path" attribute value. Where the applications, controllers and infrastructure applications stdout/err go. This take precedence over the Session's log_path. If none of them is set, PWD is used.
void	set_log_path (const std::string &value)
	Set "log_path" attribute value. Where the applications, controllers and infrastructure applications stdout/err go. This take precedence over the Session's log_path. If none of them is set, PWD is used.
const std::vector< const dunedaq::confmodel::VariableBase * > &	get_application_environment () const
	Get "application_environment" relationship value. Define process environment for this application.
void	set_application_environment (const std::vector< const dunedaq::confmodel::VariableBase * > &value)
	Set "application_environment" relationship value. Define process environment for this application.
const dunedaq::confmodel::VirtualHost *	get_runs_on () const
	Get "runs_on" relationship value. VirtualHost to run this application on.
void	set_runs_on (const dunedaq::confmodel::VirtualHost *value)
	Set "runs_on" relationship value. VirtualHost to run this application on.
const std::vector< const dunedaq::confmodel::Service * > &	get_exposes_service () const
	Get "exposes_service" relationship value. Services exposed i.e. provided by this application.
void	set_exposes_service (const std::vector< const dunedaq::confmodel::Service * > &value)
	Set "exposes_service" relationship value. Services exposed i.e. provided by this application.
const dunedaq::confmodel::OpMonConf *	get_opmon_conf () const
	Get "opmon_conf" relationship value. description of the monitoring behaviour in the application.
void	set_opmon_conf (const dunedaq::confmodel::OpMonConf *value)
	Set "opmon_conf" relationship value. description of the monitoring behaviour in the application.
const std::vector< std::string >	parse_commandline_parameters () const
const std::string &	get_application_name () const
	Get "application_name" attribute value. Name of the application binary to run.
void	set_application_name (const std::string &value)
	Set "application_name" attribute value. Name of the application binary to run.
const std::vector< std::string > &	get_commandline_parameters () const
	Get "commandline_parameters" attribute value. command line parameters to add when starting the application.
void	set_commandline_parameters (const std::vector< std::string > &value)
	Set "commandline_parameters" attribute value. command line parameters to add when starting the application.
const std::string &	get_log_path () const
	Get "log_path" attribute value. Where the applications, controllers and infrastructure applications stdout/err go. This take precedence over the Session's log_path. If none of them is set, PWD is used.
void	set_log_path (const std::string &value)
	Set "log_path" attribute value. Where the applications, controllers and infrastructure applications stdout/err go. This take precedence over the Session's log_path. If none of them is set, PWD is used.
const std::vector< const dunedaq::confmodel::VariableBase * > &	get_application_environment () const
	Get "application_environment" relationship value. Define process environment for this application.
void	set_application_environment (const std::vector< const dunedaq::confmodel::VariableBase * > &value)
	Set "application_environment" relationship value. Define process environment for this application.
const dunedaq::confmodel::VirtualHost *	get_runs_on () const
	Get "runs_on" relationship value. VirtualHost to run this application on.
void	set_runs_on (const dunedaq::confmodel::VirtualHost *value)
	Set "runs_on" relationship value. VirtualHost to run this application on.
const std::vector< const dunedaq::confmodel::Service * > &	get_exposes_service () const
	Get "exposes_service" relationship value. Services exposed i.e. provided by this application.
void	set_exposes_service (const std::vector< const dunedaq::confmodel::Service * > &value)
	Set "exposes_service" relationship value. Services exposed i.e. provided by this application.
const dunedaq::confmodel::OpMonConf *	get_opmon_conf () const
	Get "opmon_conf" relationship value. description of the monitoring behaviour in the application.
void	set_opmon_conf (const dunedaq::confmodel::OpMonConf *value)
	Set "opmon_conf" relationship value. description of the monitoring behaviour in the application.
const std::vector< std::string >	parse_commandline_parameters () const
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.
Public Member Functions inherited from dunedaq::confmodel::Resource
void	parents (const dunedaq::confmodel::Session &session, std::list< std::vector< const dunedaq::confmodel::Resource * > > &parents) const
bool	is_disabled (const dunedaq::confmodel::ResourceTree &session) const
virtual bool	compute_disabled_state (const std::set< std::string > &) const
void	parents (const dunedaq::confmodel::Session &session, std::list< std::vector< const dunedaq::confmodel::Resource * > > &parents) const
bool	is_disabled (const dunedaq::confmodel::ResourceTree &session) const
virtual bool	compute_disabled_state (const std::set< std::string > &) const

Static Public Attributes
static const std::string &	s_class_name
Static Public Attributes inherited from dunedaq::confmodel::Application
static const std::string &	s_class_name
static const std::string	s_application_name = "application_name"
static const std::string	s_commandline_parameters = "commandline_parameters"
static const std::string	s_log_path = "log_path"
static const std::string	s_application_environment = "application_environment"
static const std::string	s_runs_on = "runs_on"
static const std::string	s_exposes_service = "exposes_service"
static const std::string	s_opmon_conf = "opmon_conf"
Static Public Attributes inherited from dunedaq::confmodel::Resource
static const std::string &	s_class_name

Protected Member Functions
	DummyApplication (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~DummyApplication () 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
	DummyApplication (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~DummyApplication () 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::confmodel::Application
	Application (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~Application () noexcept
bool	get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const
	Application (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~Application () noexcept
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.
Protected Member Functions inherited from dunedaq::confmodel::Resource
	Resource (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~Resource () noexcept
bool	get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const
	Resource (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~Resource () noexcept
bool	get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const

Friends
class	conffwk::Configuration
class	conffwk::DalObject
class	conffwk::DalFactory
class	conffwk::DalRegistry

Additional Inherited Members
Static Public Member Functions inherited from dunedaq::confmodel::Application
static const std::string &	__get_application_name_str () noexcept
static const std::string &	__get_commandline_parameters_str () noexcept
static const std::string &	__get_log_path_str () noexcept
static const std::string &	__get_application_environment_str () noexcept
static const std::string &	__get_runs_on_str () noexcept
static const std::string &	__get_exposes_service_str () noexcept
static const std::string &	__get_opmon_conf_str () noexcept
static const std::string &	__get_application_name_str () noexcept
static const std::string &	__get_commandline_parameters_str () noexcept
static const std::string &	__get_log_path_str () noexcept
static const std::string &	__get_application_environment_str () noexcept
static const std::string &	__get_runs_on_str () noexcept
static const std::string &	__get_exposes_service_str () noexcept
static const std::string &	__get_opmon_conf_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
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 24 of file DummyApplication.hpp.

Constructor & Destructor Documentation

DummyApplication() [1/2]

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

protectednoexcept

Definition at line 26 of file DummyApplication.cpp.

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

~DummyApplication() [1/2]

dunedaq::confmodel::DummyApplication::~DummyApplication ( )

protectedvirtualnoexcept

Definition at line 65 of file DummyApplication.cpp.

    {
    }

DummyApplication() [2/2]

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

protectednoexcept

~DummyApplication() [2/2]

virtual dunedaq::confmodel::DummyApplication::~DummyApplication ( )

protectedvirtualnoexcept

Member Function Documentation

get() [1/4]

std::vector< const dunedaq::conffwk::DalObject * > dunedaq::confmodel::DummyApplication::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

Reimplemented from dunedaq::confmodel::Application.

Definition at line 69 of file DummyApplication.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::DummyApplication::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

Reimplemented from dunedaq::confmodel::Application.

get() [3/4]

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

protected

Definition at line 79 of file DummyApplication.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 (Application::get(name, vec, upcast_unregistered, false)) return true;
      if (Resource::get(name, vec, upcast_unregistered, false)) return true;
 
      if (first_call)
        return get_algo_objects(name, vec);
 
      return false;
    }

get() [4/4]

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

protected

init() [1/2]

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

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children

if true, initialize referenced objects

Reimplemented from dunedaq::confmodel::Application.

Definition at line 57 of file DummyApplication.cpp.

    {
      Application::init(init_children);
      Resource::init(init_children);
 
      TLOG_DEBUG(5) << "read object " << this << " (class " << s_class_name << ')';
    }

init() [2/2]

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

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children

if true, initialize referenced objects

Reimplemented from dunedaq::confmodel::Application.

print() [1/2]

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

virtual

Print details of the DummyApplication 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

Reimplemented from dunedaq::confmodel::Application.

Definition at line 36 of file DummyApplication.cpp.

    {
      check_init();
 
      try {
 
        if (print_header)
          p_hdr(s, indent, s_class_name, "dunedaq::confmodel");
 
 
          // print direct super-classes
 
        dunedaq::confmodel::Application::print(indent, false, s);
        dunedaq::confmodel::Resource::print(indent, false, s);
      }
      catch (dunedaq::conffwk::Exception & ex) {
        dunedaq::conffwk::DalObject::p_error(s, ex);
      }
    }

print() [2/2]

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

virtual

Print details of the DummyApplication 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

Reimplemented from dunedaq::confmodel::Application.

Friends And Related Symbol Documentation

conffwk::Configuration

conffwk::Configuration

friend

Definition at line 26 of file DummyApplication.hpp.

conffwk::DalFactory

conffwk::DalFactory

friend

Definition at line 28 of file DummyApplication.hpp.

conffwk::DalObject

conffwk::DalObject

friend

Definition at line 27 of file DummyApplication.hpp.

conffwk::DalRegistry

conffwk::DalRegistry

friend

Definition at line 29 of file DummyApplication.hpp.

Member Data Documentation

s_class_name

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

static

The name of the configuration class.

Definition at line 41 of file DummyApplication.hpp.

---

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

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