#include <CIBApplication.hpp>

Inheritance diagram for dunedaq::appmodel::CIBApplication:

Collaboration diagram for dunedaq::appmodel::CIBApplication:

Public Member Functions
virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the CIBApplication 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 dunedaq::appmodel::CIBConf *	get_generator () const
	Get "generator" relationship value.

void	set_generator (const dunedaq::appmodel::CIBConf *value)
	Set "generator" relationship value.

const dunedaq::appmodel::CIBoardConf *	get_board () const
	Get "board" relationship value.

void	set_board (const dunedaq::appmodel::CIBoardConf *value)
	Set "board" relationship value.

const dunedaq::appmodel::DataHandlerConf *	get_link_handler () const
	Get "link_handler" relationship value.

void	set_link_handler (const dunedaq::appmodel::DataHandlerConf *value)
	Set "link_handler" relationship value.

void	generate_modules (const confmodel::Session *) const override

virtual std::vector< const Resource * >	contained_resources () const override

virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the CIBApplication 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 dunedaq::appmodel::CIBConf *	get_generator () const
	Get "generator" relationship value.

void	set_generator (const dunedaq::appmodel::CIBConf *value)
	Set "generator" relationship value.

const dunedaq::appmodel::CIBoardConf *	get_board () const
	Get "board" relationship value.

void	set_board (const dunedaq::appmodel::CIBoardConf *value)
	Set "board" relationship value.

const dunedaq::appmodel::DataHandlerConf *	get_link_handler () const
	Get "link_handler" relationship value.

void	set_link_handler (const dunedaq::appmodel::DataHandlerConf *value)
	Set "link_handler" relationship value.

void	generate_modules (const confmodel::Session *) const override

virtual std::vector< const Resource * >	contained_resources () const override

Public Member Functions inherited from dunedaq::appmodel::SmartDaqApplication
const dunedaq::appmodel::SourceIDConf *	get_source_id () const
	Get "source_id" relationship value.

void	set_source_id (const dunedaq::appmodel::SourceIDConf *value)
	Set "source_id" relationship value.

const std::vector< const dunedaq::appmodel::QueueConnectionRule * > &	get_queue_rules () const
	Get "queue_rules" relationship value.

void	set_queue_rules (const std::vector< const dunedaq::appmodel::QueueConnectionRule * > &value)
	Set "queue_rules" relationship value.

const std::vector< const dunedaq::appmodel::NetworkConnectionRule * > &	get_network_rules () const
	Get "network_rules" relationship value.

void	set_network_rules (const std::vector< const dunedaq::appmodel::NetworkConnectionRule * > &value)
	Set "network_rules" relationship value.

const dunedaq::appmodel::SourceIDConf *	get_source_id () const
	Get "source_id" relationship value.

void	set_source_id (const dunedaq::appmodel::SourceIDConf *value)
	Set "source_id" relationship value.

const std::vector< const dunedaq::appmodel::QueueConnectionRule * > &	get_queue_rules () const
	Get "queue_rules" relationship value.

void	set_queue_rules (const std::vector< const dunedaq::appmodel::QueueConnectionRule * > &value)
	Set "queue_rules" relationship value.

const std::vector< const dunedaq::appmodel::NetworkConnectionRule * > &	get_network_rules () const
	Get "network_rules" relationship value.

void	set_network_rules (const std::vector< const dunedaq::appmodel::NetworkConnectionRule * > &value)
	Set "network_rules" relationship value.

Public Member Functions inherited from dunedaq::confmodel::DaqApplication
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< const dunedaq::confmodel::DaqModule * > &	get_modules () const
	Get "modules" relationship value.

void	set_modules (const std::vector< const dunedaq::confmodel::DaqModule * > &value)
	Set "modules" relationship value.

const std::vector< const dunedaq::confmodel::ActionPlan * > &	get_action_plans () const
	Get "action_plans" relationship value.

