#include <Session.hpp>

Inheritance diagram for dunedaq::confmodel::Session:

Collaboration diagram for dunedaq::confmodel::Session:

Classes
struct	Controller_log_level

Public Member Functions
virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the Session 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_description () const
	Get "description" attribute value. A description of the session.

void	set_description (const std::string &value)
	Set "description" attribute value. A description of the session.

uint32_t	get_data_request_timeout_ms () const
	Get "data_request_timeout_ms" attribute value. The baseline data request timeout that will be used by modules in the Readout and Trigger subsystems (i.e. any module that produces data fragments). Downstream timeouts, such as the trigger-record-building timeout, are derived from this.

void	set_data_request_timeout_ms (uint32_t value)
	Set "data_request_timeout_ms" attribute value. The baseline data request timeout that will be used by modules in the Readout and Trigger subsystems (i.e. any module that produces data fragments). Downstream timeouts, such as the trigger-record-building timeout, are derived from this.

uint32_t	get_data_rate_slowdown_factor () const
	Get "data_rate_slowdown_factor" attribute value. "Factor by which to suppress data generation.

void	set_data_rate_slowdown_factor (uint32_t value)
	Set "data_rate_slowdown_factor" attribute value. "Factor by which to suppress data generation.

const std::string &	get_rte_script () const
	Get "rte_script" attribute value. Path to a script for setting up the runtime environment for DAQ applications.

void	set_rte_script (const std::string &value)
	Set "rte_script" attribute value. Path to a script for setting up the runtime environment for DAQ applications.

const std::string &	get_controller_log_level () const
	Get "controller_log_level" attribute value. Log level to use for drunc controllers.

void	set_controller_log_level (const std::string &value)
	Set "controller_log_level" attribute value. Log level to use for drunc controllers.

const std::string &	get_log_path () const
	Get "log_path" attribute value. Where the applications, controllers and infrastructure applications stdout/err go. This is overwritten by the Application'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 is overwritten by the Application's log_path. If none of them is set, PWD is used.

const dunedaq::confmodel::ConnectivityService *	get_connectivity_service () const
	Get "connectivity_service" relationship value. Configuration for the Connectivity Service lookups.

void	set_connectivity_service (const dunedaq::confmodel::ConnectivityService *value)
	Set "connectivity_service" relationship value. Configuration for the Connectivity Service lookups.

const std::vector< const dunedaq::confmodel::VariableBase * > &	get_environment () const
	Get "environment" relationship value. Define process environment for any application run in given session.

void	set_environment (const std::vector< const dunedaq::confmodel::VariableBase * > &value)
	Set "environment" relationship value. Define process environment for any application run in given session.

const std::vector< const dunedaq::confmodel::ResourceBase * > &	get_disabled () const
	Get "disabled" relationship value. Resources that should not participate in the current run.

void	set_disabled (const std::vector< const dunedaq::confmodel::ResourceBase * > &value)
	Set "disabled" relationship value. Resources that should not participate in the current run.

const dunedaq::confmodel::Segment *	get_segment () const
	Get "segment" relationship value. List of configuration Segments that form this Session.

void	set_segment (const dunedaq::confmodel::Segment *value)
	Set "segment" relationship value. List of configuration Segments that form this Session.

const std::vector< const dunedaq::confmodel::Application * > &	get_infrastructure_applications () const
	Get "infrastructure_applications" relationship value.

void	set_infrastructure_applications (const std::vector< const dunedaq::confmodel::Application * > &value)
	Set "infrastructure_applications" relationship value.

const dunedaq::confmodel::DetectorConfig *	get_detector_configuration () const
	Get "detector_configuration" relationship value.

void	set_detector_configuration (const dunedaq::confmodel::DetectorConfig *value)
	Set "detector_configuration" relationship value.

const dunedaq::confmodel::OpMonURI *	get_opmon_uri () const
	Get "opmon_uri" relationship value. Configuration for the OpMon facilities used across the session.

void	set_opmon_uri (const dunedaq::confmodel::OpMonURI *value)
	Set "opmon_uri" relationship value. Configuration for the OpMon facilities used across the session.

std::vector< const dunedaq::confmodel::Application * >	get_all_applications () const

std::vector< const dunedaq::confmodel::Application * >	get_enabled_applications () const

void	set_disabled (const std::set< const dunedaq::confmodel::Component * > &objs) const

void	set_enabled (const std::set< const dunedaq::confmodel::Component * > &objs) const

virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the Session 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_description () const
	Get "description" attribute value. A description of the session.

void	set_description (const std::string &value)
	Set "description" attribute value. A description of the session.

uint32_t	get_data_request_timeout_ms () const
	Get "data_request_timeout_ms" attribute value. The baseline data request timeout that will be used by modules in the Readout and Trigger subsystems (i.e. any module that produces data fragments). Downstream timeouts, such as the trigger-record-building timeout, are derived from this.

void	set_data_request_timeout_ms (uint32_t value)
	Set "data_request_timeout_ms" attribute value. The baseline data request timeout that will be used by modules in the Readout and Trigger subsystems (i.e. any module that produces data fragments). Downstream timeouts, such as the trigger-record-building timeout, are derived from this.

uint32_t	get_data_rate_slowdown_factor () const
	Get "data_rate_slowdown_factor" attribute value. "Factor by which to suppress data generation.

void	set_data_rate_slowdown_factor (uint32_t value)
	Set "data_rate_slowdown_factor" attribute value. "Factor by which to suppress data generation.

const std::string &	get_rte_script () const
	Get "rte_script" attribute value. Path to a script for setting up the runtime environment for DAQ applications.

void	set_rte_script (const std::string &value)
	Set "rte_script" attribute value. Path to a script for setting up the runtime environment for DAQ applications.

const std::string &	get_controller_log_level () const
	Get "controller_log_level" attribute value. Log level to use for drunc controllers.

void	set_controller_log_level (const std::string &value)
	Set "controller_log_level" attribute value. Log level to use for drunc controllers.

const std::string &	get_log_path () const
	Get "log_path" attribute value. Where the applications, controllers and infrastructure applications stdout/err go. This is overwritten by the Application'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 is overwritten by the Application's log_path. If none of them is set, PWD is used.

const dunedaq::confmodel::ConnectivityService *	get_connectivity_service () const
	Get "connectivity_service" relationship value. Configuration for the Connectivity Service lookups.

void	set_connectivity_service (const dunedaq::confmodel::ConnectivityService *value)
	Set "connectivity_service" relationship value. Configuration for the Connectivity Service lookups.

const std::vector< const dunedaq::confmodel::VariableBase * > &	get_environment () const
	Get "environment" relationship value. Define process environment for any application run in given session.

