DUNE-DAQ
DUNE Trigger and Data Acquisition software
Loading...
Searching...
No Matches
dunedaq::confmodel::RCApplication Class Reference

#include <RCApplication.hpp>

Inheritance diagram for dunedaq::confmodel::RCApplication:
[legend]
Collaboration diagram for dunedaq::confmodel::RCApplication:
[legend]

Public Member Functions

virtual void print (unsigned int offset, bool print_header, std::ostream &s) const
 Print details of the RCApplication 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_application_name () const
 Get "application_name" attribute value.
 
void set_application_name (const std::string &value)
 Set "application_name" attribute value.
 
const dunedaq::confmodel::FSMconfigurationget_fsm () const
 Get "fsm" relationship value.
 
void set_fsm (const dunedaq::confmodel::FSMconfiguration *value)
 Set "fsm" relationship value.
 
const dunedaq::confmodel::RCBroadcasterget_broadcaster () const
 Get "broadcaster" relationship value.
 
void set_broadcaster (const dunedaq::confmodel::RCBroadcaster *value)
 Set "broadcaster" relationship value.
 
const std::vector< std::string > construct_commandline_parameters (const conffwk::Configuration &confdb, const dunedaq::confmodel::Session *session) const
 
virtual void print (unsigned int offset, bool print_header, std::ostream &s) const
 Print details of the RCApplication 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_application_name () const
 Get "application_name" attribute value.
 
void set_application_name (const std::string &value)
 Set "application_name" attribute value.
 
const dunedaq::confmodel::FSMconfigurationget_fsm () const
 Get "fsm" relationship value.
 
void set_fsm (const dunedaq::confmodel::FSMconfiguration *value)
 Set "fsm" relationship value.
 
const dunedaq::confmodel::RCBroadcasterget_broadcaster () const
 Get "broadcaster" relationship value.
 
void set_broadcaster (const dunedaq::confmodel::RCBroadcaster *value)
 Set "broadcaster" relationship value.
 
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::VirtualHostget_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::OpMonConfget_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::VirtualHostget_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::OpMonConfget_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 ConfigObjectconfig_object () const
 
DalRegistryregistry () const noexcept
 
Configurationconfiguration () 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_application_name_str () noexcept
 
static const std::string & __get_fsm_str () noexcept
 
static const std::string & __get_broadcaster_str () noexcept
 
static const std::string & __get_application_name_str () noexcept
 
static const std::string & __get_fsm_str () noexcept
 
static const std::string & __get_broadcaster_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_application_name = "application_name"
 
static const std::string s_fsm = "fsm"
 
static const std::string s_broadcaster = "broadcaster"
 
- 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"
 