void	set_action_plans (const std::vector< const dunedaq::confmodel::ActionPlan * > &value)
	Set "action_plans" relationship value.

std::set< const dunedaq::confmodel::HostComponent * >	get_used_hostresources () const

const std::vector< std::string >	construct_commandline_parameters (const conffwk::Configuration &confdb, const dunedaq::confmodel::Session *session) 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< const dunedaq::confmodel::DaqModule * > &	get_modules () const
	Get "modules" relationship value.

void	set_modules (const std::vector< const dunedaq::confmodel::DaqModule * > &value)
	Set "modules" relationship value.

const std::vector< const dunedaq::confmodel::ActionPlan * > &	get_action_plans () const
	Get "action_plans" relationship value.

void	set_action_plans (const std::vector< const dunedaq::confmodel::ActionPlan * > &value)
	Set "action_plans" relationship value.

std::set< const dunedaq::confmodel::HostComponent * >	get_used_hostresources () const

const std::vector< std::string >	construct_commandline_parameters (const conffwk::Configuration &confdb, const dunedaq::confmodel::Session *session) const

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::ResourceSetDisableAND
bool	compute_disabled_state (const std::set< std::string > &disabled) const final

bool	compute_disabled_state (const std::set< std::string > &disabled) const final

Public Member Functions inherited from dunedaq::confmodel::ResourceSet
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

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

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

static const std::string &	__get_board_str () noexcept

static const std::string &	__get_link_handler_str () noexcept

static const std::string &	__get_generator_str () noexcept

static const std::string &	__get_board_str () noexcept

static const std::string &	__get_link_handler_str () noexcept

Static Public Member Functions inherited from dunedaq::appmodel::SmartDaqApplication
static const std::string &	__get_source_id_str () noexcept

static const std::string &	__get_queue_rules_str () noexcept

static const std::string &	__get_network_rules_str () noexcept

static const std::string &	__get_source_id_str () noexcept

static const std::string &	__get_queue_rules_str () noexcept

static const std::string &	__get_network_rules_str () noexcept

Static Public Member Functions inherited from dunedaq::confmodel::DaqApplication
static const std::string &	__get_application_name_str () noexcept

static const std::string &	__get_modules_str () noexcept

static const std::string &	__get_action_plans_str () noexcept

static const std::string &	__get_application_name_str () noexcept

static const std::string &	__get_modules_str () noexcept

static const std::string &	__get_action_plans_str () noexcept

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

Static Public Attributes
static const std::string &	s_class_name

static const std::string	s_generator = "generator"

static const std::string	s_board = "board"

static const std::string	s_link_handler = "link_handler"

Static Public Attributes inherited from dunedaq::appmodel::SmartDaqApplication
static const std::string &	s_class_name

static const std::string	s_source_id = "source_id"

static const std::string	s_queue_rules = "queue_rules"

static const std::string	s_network_rules = "network_rules"

Static Public Attributes inherited from dunedaq::confmodel::DaqApplication
static const std::string &	s_class_name

static const std::string	s_application_name = "application_name"

static const std::string	s_modules = "modules"

static const std::string	s_action_plans = "action_plans"

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::ResourceSetDisableAND
static const std::string &	s_class_name

Static Public Attributes inherited from dunedaq::confmodel::ResourceSet
static const std::string &	s_class_name

Static Public Attributes inherited from dunedaq::confmodel::Resource
static const std::string &	s_class_name

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

virtual	~CIBApplication () 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

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