void	set_environment (const std::vector< const dunedaq::confmodel::VariableBase * > &value)
	Set "environment" relationship value. Define process environment for any application run in given session.

const std::vector< const dunedaq::confmodel::ResourceBase * > &	get_disabled () const
	Get "disabled" relationship value. Resources that should not participate in the current run.

void	set_disabled (const std::vector< const dunedaq::confmodel::ResourceBase * > &value)
	Set "disabled" relationship value. Resources that should not participate in the current run.

const dunedaq::confmodel::Segment *	get_segment () const
	Get "segment" relationship value. List of configuration Segments that form this Session.

void	set_segment (const dunedaq::confmodel::Segment *value)
	Set "segment" relationship value. List of configuration Segments that form this Session.

const std::vector< const dunedaq::confmodel::Application * > &	get_infrastructure_applications () const
	Get "infrastructure_applications" relationship value.

void	set_infrastructure_applications (const std::vector< const dunedaq::confmodel::Application * > &value)
	Set "infrastructure_applications" relationship value.

const dunedaq::confmodel::DetectorConfig *	get_detector_configuration () const
	Get "detector_configuration" relationship value.

void	set_detector_configuration (const dunedaq::confmodel::DetectorConfig *value)
	Set "detector_configuration" relationship value.

const dunedaq::confmodel::OpMonURI *	get_opmon_uri () const
	Get "opmon_uri" relationship value. Configuration for the OpMon facilities used across the session.

void	set_opmon_uri (const dunedaq::confmodel::OpMonURI *value)
	Set "opmon_uri" relationship value. Configuration for the OpMon facilities used across the session.

std::vector< const dunedaq::confmodel::Application * >	get_all_applications () const

std::vector< const dunedaq::confmodel::Application * >	get_enabled_applications () const

void	set_disabled (const std::set< const dunedaq::confmodel::Component * > &objs) const

void	set_enabled (const std::set< const dunedaq::confmodel::Component * > &objs) 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.

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

static const std::string &	__get_data_request_timeout_ms_str () noexcept

static const std::string &	__get_data_rate_slowdown_factor_str () noexcept

static const std::string &	__get_rte_script_str () noexcept

static const std::string &	__get_controller_log_level_str () noexcept

static const std::string &	__get_log_path_str () noexcept

static const std::string &	__get_connectivity_service_str () noexcept

static const std::string &	__get_environment_str () noexcept

static const std::string &	__get_disabled_str () noexcept

static const std::string &	__get_segment_str () noexcept

static const std::string &	__get_infrastructure_applications_str () noexcept

static const std::string &	__get_detector_configuration_str () noexcept

static const std::string &	__get_opmon_uri_str () noexcept

static const std::string &	__get_description_str () noexcept

static const std::string &	__get_data_request_timeout_ms_str () noexcept

static const std::string &	__get_data_rate_slowdown_factor_str () noexcept

static const std::string &	__get_rte_script_str () noexcept

static const std::string &	__get_controller_log_level_str () noexcept

static const std::string &	__get_log_path_str () noexcept

static const std::string &	__get_connectivity_service_str () noexcept

static const std::string &	__get_environment_str () noexcept

static const std::string &	__get_disabled_str () noexcept

static const std::string &	__get_segment_str () noexcept

static const std::string &	__get_infrastructure_applications_str () noexcept

static const std::string &	__get_detector_configuration_str () noexcept

static const std::string &	__get_opmon_uri_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_description = "description"

static const std::string	s_data_request_timeout_ms = "data_request_timeout_ms"

static const std::string	s_data_rate_slowdown_factor = "data_rate_slowdown_factor"

static const std::string	s_rte_script = "rte_script"

static const std::string	s_controller_log_level = "controller_log_level"

static const std::string	s_log_path = "log_path"

static const std::string	s_connectivity_service = "connectivity_service"

static const std::string	s_environment = "environment"

static const std::string	s_disabled = "disabled"

static const std::string	s_segment = "segment"

static const std::string	s_infrastructure_applications = "infrastructure_applications"

static const std::string	s_detector_configuration = "detector_configuration"

static const std::string	s_opmon_uri = "opmon_uri"

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

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

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

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

uint32_t	m_data_request_timeout_ms

uint32_t	m_data_rate_slowdown_factor

std::string	m_rte_script

std::string	m_controller_log_level

std::string	m_log_path

const dunedaq::confmodel::ConnectivityService *	m_connectivity_service

std::vector< const dunedaq::confmodel::VariableBase * >	m_environment

std::vector< const dunedaq::confmodel::ResourceBase * >	m_disabled

const dunedaq::confmodel::Segment *	m_segment

std::vector< const dunedaq::confmodel::Application * >	m_infrastructure_applications

const dunedaq::confmodel::DetectorConfig *	m_detector_configuration

const dunedaq::confmodel::OpMonURI *	m_opmon_uri

dunedaq::confmodel::DisabledComponents	m_disabled_components

Friends
class	conffwk::Configuration

class	conffwk::DalObject

class	conffwk::DalFactory

class	conffwk::DalRegistry

class	DisabledComponents

class	Component

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 40 of file Session.hpp.

Constructor & Destructor Documentation

◆ Session() [1/2]

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

protectednoexcept

Definition at line 37 of file Session.cpp.

                                                                                  :
      dunedaq::conffwk::DalObject(db, o),
      m_connectivity_service (nullptr),
      m_segment (nullptr),
      m_detector_configuration (nullptr),
      m_opmon_uri (nullptr),
      m_disabled_components(p_registry.configuration(),this)
 
    {
      ;
    }

◆ ~Session() [1/2]

dunedaq::confmodel::Session::~Session ( )

protectedvirtualnoexcept

Definition at line 113 of file Session.cpp.

114 {

115 }

◆ Session() [2/2]

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

protectednoexcept

◆ ~Session() [2/2]

virtual dunedaq::confmodel::Session::~Session ( )

protectedvirtualnoexcept

Member Function Documentation

◆ __get_connectivity_service_str() [1/2]

static const std::string & dunedaq::confmodel::Session::__get_connectivity_service_str ( )

inlinestaticnoexcept

Definition at line 350 of file Session.hpp.

350{ return s_connectivity_service; }

dunedaq::confmodel::Session::s_connectivity_service

static const std::string s_connectivity_service

Definition Session.hpp:342

◆ __get_connectivity_service_str() [2/2]

static const std::string & dunedaq::confmodel::Session::__get_connectivity_service_str ( )

inlinestaticnoexcept

Definition at line 350 of file Session.hpp.

350{ return s_connectivity_service; }

◆ __get_controller_log_level_str() [1/2]

static const std::string & dunedaq::confmodel::Session::__get_controller_log_level_str ( )

inlinestaticnoexcept

Definition at line 126 of file Session.hpp.