Protected Member Functions

 RCApplication (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~RCApplication () 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
 
 RCApplication (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~RCApplication () noexcept
 
virtual void init (bool init_children)
 
bool get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const
 
- Protected Member Functions inherited from dunedaq::confmodel::Application
 Application (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~Application () noexcept
 
bool get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const
 
 Application (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~Application () noexcept
 
bool get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const
 
- Protected Member Functions inherited from dunedaq::conffwk::DalObject
 DalObject (DalRegistry &db, const ConfigObject &o) noexcept
 
virtual ~DalObject ()
 
void clear () noexcept
 
void check () const
 
bool is_deleted () const
 
void increment_created () noexcept
 
void increment_read () noexcept
 
void check_init () const
 Check and initialize object if necessary.
 
template<typename T >
void _set_object (const std::string &name, const T *value)
 Helper method for generated set single-value relationship methods.
 
template<typename T >
void _set_objects (const std::string &name, const std::vector< const T * > &value)
 Helper method for generated set multi-value relationship methods.
 
bool get_rel_objects (const std::string &name, bool upcast_unregistered, std::vector< const DalObject * > &objs) const
 Read relationship values as DAL objects using DAL factory.
 
bool get_algo_objects (const std::string &name, std::vector< const DalObject * > &objs) const
 Run algorithm and return result as DAL objects using DAL factory.
 

Private Attributes

std::string m_application_name
 
const dunedaq::confmodel::FSMconfigurationm_fsm
 
const dunedaq::confmodel::RCBroadcasterm_broadcaster
 

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
 
DalRegistryp_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

An executable which allows users to control datataking

Definition at line 38 of file RCApplication.hpp.

Constructor & Destructor Documentation

◆ RCApplication() [1/2]

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

Definition at line 32 of file RCApplication.cpp.

32 :
34 Application(db, o),
35 m_fsm (nullptr),
36 m_broadcaster (nullptr)
37
38 {
39 ;
40 }
The base class for any generated DAL object.
Definition DalObject.hpp:45
Application(conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
const dunedaq::confmodel::FSMconfiguration * m_fsm
const dunedaq::confmodel::RCBroadcaster * m_broadcaster

◆ ~RCApplication() [1/2]

dunedaq::confmodel::RCApplication::~RCApplication ( )
protectedvirtualnoexcept

Definition at line 91 of file RCApplication.cpp.

92 {
93 }

◆ RCApplication() [2/2]

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

◆ ~RCApplication() [2/2]

virtual dunedaq::confmodel::RCApplication::~RCApplication ( )
protectedvirtualnoexcept

Member Function Documentation

◆ __get_application_name_str() [1/2]

static const std::string & dunedaq::confmodel::RCApplication::__get_application_name_str ( )
inlinestaticnoexcept

Definition at line 100 of file RCApplication.hpp.

100{ return s_application_name; }
static const std::string s_application_name

◆ __get_application_name_str() [2/2]

static const std::string & dunedaq::confmodel::RCApplication::__get_application_name_str ( )
inlinestaticnoexcept

Definition at line 100 of file RCApplication.hpp.

100{ return s_application_name; }

◆ __get_broadcaster_str() [1/2]

static const std::string & dunedaq::confmodel::RCApplication::__get_broadcaster_str ( )
inlinestaticnoexcept

Definition at line 140 of file RCApplication.hpp.

140{ return s_broadcaster; }
static const std::string s_broadcaster

◆ __get_broadcaster_str() [2/2]

static const std::string & dunedaq::confmodel::RCApplication::__get_broadcaster_str ( )
inlinestaticnoexcept

Definition at line 140 of file RCApplication.hpp.

140{ return s_broadcaster; }

◆ __get_fsm_str() [1/2]

static const std::string & dunedaq::confmodel::RCApplication::__get_fsm_str ( )
inlinestaticnoexcept

Definition at line 139 of file RCApplication.hpp.

139{ return s_fsm; }
static const std::string s_fsm

◆ __get_fsm_str() [2/2]

static const std::string & dunedaq::confmodel::RCApplication::__get_fsm_str ( )
inlinestaticnoexcept

Definition at line 139 of file RCApplication.hpp.

139{ return s_fsm; }

◆ construct_commandline_parameters() [1/2]

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

get the command line parameters for this rc application

Definition at line 328 of file dalMethods.cpp.

330 {
331
332 const std::string configuration_uri = confdb.get_impl_spec();
333 const dunedaq::confmodel::Service* control_service = nullptr;
334
335 const std::string controller_log_level = session->get_controller_log_level();
336
337 for (auto const *as : get_exposes_service()) {
338 if (as->UID().ends_with("_control")) {
339 if (control_service)
340 throw DuplicatedControlService(ERS_HERE, as->UID());
341 control_service = as;
342 }
343 }
344
345 if (control_service == nullptr)
346 throw NoControlServiceDefined(ERS_HERE, UID());
347
348 const std::string control_uri =
349 control_service->get_protocol()
350 + "://"
351 + get_runs_on()->get_runs_on()->UID()
352 + ":"
353 + std::to_string(control_service->get_port());
354
355 std::vector<std::string> ret = { "-l", controller_log_level };
356 ret.push_back(configuration_uri);
357 ret.push_back(control_uri);
358 ret.push_back(UID());
359 ret.push_back(session->UID());
360 return ret;
361}
#define ERS_HERE
const std::string & UID() const noexcept
const std::vector< const dunedaq::confmodel::Service * > & get_exposes_service() const
Get "exposes_service" relationship value. Services exposed i.e. provided by this application.
const dunedaq::confmodel::VirtualHost * get_runs_on() const
Get "runs_on" relationship value. VirtualHost to run this application on.
const std::string & get_protocol() const
Get "protocol" attribute value.
Definition Service.hpp:99
uint16_t get_port() const
Get "port" attribute value.
Definition Service.hpp:130
const dunedaq::confmodel::PhysicalHost * get_runs_on() const
Get "runs_on" relationship value. The physical host that this virtual host runs on.
The opmon infrastructure has not been set up in the DuplicatedControlService
Definition util.hpp:38

◆ construct_commandline_parameters() [2/2]

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

get the command line parameters for this rc application

◆ get() [1/4]

std::vector< const dunedaq::conffwk::DalObject * > dunedaq::confmodel::RCApplication::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
namename of the relationship or algorithm
Returns
value of relationship or result of algorithm
Exceptions
std::exceptionif there is no relationship or algorithm with such name in this and base classes

Reimplemented from dunedaq::confmodel::Application.

Definition at line 95 of file RCApplication.cpp.

96 {
97 std::vector<const dunedaq::conffwk::DalObject *> vec;
98
99 if (!get(name, vec, upcast_unregistered, true))
100 throw_get_ex(name, s_class_name, this);
101
102 return vec;
103 }
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.
Definition DalObject.cpp:82
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...
static const std::string & s_class_name

◆ get() [2/4]

virtual std::vector< const dunedaq::conffwk::DalObject * > dunedaq::confmodel::RCApplication::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
namename of the relationship or algorithm
Returns
value of relationship or result of algorithm
Exceptions
std::exceptionif there is no relationship or algorithm with such name in this and base classes

Reimplemented from dunedaq::confmodel::Application.

◆ get() [3/4]

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

Definition at line 105 of file RCApplication.cpp.

106 {
107 if (first_call)
108 {
109 std::lock_guard scoped_lock(m_mutex);
110
111 check();
112 check_init();
113
114 if (get_rel_objects(name, upcast_unregistered, vec))
115 return true;
116 }
117
118 if (Application::get(name, vec, upcast_unregistered, false)) return true;
119
120 if (first_call)
121 return get_algo_objects(name, vec);
122
123 return false;
124 }
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.
Definition DalObject.cpp:8
std::mutex m_mutex
Used to protect changes of DAL object.
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.
Definition DalObject.cpp:25
void check_init() const
Check and initialize object if necessary.
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...

◆ get() [4/4]

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

◆ get_application_name() [1/2]

const std::string & dunedaq::confmodel::RCApplication::get_application_name ( ) const
inline

Get "application_name" attribute value.

Returns
the attribute value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 110 of file RCApplication.hpp.

111 {
112 std::lock_guard scoped_lock(m_mutex);
113 check();
114 check_init();
115 return m_application_name;
116 }

◆ get_application_name() [2/2]

const std::string & dunedaq::confmodel::RCApplication::get_application_name ( ) const
inline

Get "application_name" attribute value.

Returns
the attribute value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 110 of file RCApplication.hpp.

111 {
112 std::lock_guard scoped_lock(m_mutex);
113 check();
114 check_init();
115 return m_application_name;
116 }

◆ get_broadcaster() [1/2]

const dunedaq::confmodel::RCBroadcaster * dunedaq::confmodel::RCApplication::get_broadcaster ( ) const
inline

Get "broadcaster" relationship value.

Returns
the relationship value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 181 of file RCApplication.hpp.

182 {
183 std::lock_guard scoped_lock(m_mutex);
184 check();
185 check_init();
186 return m_broadcaster;
187 }

◆ get_broadcaster() [2/2]

const dunedaq::confmodel::RCBroadcaster * dunedaq::confmodel::RCApplication::get_broadcaster ( ) const
inline

Get "broadcaster" relationship value.

Returns
the relationship value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 181 of file RCApplication.hpp.

182 {
183 std::lock_guard scoped_lock(m_mutex);
184 check();
185 check_init();
186 return m_broadcaster;
187 }

◆ get_fsm() [1/2]

const dunedaq::confmodel::FSMconfiguration * dunedaq::confmodel::RCApplication::get_fsm ( ) const
inline

Get "fsm" relationship value.

Returns
the relationship value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 150 of file RCApplication.hpp.

151 {
152 std::lock_guard scoped_lock(m_mutex);
153 check();
154 check_init();
155 if (!m_fsm)
156 {
157 std::ostringstream text;
158 text << "relationship \"" << s_fsm << "\" of object " << this << " is not set";
159 throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
160 }
161 return m_fsm;
162 }
Generic configuration exception.

◆ get_fsm() [2/2]

const dunedaq::confmodel::FSMconfiguration * dunedaq::confmodel::RCApplication::get_fsm ( ) const
inline

Get "fsm" relationship value.

Returns
the relationship value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 150 of file RCApplication.hpp.

151 {
152 std::lock_guard scoped_lock(m_mutex);
153 check();
154 check_init();
155 if (!m_fsm)
156 {
157 std::ostringstream text;
158 text << "relationship \"" << s_fsm << "\" of object " << this << " is not set";
159 throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
160 }
161 return m_fsm;
162 }

◆ init() [1/2]

void dunedaq::confmodel::RCApplication::init ( bool init_children)
protectedvirtual

Initialize object (method generated by genconffwk)

Parameters
init_childrenif true, initialize referenced objects

Reimplemented from dunedaq::confmodel::Application.

Definition at line 75 of file RCApplication.cpp.

76 {
77 Application::init(init_children);
78
79 TLOG_DEBUG(5) << "read object " << this << " (class " << s_class_name << ')';
80
81 try {
85 }
86 catch (dunedaq::conffwk::Exception & ex) {
87 throw_init_ex(ex);
88 }
89 }
void get(const std::string &name, T &value)
Get value of object's attribute or relationship.
void throw_init_ex(dunedaq::conffwk::Exception &ex)
throw object initialisation exception (i.e.
Definition DalObject.cpp:74
DalRegistry & p_registry
Configuration object.
ConfigObject p_obj
Config object used by given template object.
const T * _ref(ConfigObject &obj, const std::string &name, bool read_children)
Get signle value of object's relation and instantiate result with it (multi-thread safe).
virtual void init(bool init_children)
#define TLOG_DEBUG(lvl,...)
Definition Logging.hpp:112

◆ init() [2/2]

virtual void dunedaq::confmodel::RCApplication::init ( bool init_children)
protectedvirtual

Initialize object (method generated by genconffwk)

Parameters
init_childrenif true, initialize referenced objects

Reimplemented from dunedaq::confmodel::Application.

◆ print() [1/2]

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

Print details of the RCApplication object.

Parameters are:

Parameters
offsetnumber of spaces to shift object right (useful to print nested objects)
print_headerif false, do not print object header (to print attributes of base classes)
soutput stream

Reimplemented from dunedaq::confmodel::Application.

Definition at line 43 of file RCApplication.cpp.

44 {
45 check_init();
46
47 try {
48 const std::string str(indent+2, ' ');
49
50 if (print_header)
51 p_hdr(s, indent, s_class_name, "dunedaq::confmodel");
52
53
54 // print direct super-classes
55
57
58
59 // print direct attributes
60
62
63
64 // print direct relationships
65
66 dunedaq::conffwk::p_sv_rel(s, str, indent, s_fsm, m_fsm);
68 }
69 catch (dunedaq::conffwk::Exception & ex) {
71 }
72 }
void p_hdr(std::ostream &s, unsigned int indent, const std::string &cl, const char *nm=nullptr) const
print object headers
Definition DalObject.cpp:65
static void p_error(std::ostream &s, dunedaq::conffwk::Exception &ex)
print error text
Definition DalObject.cpp:59
virtual void print(unsigned int offset, bool print_header, std::ostream &s) const
Print details of the Application object.
void p_sv_rel(std::ostream &s, const std::string &str, const std::string &name, const DalObject *obj)
print weak single-value relationship
void p_sv_attr(std::ostream &s, const std::string &str, const std::string &name, const T &val) noexcept
print single-value attribute

◆ print() [2/2]

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

Print details of the RCApplication object.

Parameters are:

Parameters
offsetnumber of spaces to shift object right (useful to print nested objects)
print_headerif false, do not print object header (to print attributes of base classes)
soutput stream

Reimplemented from dunedaq::confmodel::Application.

◆ set_application_name() [1/2]

void dunedaq::confmodel::RCApplication::set_application_name ( const std::string & value)
inline

Set "application_name" attribute value.

Parameters
valuenew attribute value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 125 of file RCApplication.hpp.

126 {
127 std::lock_guard scoped_lock(m_mutex);
128 check();
129 clear();
131 }
void set_by_ref(const std::string &name, T &value)
Set attribute value.

◆ set_application_name() [2/2]

void dunedaq::confmodel::RCApplication::set_application_name ( const std::string & value)
inline

Set "application_name" attribute value.

Parameters
valuenew attribute value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 125 of file RCApplication.hpp.

126 {
127 std::lock_guard scoped_lock(m_mutex);
128 check();
129 clear();
131 }

◆ set_broadcaster() [1/2]

void dunedaq::confmodel::RCApplication::set_broadcaster ( const dunedaq::confmodel::RCBroadcaster * value)

Set "broadcaster" relationship value.

Parameters
valuenew relationship value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 131 of file RCApplication.cpp.

132 {
134 }
void _set_object(const std::string &name, const T *value)
Helper method for generated set single-value relationship methods.

◆ set_broadcaster() [2/2]

void dunedaq::confmodel::RCApplication::set_broadcaster ( const dunedaq::confmodel::RCBroadcaster * value)

Set "broadcaster" relationship value.

Parameters
valuenew relationship value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

◆ set_fsm() [1/2]

void dunedaq::confmodel::RCApplication::set_fsm ( const dunedaq::confmodel::FSMconfiguration * value)

Set "fsm" relationship value.

Parameters
valuenew relationship value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 126 of file RCApplication.cpp.

127 {
128 _set_object(s_fsm, value);
129 }

◆ set_fsm() [2/2]

void dunedaq::confmodel::RCApplication::set_fsm ( const dunedaq::confmodel::FSMconfiguration * value)

Set "fsm" relationship value.

Parameters
valuenew relationship value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Friends And Related Symbol Documentation

◆ conffwk::Configuration

Definition at line 40 of file RCApplication.hpp.

◆ conffwk::DalFactory

conffwk::DalFactory
friend

Definition at line 42 of file RCApplication.hpp.

◆ conffwk::DalObject

Definition at line 41 of file RCApplication.hpp.

◆ conffwk::DalRegistry

Definition at line 43 of file RCApplication.hpp.

Member Data Documentation

◆ m_application_name

std::string dunedaq::confmodel::RCApplication::m_application_name
private

Definition at line 89 of file RCApplication.hpp.

◆ m_broadcaster

const dunedaq::confmodel::RCBroadcaster * dunedaq::confmodel::RCApplication::m_broadcaster
private

Definition at line 91 of file RCApplication.hpp.

◆ m_fsm

const dunedaq::confmodel::FSMconfiguration * dunedaq::confmodel::RCApplication::m_fsm
private

Definition at line 90 of file RCApplication.hpp.

◆ s_application_name

static const std::string dunedaq::confmodel::RCApplication::s_application_name = "application_name"
inlinestatic

Definition at line 98 of file RCApplication.hpp.

◆ s_broadcaster

static const std::string dunedaq::confmodel::RCApplication::s_broadcaster = "broadcaster"
inlinestatic

Definition at line 137 of file RCApplication.hpp.

◆ s_class_name

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

The name of the configuration class.

Definition at line 55 of file RCApplication.hpp.

◆ s_fsm

static const std::string dunedaq::confmodel::RCApplication::s_fsm = "fsm"
inlinestatic

Definition at line 136 of file RCApplication.hpp.


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