virtual	~CIBApplication () 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::appmodel::SmartDaqApplication
	SmartDaqApplication (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept

virtual	~SmartDaqApplication () noexcept

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

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

virtual	~SmartDaqApplication () 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::confmodel::DaqApplication
	DaqApplication (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept

virtual	~DaqApplication () noexcept

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

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

virtual	~DaqApplication () 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::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::ResourceSetDisableAND
	ResourceSetDisableAND (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept

virtual	~ResourceSetDisableAND () noexcept

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

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

virtual	~ResourceSetDisableAND () 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::confmodel::ResourceSet
	ResourceSet (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept

virtual	~ResourceSet () noexcept

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

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

virtual	~ResourceSet () 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::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

Private Attributes
const dunedaq::appmodel::CIBConf *	m_generator

const dunedaq::appmodel::CIBoardConf *	m_board

const dunedaq::appmodel::DataHandlerConf *	m_link_handler

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

Application that controls the CIB

Definition at line 42 of file CIBApplication.hpp.

Constructor & Destructor Documentation

◆ CIBApplication() [1/2]

dunedaq::appmodel::CIBApplication::CIBApplication	(	conffwk::DalRegistry &	db,
		const conffwk::ConfigObject &	obj )

protectednoexcept

Definition at line 33 of file CIBApplication.cpp.

                                                                                                :
      dunedaq::conffwk::DalObject(db, o),
      SmartDaqApplication(db, o),
      dunedaq::confmodel::ResourceSetDisableAND(db, o),
      m_generator (nullptr),
      m_board (nullptr),
      m_link_handler (nullptr)
 
    {
      ;
    }

◆ ~CIBApplication() [1/2]

dunedaq::appmodel::CIBApplication::~CIBApplication ( )

protectedvirtualnoexcept

Definition at line 92 of file CIBApplication.cpp.

93 {

94 }

◆ CIBApplication() [2/2]

dunedaq::appmodel::CIBApplication::CIBApplication	(	conffwk::DalRegistry &	db,
		const conffwk::ConfigObject &	obj )

protectednoexcept

◆ ~CIBApplication() [2/2]

virtual dunedaq::appmodel::CIBApplication::~CIBApplication ( )

protectedvirtualnoexcept

Member Function Documentation

◆ __get_board_str() [1/2]

static const std::string & dunedaq::appmodel::CIBApplication::__get_board_str ( )

inlinestaticnoexcept

Definition at line 107 of file CIBApplication.hpp.

107{ return s_board; }

dunedaq::appmodel::CIBApplication::s_board

static const std::string s_board

Definition CIBApplication.hpp:103

◆ __get_board_str() [2/2]

static const std::string & dunedaq::appmodel::CIBApplication::__get_board_str ( )

inlinestaticnoexcept

Definition at line 107 of file CIBApplication.hpp.

107{ return s_board; }

◆ __get_generator_str() [1/2]

static const std::string & dunedaq::appmodel::CIBApplication::__get_generator_str ( )

inlinestaticnoexcept

Definition at line 106 of file CIBApplication.hpp.

106{ return s_generator; }

dunedaq::appmodel::CIBApplication::s_generator

static const std::string s_generator

Definition CIBApplication.hpp:102

◆ __get_generator_str() [2/2]

static const std::string & dunedaq::appmodel::CIBApplication::__get_generator_str ( )

inlinestaticnoexcept

Definition at line 106 of file CIBApplication.hpp.

106{ return s_generator; }

◆ __get_link_handler_str() [1/2]

static const std::string & dunedaq::appmodel::CIBApplication::__get_link_handler_str ( )

inlinestaticnoexcept

Definition at line 108 of file CIBApplication.hpp.

108{ return s_link_handler; }

dunedaq::appmodel::CIBApplication::s_link_handler

static const std::string s_link_handler

Definition CIBApplication.hpp:104

◆ __get_link_handler_str() [2/2]

static const std::string & dunedaq::appmodel::CIBApplication::__get_link_handler_str ( )

inlinestaticnoexcept

Definition at line 108 of file CIBApplication.hpp.

108{ return s_link_handler; }

◆ contained_resources() [1/2]

std::vector< const confmodel::Resource * > CIBApplication::contained_resources ( ) const

overridevirtual

Virtual method to obtain the list of all contained Resources. Used internally by the core disabled logic. Not intended to be used in application code as that should be using individual relationships of the derived classes.

Implements dunedaq::confmodel::ResourceSet.

Definition at line 45 of file CIBApplication.cpp.

                                          {
  std::vector<const confmodel::Resource*> resources;
  resources.push_back(dynamic_cast<const confmodel::Resource *>(get_board())); // NOLINT(runtime/rtti)
  return resources;
}

◆ contained_resources() [2/2]

virtual std::vector< const Resource * > dunedaq::appmodel::CIBApplication::contained_resources ( ) const

overridevirtual

Virtual method to obtain the list of all contained Resources. Used internally by the core disabled logic. Not intended to be used in application code as that should be using individual relationships of the derived classes.

Implements dunedaq::confmodel::ResourceSet.

◆ generate_modules() [1/2]

void CIBApplication::generate_modules ( const confmodel::Session * session ) const

overridevirtual

Generate DaqModule dal objects for streams of the application on the fly

Implements dunedaq::appmodel::SmartDaqApplication.

Definition at line 53 of file CIBApplication.cpp.

{
  std::vector<const confmodel::DaqModule*> modules;
 
  ConfigObjectFactory obj_fac(this);
  
  auto dlhConf = get_link_handler();
  auto dlhClass = dlhConf->get_template_for();
 
  const QueueDescriptor* dlhInputQDesc = nullptr;
    
  for (auto rule : get_queue_rules()) {
    auto destination_class = rule->get_destination_class();
    if (destination_class == "DataHandlerModule" || destination_class == dlhClass) {
      dlhInputQDesc = rule->get_descriptor();
    }
  }
  
  const NetworkConnectionDescriptor* dlhReqInputNetDesc = nullptr;
  const NetworkConnectionDescriptor* tsNetDesc = nullptr;
  const NetworkConnectionDescriptor* hsiNetDesc = nullptr;
  
  for (auto rule : get_network_rules()) {
    auto endpoint_class = rule->get_endpoint_class();
    auto data_type = rule->get_descriptor()->get_data_type();
    
    if (endpoint_class == "DataHandlerModule" || endpoint_class == dlhClass) {
      if (data_type == "TimeSync") {
        tsNetDesc = rule->get_descriptor();
      }
      if (data_type == "DataRequest") {
        dlhReqInputNetDesc = rule->get_descriptor();
      }
    }
    if (data_type == "HSIEvent") {
      hsiNetDesc = rule->get_descriptor();
    }
  }
  
  auto CIB_conf = get_generator();
  if (CIB_conf == nullptr) {
    throw(BadConf(ERS_HERE, "No CIBModule configuration given"));
  }
  if (dlhInputQDesc == nullptr) {
    throw(BadConf(ERS_HERE, "No DLH data input queue descriptor given"));
  }
  if (dlhReqInputNetDesc == nullptr) {
    throw(BadConf(ERS_HERE, "No DLH request input network descriptor given"));
  }
  if (hsiNetDesc == nullptr) {
    throw(BadConf(ERS_HERE, "No HSIEvent output network descriptor given"));
  }
 
  // Process special Network rules!
  // Looking for Fragment rules from DFAppplications in current Session
  auto sessionApps = session->enabled_applications();
  std::vector<conffwk::ConfigObject> fragOutObjs;
  for (auto app : sessionApps) {
    auto dfapp = app->cast<appmodel::DFApplication>();
    if (dfapp == nullptr)
      continue;
    
    auto dfNRules = dfapp->get_network_rules();
    for (auto rule : dfNRules) {
      auto descriptor = rule->get_descriptor();
      auto data_type = descriptor->get_data_type();
      if (data_type == "Fragment") {
    std::string dreqNetUid(descriptor->get_uid_base() + dfapp->UID());
    conffwk::ConfigObject frag_conn = obj_fac.create_net_obj(descriptor, dreqNetUid);
    fragOutObjs.push_back(frag_conn);
      } // If network rule has Fragment type of data
    }   // Loop over Apps network rules
  }     // loop over Session specific Apps
  
  // start building the list of outputs
  std::vector<const conffwk::ConfigObject*> fh_output_objs;
  for (auto& fNet : fragOutObjs) {
    fh_output_objs.push_back(&fNet);
  }
 
  std::vector<conffwk::ConfigObject> CIB_module_outputs;
  auto source_id = get_source_id();
 
  int id = static_cast<int>(source_id->get_sid());
 
  // ----------------------------
  // create DLH
  // ----------------------------    
  int det_id = 1; // TODO Eric Flumerfelt <eflumerf@fnal.gov>, 08-Feb-2024: This is a magic number corresponding to kDAQ  // NOLINT(readability/todo)
  TLOG() << "creating OKS configuration object for CIB Data Link Handler class " << dlhClass << ", id " << id;
  std::string uid("DLH-CIB");
  conffwk::ConfigObject dlhObj = obj_fac.create( dlhClass, uid );
  dlhObj.set_by_val<uint32_t>("source_id", static_cast<uint32_t>(id)); // NOLINT(build/unsigned)
  dlhObj.set_by_val<uint32_t>("detector_id", static_cast<uint32_t>(det_id)); // NOLINT(build/unsigned)
  dlhObj.set_by_val<bool>("post_processing_enabled", false);
  dlhObj.set_obj("module_configuration", &dlhConf->config_object());
    
  auto net_objc(fh_output_objs);
  
  conffwk::ConfigObject tsNetObj;
  // Time Sync network connection
  if (dlhConf->get_generate_timesync()) {
    std::string tsStreamUid = tsNetDesc->get_uid_base() + std::to_string(id);
    tsNetObj = obj_fac.create_net_obj(tsNetDesc, tsStreamUid);
    net_objc.push_back(&tsNetObj);
  }
 
  dlhObj.set_objs("outputs", net_objc);
 
  // create Queues from CIB to DLH
  std::string dataQueueUid(dlhInputQDesc->get_uid_base() + std::string("CIB"));
  conffwk::ConfigObject queueObj = obj_fac.create_queue_sid_obj(dlhInputQDesc, id); 
  queueObj.rename(dataQueueUid);
    
  CIB_module_outputs.push_back(queueObj);
 
  // Create network connections to DLHs
  conffwk::ConfigObject faNetObj = obj_fac.create_net_obj(dlhReqInputNetDesc, UID());
 
  dlhObj.set_objs("inputs", { &queueObj, &faNetObj });
 
  modules.push_back(obj_fac.get_dal<appmodel::DataHandlerModule>(uid));
 
  conffwk::ConfigObject hsiNetObj = obj_fac.create_net_obj(hsiNetDesc, "");
  CIB_module_outputs.push_back(hsiNetObj);
  
  auto board = get_board();
  
  conffwk::ConfigObject module_obj = obj_fac.create( "CIBModule", "CIB-module");
  module_obj.set_obj("configuration", & CIB_conf -> config_object() );
  module_obj.set_obj("board", & board -> config_object() );
  
  std::vector<const conffwk::ConfigObject*> CIB_module_output_ptrs;
  for ( const auto & o : CIB_module_outputs ) {
    CIB_module_output_ptrs.push_back( & o );
  }
  
  module_obj.set_objs("outputs", CIB_module_output_ptrs);
  
  auto module = obj_fac.get_dal<appmodel::CIBModule>(module_obj.UID());
  
  modules.push_back(module);
 
  obj_fac.update_modules(modules);
  // return modules;
} // NOLINT

◆ generate_modules() [2/2]

void dunedaq::appmodel::CIBApplication::generate_modules ( const confmodel::Session * ) const

overridevirtual

Generate DaqModule dal objects for streams of the application on the fly

Implements dunedaq::appmodel::SmartDaqApplication.

◆ get() [1/4]

std::vector< const dunedaq::conffwk::DalObject * > dunedaq::appmodel::CIBApplication::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::appmodel::SmartDaqApplication.

Definition at line 96 of file CIBApplication.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::appmodel::CIBApplication::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::appmodel::SmartDaqApplication.

◆ get() [3/4]

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

protected

Definition at line 106 of file CIBApplication.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 (SmartDaqApplication::get(name, vec, upcast_unregistered, false)) return true;
      if (ResourceSetDisableAND::get(name, vec, upcast_unregistered, false)) return true;
 
      if (first_call)
        return get_algo_objects(name, vec);
 
      return false;
    }

◆ get() [4/4]

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

protected

◆ get_board() [1/2]

const dunedaq::appmodel::CIBoardConf * dunedaq::appmodel::CIBApplication::get_board ( ) const

inline

Get "board" relationship value.

Returns: the relationship value

Exceptions

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

Definition at line 149 of file CIBApplication.hpp.

        {
          std::lock_guard scoped_lock(m_mutex);
          check();
          check_init();
          if (!m_board)
            {
              std::ostringstream text;
              text << "relationship \"" << s_board << "\" of object " << this << " is not set";
              throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
            }
          return m_board;
        }

◆ get_board() [2/2]

const dunedaq::appmodel::CIBoardConf * dunedaq::appmodel::CIBApplication::get_board ( ) const

inline

Get "board" relationship value.

Returns: the relationship value

Exceptions

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

Definition at line 149 of file CIBApplication.hpp.

        {
          std::lock_guard scoped_lock(m_mutex);
          check();
          check_init();
          if (!m_board)
            {
              std::ostringstream text;
              text << "relationship \"" << s_board << "\" of object " << this << " is not set";
              throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
            }
          return m_board;
        }

◆ get_generator() [1/2]

const dunedaq::appmodel::CIBConf * dunedaq::appmodel::CIBApplication::get_generator ( ) const

inline

Get "generator" relationship value.

Returns: the relationship value

Exceptions

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

Definition at line 118 of file CIBApplication.hpp.

        {
          std::lock_guard scoped_lock(m_mutex);
          check();
          check_init();
          if (!m_generator)
            {
              std::ostringstream text;
              text << "relationship \"" << s_generator << "\" of object " << this << " is not set";
              throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
            }
          return m_generator;
        }

◆ get_generator() [2/2]

const dunedaq::appmodel::CIBConf * dunedaq::appmodel::CIBApplication::get_generator ( ) const

inline

Get "generator" relationship value.

Returns: the relationship value

Exceptions

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

Definition at line 118 of file CIBApplication.hpp.

        {
          std::lock_guard scoped_lock(m_mutex);
          check();
          check_init();
          if (!m_generator)
            {
              std::ostringstream text;
              text << "relationship \"" << s_generator << "\" of object " << this << " is not set";
              throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
            }
          return m_generator;
        }

◆ get_link_handler() [1/2]

const dunedaq::appmodel::DataHandlerConf * dunedaq::appmodel::CIBApplication::get_link_handler ( ) const

inline

Get "link_handler" relationship value.

Returns: the relationship value

Exceptions

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

Definition at line 180 of file CIBApplication.hpp.

        {
          std::lock_guard scoped_lock(m_mutex);
          check();
          check_init();
          if (!m_link_handler)
            {
              std::ostringstream text;
              text << "relationship \"" << s_link_handler << "\" of object " << this << " is not set";
              throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
            }
          return m_link_handler;
        }

◆ get_link_handler() [2/2]

const dunedaq::appmodel::DataHandlerConf * dunedaq::appmodel::CIBApplication::get_link_handler ( ) const

inline

Get "link_handler" relationship value.

Returns: the relationship value

Exceptions

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

Definition at line 180 of file CIBApplication.hpp.

        {
          std::lock_guard scoped_lock(m_mutex);
          check();
          check_init();
          if (!m_link_handler)
            {
              std::ostringstream text;
              text << "relationship \"" << s_link_handler << "\" of object " << this << " is not set";
              throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
            }
          return m_link_handler;
        }

◆ init() [1/2]

void dunedaq::appmodel::CIBApplication::init ( bool init_children )

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children if true, initialize referenced objects

Reimplemented from dunedaq::appmodel::SmartDaqApplication.

Definition at line 75 of file CIBApplication.cpp.

    {
      SmartDaqApplication::init(init_children);
      ResourceSetDisableAND::init(init_children);
 
      TLOG_DEBUG(5) << "read object " << this << " (class " << s_class_name << ')';
 
      try {
        m_generator = p_registry._ref<dunedaq::appmodel::CIBConf>(p_obj, s_generator, init_children);
        m_board = p_registry._ref<dunedaq::appmodel::CIBoardConf>(p_obj, s_board, init_children);
        m_link_handler = p_registry._ref<dunedaq::appmodel::DataHandlerConf>(p_obj, s_link_handler, init_children);
      }
      catch (dunedaq::conffwk::Exception & ex) {
        throw_init_ex(ex);
      }
    }

◆ init() [2/2]

virtual void dunedaq::appmodel::CIBApplication::init ( bool init_children )

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children if true, initialize referenced objects

Reimplemented from dunedaq::appmodel::SmartDaqApplication.

◆ print() [1/2]

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

virtual

Print details of the CIBApplication 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::appmodel::SmartDaqApplication.

Definition at line 46 of file CIBApplication.cpp.

    {
      check_init();
 
      try {
        const std::string str(indent+2, ' ');
 
        if (print_header)
          p_hdr(s, indent, s_class_name, "dunedaq::appmodel");
 
 
          // print direct super-classes
 
        dunedaq::appmodel::SmartDaqApplication::print(indent, false, s);
        dunedaq::confmodel::ResourceSetDisableAND::print(indent, false, s);
 
 
          // print direct relationships
 
        dunedaq::conffwk::p_sv_rel(s, str, s_generator, m_generator);
        dunedaq::conffwk::p_sv_rel(s, str, s_board, m_board);
        dunedaq::conffwk::p_sv_rel(s, str, s_link_handler, m_link_handler);
      }
      catch (dunedaq::conffwk::Exception & ex) {
        dunedaq::conffwk::DalObject::p_error(s, ex);
      }
    }

◆ print() [2/2]

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

virtual

Print details of the CIBApplication 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::appmodel::SmartDaqApplication.

◆ set_board() [1/2]

void dunedaq::appmodel::CIBApplication::set_board ( const dunedaq::appmodel::CIBoardConf * value )

Set "board" relationship value.

Parameters

value new relationship value

Exceptions

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

Definition at line 133 of file CIBApplication.cpp.

    {
      _set_object(s_board, value);
    }

◆ set_board() [2/2]

void dunedaq::appmodel::CIBApplication::set_board ( const dunedaq::appmodel::CIBoardConf * value )

Set "board" relationship value.

Parameters

value new relationship value

Exceptions

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

◆ set_generator() [1/2]

void dunedaq::appmodel::CIBApplication::set_generator ( const dunedaq::appmodel::CIBConf * value )

Set "generator" relationship value.

Parameters

value new relationship value

Exceptions

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

Definition at line 128 of file CIBApplication.cpp.

    {
      _set_object(s_generator, value);
    }

◆ set_generator() [2/2]

void dunedaq::appmodel::CIBApplication::set_generator ( const dunedaq::appmodel::CIBConf * value )

Set "generator" relationship value.

Parameters

value new relationship value

Exceptions

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

◆ set_link_handler() [1/2]

void dunedaq::appmodel::CIBApplication::set_link_handler ( const dunedaq::appmodel::DataHandlerConf * value )

Set "link_handler" relationship value.

Parameters

value new relationship value

Exceptions

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

Definition at line 138 of file CIBApplication.cpp.

    {
      _set_object(s_link_handler, value);
    }

◆ set_link_handler() [2/2]

void dunedaq::appmodel::CIBApplication::set_link_handler ( const dunedaq::appmodel::DataHandlerConf * value )

Set "link_handler" relationship value.

Parameters

value new relationship value

Exceptions

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

Friends And Related Symbol Documentation

◆ conffwk::Configuration

conffwk::Configuration

friend

Definition at line 44 of file CIBApplication.hpp.

◆ conffwk::DalFactory

conffwk::DalFactory

friend

Definition at line 46 of file CIBApplication.hpp.

◆ conffwk::DalObject

conffwk::DalObject

friend

Definition at line 45 of file CIBApplication.hpp.

◆ conffwk::DalRegistry

conffwk::DalRegistry

friend

Definition at line 47 of file CIBApplication.hpp.

Member Data Documentation

◆ m_board

const dunedaq::appmodel::CIBoardConf * dunedaq::appmodel::CIBApplication::m_board

private

Definition at line 94 of file CIBApplication.hpp.

◆ m_generator

const dunedaq::appmodel::CIBConf * dunedaq::appmodel::CIBApplication::m_generator

private

Definition at line 93 of file CIBApplication.hpp.

◆ m_link_handler

const dunedaq::appmodel::DataHandlerConf * dunedaq::appmodel::CIBApplication::m_link_handler

private

Definition at line 95 of file CIBApplication.hpp.

◆ s_board

static const std::string dunedaq::appmodel::CIBApplication::s_board = "board"

inlinestatic

Definition at line 103 of file CIBApplication.hpp.

◆ s_class_name

static const std::string & dunedaq::appmodel::CIBApplication::s_class_name

static

The name of the configuration class.

Definition at line 59 of file CIBApplication.hpp.

◆ s_generator

static const std::string dunedaq::appmodel::CIBApplication::s_generator = "generator"

inlinestatic

Definition at line 102 of file CIBApplication.hpp.

◆ s_link_handler

static const std::string dunedaq::appmodel::CIBApplication::s_link_handler = "link_handler"

inlinestatic

Definition at line 104 of file CIBApplication.hpp.

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

/github/workspace/dunedaq/build/appmodel/codegen/include/appmodel/CIBApplication.hpp
/github/workspace/dunedaq/build/appmodel/codegen/src/CIBApplication.hpp
/github/workspace/dunedaq/sourcecode/appmodel/src/CIBApplication.cpp
/github/workspace/dunedaq/build/appmodel/codegen/src/CIBApplication.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

◆ CIBApplication() [1/2]

◆ ~CIBApplication() [1/2]

◆ CIBApplication() [2/2]

◆ ~CIBApplication() [2/2]

Member Function Documentation

◆ __get_board_str() [1/2]

◆ __get_board_str() [2/2]

◆ __get_generator_str() [1/2]

◆ __get_generator_str() [2/2]

◆ __get_link_handler_str() [1/2]

◆ __get_link_handler_str() [2/2]

◆ contained_resources() [1/2]

◆ contained_resources() [2/2]

◆ generate_modules() [1/2]

◆ generate_modules() [2/2]

◆ get() [1/4]

◆ get() [2/4]

◆ get() [3/4]

◆ get() [4/4]

◆ get_board() [1/2]

◆ get_board() [2/2]

◆ get_generator() [1/2]

◆ get_generator() [2/2]

◆ get_link_handler() [1/2]

◆ get_link_handler() [2/2]

◆ init() [1/2]

◆ init() [2/2]

◆ print() [1/2]

◆ print() [2/2]

◆ set_board() [1/2]

◆ set_board() [2/2]

◆ set_generator() [1/2]

◆ set_generator() [2/2]

◆ set_link_handler() [1/2]

◆ set_link_handler() [2/2]

Friends And Related Symbol Documentation

◆ conffwk::Configuration

◆ conffwk::DalFactory

◆ conffwk::DalObject

◆ conffwk::DalRegistry

Member Data Documentation

◆ m_board

◆ m_generator

◆ m_link_handler

◆ s_board

◆ s_class_name

◆ s_generator

◆ s_link_handler