126{ return s_controller_log_level; }

dunedaq::confmodel::Session::s_controller_log_level

static const std::string s_controller_log_level

Definition Session.hpp:119

◆ __get_controller_log_level_str() [2/2]

static const std::string & dunedaq::confmodel::Session::__get_controller_log_level_str ( )

inlinestaticnoexcept

Definition at line 126 of file Session.hpp.

126{ return s_controller_log_level; }

◆ __get_data_rate_slowdown_factor_str() [1/2]

static const std::string & dunedaq::confmodel::Session::__get_data_rate_slowdown_factor_str ( )

inlinestaticnoexcept

Definition at line 124 of file Session.hpp.

124{ return s_data_rate_slowdown_factor; }

dunedaq::confmodel::Session::s_data_rate_slowdown_factor

static const std::string s_data_rate_slowdown_factor

Definition Session.hpp:117

◆ __get_data_rate_slowdown_factor_str() [2/2]

static const std::string & dunedaq::confmodel::Session::__get_data_rate_slowdown_factor_str ( )

inlinestaticnoexcept

Definition at line 124 of file Session.hpp.

124{ return s_data_rate_slowdown_factor; }

◆ __get_data_request_timeout_ms_str() [1/2]

static const std::string & dunedaq::confmodel::Session::__get_data_request_timeout_ms_str ( )

inlinestaticnoexcept

Definition at line 123 of file Session.hpp.

123{ return s_data_request_timeout_ms; }

dunedaq::confmodel::Session::s_data_request_timeout_ms

static const std::string s_data_request_timeout_ms

Definition Session.hpp:116

◆ __get_data_request_timeout_ms_str() [2/2]

static const std::string & dunedaq::confmodel::Session::__get_data_request_timeout_ms_str ( )

inlinestaticnoexcept

Definition at line 123 of file Session.hpp.

123{ return s_data_request_timeout_ms; }

◆ __get_description_str() [1/2]

static const std::string & dunedaq::confmodel::Session::__get_description_str ( )

inlinestaticnoexcept

Definition at line 122 of file Session.hpp.

122{ return s_description; }

dunedaq::confmodel::Session::s_description

static const std::string s_description

Definition Session.hpp:115

◆ __get_description_str() [2/2]

static const std::string & dunedaq::confmodel::Session::__get_description_str ( )

inlinestaticnoexcept

Definition at line 122 of file Session.hpp.

122{ return s_description; }

◆ __get_detector_configuration_str() [1/2]

static const std::string & dunedaq::confmodel::Session::__get_detector_configuration_str ( )

inlinestaticnoexcept

Definition at line 355 of file Session.hpp.

355{ return s_detector_configuration; }

dunedaq::confmodel::Session::s_detector_configuration

static const std::string s_detector_configuration

Definition Session.hpp:347

◆ __get_detector_configuration_str() [2/2]

static const std::string & dunedaq::confmodel::Session::__get_detector_configuration_str ( )

inlinestaticnoexcept

Definition at line 355 of file Session.hpp.

355{ return s_detector_configuration; }

◆ __get_disabled_str() [1/2]

static const std::string & dunedaq::confmodel::Session::__get_disabled_str ( )

inlinestaticnoexcept

Definition at line 352 of file Session.hpp.

352{ return s_disabled; }

dunedaq::confmodel::Session::s_disabled

static const std::string s_disabled

Definition Session.hpp:344

◆ __get_disabled_str() [2/2]

static const std::string & dunedaq::confmodel::Session::__get_disabled_str ( )

inlinestaticnoexcept

Definition at line 352 of file Session.hpp.

352{ return s_disabled; }

◆ __get_environment_str() [1/2]

static const std::string & dunedaq::confmodel::Session::__get_environment_str ( )

inlinestaticnoexcept

Definition at line 351 of file Session.hpp.

351{ return s_environment; }

dunedaq::confmodel::Session::s_environment

static const std::string s_environment

Definition Session.hpp:343

◆ __get_environment_str() [2/2]

static const std::string & dunedaq::confmodel::Session::__get_environment_str ( )

inlinestaticnoexcept

Definition at line 351 of file Session.hpp.

351{ return s_environment; }

◆ __get_infrastructure_applications_str() [1/2]

static const std::string & dunedaq::confmodel::Session::__get_infrastructure_applications_str ( )

inlinestaticnoexcept

Definition at line 354 of file Session.hpp.

354{ return s_infrastructure_applications; }

dunedaq::confmodel::Session::s_infrastructure_applications

static const std::string s_infrastructure_applications

Definition Session.hpp:346

◆ __get_infrastructure_applications_str() [2/2]

static const std::string & dunedaq::confmodel::Session::__get_infrastructure_applications_str ( )

inlinestaticnoexcept

Definition at line 354 of file Session.hpp.

354{ return s_infrastructure_applications; }

◆ __get_log_path_str() [1/2]

static const std::string & dunedaq::confmodel::Session::__get_log_path_str ( )

inlinestaticnoexcept

Definition at line 127 of file Session.hpp.

127{ return s_log_path; }

dunedaq::confmodel::Session::s_log_path

static const std::string s_log_path

Definition Session.hpp:120

◆ __get_log_path_str() [2/2]

static const std::string & dunedaq::confmodel::Session::__get_log_path_str ( )

inlinestaticnoexcept

Definition at line 127 of file Session.hpp.

127{ return s_log_path; }

◆ __get_opmon_uri_str() [1/2]

static const std::string & dunedaq::confmodel::Session::__get_opmon_uri_str ( )

inlinestaticnoexcept

Definition at line 356 of file Session.hpp.

356{ return s_opmon_uri; }

dunedaq::confmodel::Session::s_opmon_uri

static const std::string s_opmon_uri

Definition Session.hpp:348

◆ __get_opmon_uri_str() [2/2]

static const std::string & dunedaq::confmodel::Session::__get_opmon_uri_str ( )

inlinestaticnoexcept

Definition at line 356 of file Session.hpp.

356{ return s_opmon_uri; }

◆ __get_rte_script_str() [1/2]

static const std::string & dunedaq::confmodel::Session::__get_rte_script_str ( )

inlinestaticnoexcept

Definition at line 125 of file Session.hpp.

125{ return s_rte_script; }

dunedaq::confmodel::Session::s_rte_script

static const std::string s_rte_script

Definition Session.hpp:118

◆ __get_rte_script_str() [2/2]

static const std::string & dunedaq::confmodel::Session::__get_rte_script_str ( )

inlinestaticnoexcept

Definition at line 125 of file Session.hpp.

125{ return s_rte_script; }

◆ __get_segment_str() [1/2]

static const std::string & dunedaq::confmodel::Session::__get_segment_str ( )

inlinestaticnoexcept

Definition at line 353 of file Session.hpp.

353{ return s_segment; }

dunedaq::confmodel::Session::s_segment

static const std::string s_segment

Definition Session.hpp:345

◆ __get_segment_str() [2/2]

static const std::string & dunedaq::confmodel::Session::__get_segment_str ( )

inlinestaticnoexcept

Definition at line 353 of file Session.hpp.

353{ return s_segment; }

◆ get() [1/4]

std::vector< const dunedaq::conffwk::DalObject * > dunedaq::confmodel::Session::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 117 of file Session.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::Session::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::Session::get	(	const std::string &	name,
		std::vector< const dunedaq::conffwk::DalObject * > &	vec,
		bool	upcast_unregistered,
		bool	first_call ) const

protected

Definition at line 127 of file Session.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::Session::get	(	const std::string &	name,
		std::vector< const dunedaq::conffwk::DalObject * > &	vec,
		bool	upcast_unregistered,
		bool	first_call ) const

protected

◆ get_all_applications() [1/2]

std::vector< const Application * > dunedaq::confmodel::Session::get_all_applications ( ) const

Returns applications defined in the Session and all of its Segments.

Definition at line 187 of file dalMethods.cpp.

                                    {
  std::vector<const Application*> apps;
  auto segapps = getSegmentApps(m_segment, this, false);
  apps.insert(apps.end(), segapps.begin(),segapps.end());
  return apps;
}

◆ get_all_applications() [2/2]

std::vector< const dunedaq::confmodel::Application * > dunedaq::confmodel::Session::get_all_applications ( ) const

Returns applications defined in the Session and all of its Segments.

◆ get_connectivity_service() [1/2]

const dunedaq::confmodel::ConnectivityService * dunedaq::confmodel::Session::get_connectivity_service ( ) const

inline

Get "connectivity_service" relationship value. Configuration for the Connectivity Service lookups.

Returns: the relationship value

Exceptions

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

Definition at line 367 of file Session.hpp.

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

◆ get_connectivity_service() [2/2]

const dunedaq::confmodel::ConnectivityService * dunedaq::confmodel::Session::get_connectivity_service ( ) const

inline

Get "connectivity_service" relationship value. Configuration for the Connectivity Service lookups.

Returns: the relationship value

Exceptions

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

Definition at line 367 of file Session.hpp.

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

◆ get_controller_log_level() [1/2]

const std::string & dunedaq::confmodel::Session::get_controller_log_level ( ) const

inline

Get "controller_log_level" attribute value. Log level to use for drunc controllers.

Returns: the attribute value

Exceptions

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

Definition at line 282 of file Session.hpp.

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

◆ get_controller_log_level() [2/2]

const std::string & dunedaq::confmodel::Session::get_controller_log_level ( ) const

inline

Get "controller_log_level" attribute value. Log level to use for drunc controllers.

Returns: the attribute value

Exceptions

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

Definition at line 282 of file Session.hpp.

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

◆ get_data_rate_slowdown_factor() [1/2]

uint32_t dunedaq::confmodel::Session::get_data_rate_slowdown_factor ( ) const

inline

Get "data_rate_slowdown_factor" attribute value. "Factor by which to suppress data generation.

Returns: the attribute value

Exceptions

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

Definition at line 204 of file Session.hpp.

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

◆ get_data_rate_slowdown_factor() [2/2]

uint32_t dunedaq::confmodel::Session::get_data_rate_slowdown_factor ( ) const

inline

Get "data_rate_slowdown_factor" attribute value. "Factor by which to suppress data generation.

Returns: the attribute value

Exceptions

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

Definition at line 204 of file Session.hpp.

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

◆ get_data_request_timeout_ms() [1/2]

uint32_t dunedaq::confmodel::Session::get_data_request_timeout_ms ( ) const

inline

Get "data_request_timeout_ms" attribute value. The baseline data request timeout that will be used by modules in the Readout and Trigger subsystems (i.e. any module that produces data fragments). Downstream timeouts, such as the trigger-record-building timeout, are derived from this.

Returns: the attribute value

Exceptions

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

Definition at line 171 of file Session.hpp.

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

◆ get_data_request_timeout_ms() [2/2]

uint32_t dunedaq::confmodel::Session::get_data_request_timeout_ms ( ) const

inline

Get "data_request_timeout_ms" attribute value. The baseline data request timeout that will be used by modules in the Readout and Trigger subsystems (i.e. any module that produces data fragments). Downstream timeouts, such as the trigger-record-building timeout, are derived from this.

Returns: the attribute value

Exceptions

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

Definition at line 171 of file Session.hpp.

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

◆ get_description() [1/2]

const std::string & dunedaq::confmodel::Session::get_description ( ) const

inline

Get "description" attribute value. A description of the session.

Returns: the attribute value

Exceptions

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

Definition at line 138 of file Session.hpp.

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

◆ get_description() [2/2]

const std::string & dunedaq::confmodel::Session::get_description ( ) const

inline

Get "description" attribute value. A description of the session.

Returns: the attribute value

Exceptions

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

Definition at line 138 of file Session.hpp.

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

◆ get_detector_configuration() [1/2]

const dunedaq::confmodel::DetectorConfig * dunedaq::confmodel::Session::get_detector_configuration ( ) const

inline

Get "detector_configuration" relationship value.

Returns: the relationship value

Exceptions

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

Definition at line 505 of file Session.hpp.

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

◆ get_detector_configuration() [2/2]

const dunedaq::confmodel::DetectorConfig * dunedaq::confmodel::Session::get_detector_configuration ( ) const

inline

Get "detector_configuration" relationship value.

Returns: the relationship value

Exceptions

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

Definition at line 505 of file Session.hpp.

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

◆ get_disabled() [1/2]

const std::vector< const dunedaq::confmodel::ResourceBase * > & dunedaq::confmodel::Session::get_disabled ( ) const

inline

Get "disabled" relationship value. Resources that should not participate in the current run.

Returns: the relationship value

Exceptions

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

Definition at line 421 of file Session.hpp.

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

◆ get_disabled() [2/2]

const std::vector< const dunedaq::confmodel::ResourceBase * > & dunedaq::confmodel::Session::get_disabled ( ) const

inline

Get "disabled" relationship value. Resources that should not participate in the current run.

Returns: the relationship value

Exceptions

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

Definition at line 421 of file Session.hpp.

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

◆ get_enabled_applications() [1/2]

std::vector< const Application * > dunedaq::confmodel::Session::get_enabled_applications ( ) const

Returns all enabled applications defined in the Session and all of its Segments.

Definition at line 195 of file dalMethods.cpp.

                                        {
  std::vector<const Application*> apps;
  auto segapps = getSegmentApps(m_segment, this, true);
  apps.insert(apps.end(), segapps.begin(),segapps.end());
  return apps;
}

◆ get_enabled_applications() [2/2]

std::vector< const dunedaq::confmodel::Application * > dunedaq::confmodel::Session::get_enabled_applications ( ) const

Returns all enabled applications defined in the Session and all of its Segments.

◆ get_environment() [1/2]

const std::vector< const dunedaq::confmodel::VariableBase * > & dunedaq::confmodel::Session::get_environment ( ) const

inline

Get "environment" relationship value. Define process environment for any application run in given session.

Returns: the relationship value

Exceptions

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

Definition at line 394 of file Session.hpp.

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

◆ get_environment() [2/2]

const std::vector< const dunedaq::confmodel::VariableBase * > & dunedaq::confmodel::Session::get_environment ( ) const

inline

Get "environment" relationship value. Define process environment for any application run in given session.

Returns: the relationship value

Exceptions

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

Definition at line 394 of file Session.hpp.

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

◆ get_infrastructure_applications() [1/2]

const std::vector< const dunedaq::confmodel::Application * > & dunedaq::confmodel::Session::get_infrastructure_applications ( ) const

inline

Get "infrastructure_applications" relationship value.

Returns: the relationship value

Exceptions

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

Definition at line 480 of file Session.hpp.

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

◆ get_infrastructure_applications() [2/2]

const std::vector< const dunedaq::confmodel::Application * > & dunedaq::confmodel::Session::get_infrastructure_applications ( ) const

inline

Get "infrastructure_applications" relationship value.

Returns: the relationship value

Exceptions

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

Definition at line 480 of file Session.hpp.

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

◆ get_log_path() [1/2]

const std::string & dunedaq::confmodel::Session::get_log_path ( ) const

inline

Get "log_path" attribute value. Where the applications, controllers and infrastructure applications stdout/err go. This is overwritten by the Application's log_path. If none of them is set, PWD is used.

Returns: the attribute value

Exceptions

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

Definition at line 315 of file Session.hpp.

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

◆ get_log_path() [2/2]

const std::string & dunedaq::confmodel::Session::get_log_path ( ) const

inline

Get "log_path" attribute value. Where the applications, controllers and infrastructure applications stdout/err go. This is overwritten by the Application's log_path. If none of them is set, PWD is used.

Returns: the attribute value

Exceptions

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

Definition at line 315 of file Session.hpp.

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

◆ get_opmon_uri() [1/2]

const dunedaq::confmodel::OpMonURI * dunedaq::confmodel::Session::get_opmon_uri ( ) const

inline

Get "opmon_uri" relationship value. Configuration for the OpMon facilities used across the session.

Returns: the relationship value

Exceptions

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

Definition at line 537 of file Session.hpp.

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

◆ get_opmon_uri() [2/2]

const dunedaq::confmodel::OpMonURI * dunedaq::confmodel::Session::get_opmon_uri ( ) const

inline

Get "opmon_uri" relationship value. Configuration for the OpMon facilities used across the session.

Returns: the relationship value

Exceptions

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

Definition at line 537 of file Session.hpp.

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

◆ get_rte_script() [1/2]

const std::string & dunedaq::confmodel::Session::get_rte_script ( ) const

inline

Get "rte_script" attribute value. Path to a script for setting up the runtime environment for DAQ applications.

Returns: the attribute value

Exceptions

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

Definition at line 237 of file Session.hpp.

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

◆ get_rte_script() [2/2]

const std::string & dunedaq::confmodel::Session::get_rte_script ( ) const

inline

Get "rte_script" attribute value. Path to a script for setting up the runtime environment for DAQ applications.

Returns: the attribute value

Exceptions

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

Definition at line 237 of file Session.hpp.

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

◆ get_segment() [1/2]

const dunedaq::confmodel::Segment * dunedaq::confmodel::Session::get_segment ( ) const

inline

Get "segment" relationship value. List of configuration Segments that form this Session.

Returns: the relationship value

Exceptions

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

Definition at line 448 of file Session.hpp.

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

◆ get_segment() [2/2]

const dunedaq::confmodel::Segment * dunedaq::confmodel::Session::get_segment ( ) const

inline

Get "segment" relationship value. List of configuration Segments that form this Session.

Returns: the relationship value

Exceptions

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

Definition at line 448 of file Session.hpp.

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

◆ init() [1/2]

void dunedaq::confmodel::Session::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 87 of file Session.cpp.

    {
      p_was_read = true;
      increment_read();
      TLOG_DEBUG(5) << "read object " << this << " (class " << s_class_name << ')';
 
      try {
        p_obj.get(s_description, m_description);
        p_obj.get(s_data_request_timeout_ms, m_data_request_timeout_ms);
        p_obj.get(s_data_rate_slowdown_factor, m_data_rate_slowdown_factor);
        p_obj.get(s_rte_script, m_rte_script);
        p_obj.get(s_controller_log_level, m_controller_log_level);
        p_obj.get(s_log_path, m_log_path);
        m_connectivity_service = p_registry._ref<dunedaq::confmodel::ConnectivityService>(p_obj, s_connectivity_service, init_children);
        p_registry._ref<dunedaq::confmodel::VariableBase>(p_obj, s_environment, m_environment, init_children);
        p_registry._ref<dunedaq::confmodel::ResourceBase>(p_obj, s_disabled, m_disabled, init_children);
        m_segment = p_registry._ref<dunedaq::confmodel::Segment>(p_obj, s_segment, init_children);
        p_registry._ref<dunedaq::confmodel::Application>(p_obj, s_infrastructure_applications, m_infrastructure_applications, init_children);
        m_detector_configuration = p_registry._ref<dunedaq::confmodel::DetectorConfig>(p_obj, s_detector_configuration, init_children);
        m_opmon_uri = p_registry._ref<dunedaq::confmodel::OpMonURI>(p_obj, s_opmon_uri, init_children);
      }
      catch (dunedaq::conffwk::Exception & ex) {
        throw_init_ex(ex);
      }
    }

◆ init() [2/2]

virtual void dunedaq::confmodel::Session::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::Session::print	(	unsigned int	offset,
		bool	print_header,
		std::ostream &	s ) const

virtual

Print details of the Session 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 50 of file Session.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_description, m_description);
        dunedaq::conffwk::p_sv_attr(s, str, s_data_request_timeout_ms, m_data_request_timeout_ms);
        dunedaq::conffwk::p_sv_attr(s, str, s_data_rate_slowdown_factor, m_data_rate_slowdown_factor);
        dunedaq::conffwk::p_sv_attr(s, str, s_rte_script, m_rte_script);
        dunedaq::conffwk::p_sv_attr(s, str, s_controller_log_level, m_controller_log_level);
        dunedaq::conffwk::p_sv_attr(s, str, s_log_path, m_log_path);
 
 
          // print direct relationships
 
        dunedaq::conffwk::p_sv_rel(s, str, s_connectivity_service, m_connectivity_service);
        dunedaq::conffwk::p_mv_rel(s, str, s_environment, m_environment);
        dunedaq::conffwk::p_mv_rel(s, str, indent, s_disabled, m_disabled);
        dunedaq::conffwk::p_sv_rel(s, str, indent, s_segment, m_segment);
        dunedaq::conffwk::p_mv_rel(s, str, indent, s_infrastructure_applications, m_infrastructure_applications);
        dunedaq::conffwk::p_sv_rel(s, str, s_detector_configuration, m_detector_configuration);
        dunedaq::conffwk::p_sv_rel(s, str, indent, s_opmon_uri, m_opmon_uri);
      }
      catch (dunedaq::conffwk::Exception & ex) {
        dunedaq::conffwk::DalObject::p_error(s, ex);
      }
    }

◆ print() [2/2]

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

virtual

Print details of the Session 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_connectivity_service() [1/2]

void dunedaq::confmodel::Session::set_connectivity_service ( const dunedaq::confmodel::ConnectivityService * value )

Set "connectivity_service" relationship value. Configuration for the Connectivity Service lookups.

Parameters

value new relationship value

Exceptions

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

Definition at line 146 of file Session.cpp.

    {
      _set_object(s_connectivity_service, value);
    }

◆ set_connectivity_service() [2/2]

void dunedaq::confmodel::Session::set_connectivity_service ( const dunedaq::confmodel::ConnectivityService * value )

Set "connectivity_service" relationship value. Configuration for the Connectivity Service lookups.

Parameters

value new relationship value

Exceptions

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

◆ set_controller_log_level() [1/2]

void dunedaq::confmodel::Session::set_controller_log_level ( const std::string & value )

inline

Set "controller_log_level" attribute value. Log level to use for drunc controllers.

Parameters

value new attribute value

Exceptions

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

Definition at line 298 of file Session.hpp.

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

◆ set_controller_log_level() [2/2]

void dunedaq::confmodel::Session::set_controller_log_level ( const std::string & value )

inline

Set "controller_log_level" attribute value. Log level to use for drunc controllers.

Parameters

value new attribute value

Exceptions

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

Definition at line 298 of file Session.hpp.

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

◆ set_data_rate_slowdown_factor() [1/2]

void dunedaq::confmodel::Session::set_data_rate_slowdown_factor ( uint32_t value )

inline

Set "data_rate_slowdown_factor" attribute value. "Factor by which to suppress data generation.

Parameters

value new attribute value

Exceptions

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

Definition at line 220 of file Session.hpp.

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

◆ set_data_rate_slowdown_factor() [2/2]

void dunedaq::confmodel::Session::set_data_rate_slowdown_factor ( uint32_t value )

inline

Set "data_rate_slowdown_factor" attribute value. "Factor by which to suppress data generation.

Parameters

value new attribute value

Exceptions

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

Definition at line 220 of file Session.hpp.

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

◆ set_data_request_timeout_ms() [1/2]

void dunedaq::confmodel::Session::set_data_request_timeout_ms ( uint32_t value )

inline

Set "data_request_timeout_ms" attribute value. The baseline data request timeout that will be used by modules in the Readout and Trigger subsystems (i.e. any module that produces data fragments). Downstream timeouts, such as the trigger-record-building timeout, are derived from this.

Parameters

value new attribute value

Exceptions

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

Definition at line 187 of file Session.hpp.

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

◆ set_data_request_timeout_ms() [2/2]

void dunedaq::confmodel::Session::set_data_request_timeout_ms ( uint32_t value )

inline

Set "data_request_timeout_ms" attribute value. The baseline data request timeout that will be used by modules in the Readout and Trigger subsystems (i.e. any module that produces data fragments). Downstream timeouts, such as the trigger-record-building timeout, are derived from this.

Parameters

value new attribute value

Exceptions

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

Definition at line 187 of file Session.hpp.

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

◆ set_description() [1/2]

void dunedaq::confmodel::Session::set_description ( const std::string & value )

inline

Set "description" attribute value. A description of the session.

Parameters

value new attribute value

Exceptions

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

Definition at line 154 of file Session.hpp.

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

◆ set_description() [2/2]

void dunedaq::confmodel::Session::set_description ( const std::string & value )

inline

Set "description" attribute value. A description of the session.

Parameters

value new attribute value

Exceptions

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

Definition at line 154 of file Session.hpp.

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

◆ set_detector_configuration() [1/2]

void dunedaq::confmodel::Session::set_detector_configuration ( const dunedaq::confmodel::DetectorConfig * value )

Set "detector_configuration" relationship value.

Parameters

value new relationship value

Exceptions

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

Definition at line 171 of file Session.cpp.

    {
      _set_object(s_detector_configuration, value);
    }

◆ set_detector_configuration() [2/2]

void dunedaq::confmodel::Session::set_detector_configuration ( const dunedaq::confmodel::DetectorConfig * value )

Set "detector_configuration" relationship value.

Parameters

value new relationship value

Exceptions

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

◆ set_disabled() [1/4]

void dunedaq::confmodel::Session::set_disabled ( const std::set< const dunedaq::confmodel::Component * > & objs ) const

In addition to persistently disabled components, dynamically disable these components. It will be taken into account by disabled() algorithm of Component class. This information is not committed to the database and will be overwritten by next set_disabled() call or erased by any config action (DB load, unload, reload).

◆ set_disabled() [2/4]

void dunedaq::confmodel::Session::set_disabled ( const std::set< const dunedaq::confmodel::Component * > & objs ) const

In addition to persistently disabled components, dynamically disable these components. It will be taken into account by disabled() algorithm of Component class. This information is not committed to the database and will be overwritten by next set_disabled() call or erased by any config action (DB load, unload, reload).

◆ set_disabled() [3/4]

void dunedaq::confmodel::Session::set_disabled ( const std::vector< const dunedaq::confmodel::ResourceBase * > & value )

Set "disabled" relationship value. Resources that should not participate in the current run.

Parameters

value new relationship value

Exceptions

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

Definition at line 156 of file Session.cpp.

    {
      _set_objects(s_disabled, value);
    }

◆ set_disabled() [4/4]

void dunedaq::confmodel::Session::set_disabled ( const std::vector< const dunedaq::confmodel::ResourceBase * > & value )

Set "disabled" relationship value. Resources that should not participate in the current run.

Parameters

value new relationship value

Exceptions

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

◆ set_enabled() [1/2]

void dunedaq::confmodel::Session::set_enabled ( const std::set< const dunedaq::confmodel::Component * > & objs ) const

Dynamically enable these persistently disabled components. It will be taken into account by disabled() algorithm of the Component class. This information is not committed to the database and will be overwritten by next set_enabled() call or erased by any config action (DB load, unload, reload).

◆ set_enabled() [2/2]

void dunedaq::confmodel::Session::set_enabled ( const std::set< const dunedaq::confmodel::Component * > & objs ) const

Dynamically enable these persistently disabled components. It will be taken into account by disabled() algorithm of the Component class. This information is not committed to the database and will be overwritten by next set_enabled() call or erased by any config action (DB load, unload, reload).

◆ set_environment() [1/2]

void dunedaq::confmodel::Session::set_environment ( const std::vector< const dunedaq::confmodel::VariableBase * > & value )

Set "environment" relationship value. Define process environment for any application run in given session.

Parameters

value new relationship value

Exceptions

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

Definition at line 151 of file Session.cpp.

    {
      _set_objects(s_environment, value);
    }

◆ set_environment() [2/2]

void dunedaq::confmodel::Session::set_environment ( const std::vector< const dunedaq::confmodel::VariableBase * > & value )

Set "environment" relationship value. Define process environment for any application run in given session.

Parameters

value new relationship value

Exceptions

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

◆ set_infrastructure_applications() [1/2]

void dunedaq::confmodel::Session::set_infrastructure_applications ( const std::vector< const dunedaq::confmodel::Application * > & value )

Set "infrastructure_applications" relationship value.

Parameters

value new relationship value

Exceptions

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

Definition at line 166 of file Session.cpp.

    {
      _set_objects(s_infrastructure_applications, value);
    }

◆ set_infrastructure_applications() [2/2]

void dunedaq::confmodel::Session::set_infrastructure_applications ( const std::vector< const dunedaq::confmodel::Application * > & value )

Set "infrastructure_applications" relationship value.

Parameters

value new relationship value

Exceptions

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

◆ set_log_path() [1/2]

void dunedaq::confmodel::Session::set_log_path ( const std::string & value )

inline

Set "log_path" attribute value. Where the applications, controllers and infrastructure applications stdout/err go. This is overwritten by the Application's log_path. If none of them is set, PWD is used.

Parameters

value new attribute value

Exceptions

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

Definition at line 331 of file Session.hpp.

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

◆ set_log_path() [2/2]

void dunedaq::confmodel::Session::set_log_path ( const std::string & value )

inline

Set "log_path" attribute value. Where the applications, controllers and infrastructure applications stdout/err go. This is overwritten by the Application's log_path. If none of them is set, PWD is used.

Parameters

value new attribute value

Exceptions

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

Definition at line 331 of file Session.hpp.

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

◆ set_opmon_uri() [1/2]

void dunedaq::confmodel::Session::set_opmon_uri ( const dunedaq::confmodel::OpMonURI * value )

Set "opmon_uri" relationship value. Configuration for the OpMon facilities used across the session.

Parameters

value new relationship value

Exceptions

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

Definition at line 176 of file Session.cpp.

    {
      _set_object(s_opmon_uri, value);
    }

◆ set_opmon_uri() [2/2]

void dunedaq::confmodel::Session::set_opmon_uri ( const dunedaq::confmodel::OpMonURI * value )

Set "opmon_uri" relationship value. Configuration for the OpMon facilities used across the session.

Parameters

value new relationship value

Exceptions

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

◆ set_rte_script() [1/2]

void dunedaq::confmodel::Session::set_rte_script ( const std::string & value )

inline

Set "rte_script" attribute value. Path to a script for setting up the runtime environment for DAQ applications.

Parameters

value new attribute value

Exceptions

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

Definition at line 253 of file Session.hpp.

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

◆ set_rte_script() [2/2]

void dunedaq::confmodel::Session::set_rte_script ( const std::string & value )

inline

Set "rte_script" attribute value. Path to a script for setting up the runtime environment for DAQ applications.

Parameters

value new attribute value

Exceptions

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

Definition at line 253 of file Session.hpp.

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

◆ set_segment() [1/2]

void dunedaq::confmodel::Session::set_segment ( const dunedaq::confmodel::Segment * value )

Set "segment" relationship value. List of configuration Segments that form this Session.

Parameters

value new relationship value

Exceptions

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

Definition at line 161 of file Session.cpp.

    {
      _set_object(s_segment, value);
    }

◆ set_segment() [2/2]

void dunedaq::confmodel::Session::set_segment ( const dunedaq::confmodel::Segment * value )

Set "segment" relationship value. List of configuration Segments that form this Session.

Parameters

value new relationship value

Exceptions

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

Friends And Related Symbol Documentation

◆ Component

Component

friend

Definition at line 107 of file Session.hpp.

◆ conffwk::Configuration

conffwk::Configuration

friend

Definition at line 42 of file Session.hpp.

◆ conffwk::DalFactory

conffwk::DalFactory

friend

Definition at line 44 of file Session.hpp.

◆ conffwk::DalObject

conffwk::DalObject

friend

Definition at line 43 of file Session.hpp.

◆ conffwk::DalRegistry

conffwk::DalRegistry

friend

Definition at line 45 of file Session.hpp.

◆ DisabledComponents

DisabledComponents

friend

Definition at line 106 of file Session.hpp.

Member Data Documentation

◆ m_connectivity_service

const dunedaq::confmodel::ConnectivityService * dunedaq::confmodel::Session::m_connectivity_service

private

Definition at line 97 of file Session.hpp.

◆ m_controller_log_level

std::string dunedaq::confmodel::Session::m_controller_log_level

private

Definition at line 95 of file Session.hpp.

◆ m_data_rate_slowdown_factor

uint32_t dunedaq::confmodel::Session::m_data_rate_slowdown_factor

private

Definition at line 93 of file Session.hpp.

◆ m_data_request_timeout_ms

uint32_t dunedaq::confmodel::Session::m_data_request_timeout_ms

private

Definition at line 92 of file Session.hpp.

◆ m_description

std::string dunedaq::confmodel::Session::m_description

private

Definition at line 91 of file Session.hpp.

◆ m_detector_configuration

const dunedaq::confmodel::DetectorConfig * dunedaq::confmodel::Session::m_detector_configuration

private

Definition at line 102 of file Session.hpp.

◆ m_disabled

std::vector< const dunedaq::confmodel::ResourceBase * > dunedaq::confmodel::Session::m_disabled

private

Definition at line 99 of file Session.hpp.

◆ m_disabled_components

dunedaq::confmodel::DisabledComponents dunedaq::confmodel::Session::m_disabled_components

mutableprivate

Definition at line 108 of file Session.hpp.

◆ m_environment

std::vector< const dunedaq::confmodel::VariableBase * > dunedaq::confmodel::Session::m_environment

private

Definition at line 98 of file Session.hpp.

◆ m_infrastructure_applications

std::vector< const dunedaq::confmodel::Application * > dunedaq::confmodel::Session::m_infrastructure_applications

private

Definition at line 101 of file Session.hpp.

◆ m_log_path

std::string dunedaq::confmodel::Session::m_log_path

private

Definition at line 96 of file Session.hpp.

◆ m_opmon_uri

const dunedaq::confmodel::OpMonURI * dunedaq::confmodel::Session::m_opmon_uri

private

Definition at line 103 of file Session.hpp.

◆ m_rte_script

std::string dunedaq::confmodel::Session::m_rte_script

private

Definition at line 94 of file Session.hpp.

◆ m_segment

const dunedaq::confmodel::Segment * dunedaq::confmodel::Session::m_segment

private

Definition at line 100 of file Session.hpp.

◆ s_class_name

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

static

The name of the configuration class.

Definition at line 57 of file Session.hpp.

◆ s_connectivity_service

static const std::string dunedaq::confmodel::Session::s_connectivity_service = "connectivity_service"

inlinestatic

Definition at line 342 of file Session.hpp.

◆ s_controller_log_level

static const std::string dunedaq::confmodel::Session::s_controller_log_level = "controller_log_level"

inlinestatic

Definition at line 119 of file Session.hpp.

◆ s_data_rate_slowdown_factor

static const std::string dunedaq::confmodel::Session::s_data_rate_slowdown_factor = "data_rate_slowdown_factor"

inlinestatic

Definition at line 117 of file Session.hpp.

◆ s_data_request_timeout_ms

static const std::string dunedaq::confmodel::Session::s_data_request_timeout_ms = "data_request_timeout_ms"

inlinestatic

Definition at line 116 of file Session.hpp.

◆ s_description

static const std::string dunedaq::confmodel::Session::s_description = "description"

inlinestatic

Definition at line 115 of file Session.hpp.

◆ s_detector_configuration

static const std::string dunedaq::confmodel::Session::s_detector_configuration = "detector_configuration"

inlinestatic

Definition at line 347 of file Session.hpp.

◆ s_disabled

static const std::string dunedaq::confmodel::Session::s_disabled = "disabled"

inlinestatic

Definition at line 344 of file Session.hpp.

◆ s_environment

static const std::string dunedaq::confmodel::Session::s_environment = "environment"

inlinestatic

Definition at line 343 of file Session.hpp.

◆ s_infrastructure_applications

static const std::string dunedaq::confmodel::Session::s_infrastructure_applications = "infrastructure_applications"

inlinestatic

Definition at line 346 of file Session.hpp.

◆ s_log_path

static const std::string dunedaq::confmodel::Session::s_log_path = "log_path"

inlinestatic

Definition at line 120 of file Session.hpp.

◆ s_opmon_uri

static const std::string dunedaq::confmodel::Session::s_opmon_uri = "opmon_uri"

inlinestatic

Definition at line 348 of file Session.hpp.

◆ s_rte_script

static const std::string dunedaq::confmodel::Session::s_rte_script = "rte_script"

inlinestatic

Definition at line 118 of file Session.hpp.

◆ s_segment

static const std::string dunedaq::confmodel::Session::s_segment = "segment"

inlinestatic

Definition at line 345 of file Session.hpp.

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

/github/workspace/dunedaq/build/confmodel/codegen/include/confmodel/Session.hpp
/github/workspace/dunedaq/build/confmodel/codegen/src/Session.hpp
/github/workspace/dunedaq/sourcecode/confmodel/src/dalMethods.cpp
/github/workspace/dunedaq/build/confmodel/codegen/src/Session.cpp

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Session() [1/2]

◆ ~Session() [1/2]

◆ Session() [2/2]

◆ ~Session() [2/2]

Member Function Documentation

◆ __get_connectivity_service_str() [1/2]

◆ __get_connectivity_service_str() [2/2]

◆ __get_controller_log_level_str() [1/2]

◆ __get_controller_log_level_str() [2/2]

◆ __get_data_rate_slowdown_factor_str() [1/2]

◆ __get_data_rate_slowdown_factor_str() [2/2]

◆ __get_data_request_timeout_ms_str() [1/2]

◆ __get_data_request_timeout_ms_str() [2/2]

◆ __get_description_str() [1/2]

◆ __get_description_str() [2/2]

◆ __get_detector_configuration_str() [1/2]

◆ __get_detector_configuration_str() [2/2]

◆ __get_disabled_str() [1/2]

◆ __get_disabled_str() [2/2]

◆ __get_environment_str() [1/2]

◆ __get_environment_str() [2/2]

◆ __get_infrastructure_applications_str() [1/2]

◆ __get_infrastructure_applications_str() [2/2]

◆ __get_log_path_str() [1/2]

◆ __get_log_path_str() [2/2]

◆ __get_opmon_uri_str() [1/2]

◆ __get_opmon_uri_str() [2/2]

◆ __get_rte_script_str() [1/2]

◆ __get_rte_script_str() [2/2]

◆ __get_segment_str() [1/2]

◆ __get_segment_str() [2/2]

◆ get() [1/4]

◆ get() [2/4]

◆ get() [3/4]

◆ get() [4/4]

◆ get_all_applications() [1/2]

◆ get_all_applications() [2/2]

◆ get_connectivity_service() [1/2]

◆ get_connectivity_service() [2/2]

◆ get_controller_log_level() [1/2]

◆ get_controller_log_level() [2/2]

◆ get_data_rate_slowdown_factor() [1/2]

◆ get_data_rate_slowdown_factor() [2/2]

◆ get_data_request_timeout_ms() [1/2]

◆ get_data_request_timeout_ms() [2/2]

◆ get_description() [1/2]

◆ get_description() [2/2]

◆ get_detector_configuration() [1/2]

◆ get_detector_configuration() [2/2]

◆ get_disabled() [1/2]

◆ get_disabled() [2/2]

◆ get_enabled_applications() [1/2]

◆ get_enabled_applications() [2/2]

◆ get_environment() [1/2]

◆ get_environment() [2/2]

◆ get_infrastructure_applications() [1/2]

◆ get_infrastructure_applications() [2/2]

◆ get_log_path() [1/2]

◆ get_log_path() [2/2]

◆ get_opmon_uri() [1/2]

◆ get_opmon_uri() [2/2]

◆ get_rte_script() [1/2]

◆ get_rte_script() [2/2]

◆ get_segment() [1/2]

◆ get_segment() [2/2]

◆ init() [1/2]

◆ init() [2/2]

◆ print() [1/2]

◆ print() [2/2]

◆ set_connectivity_service() [1/2]