dunedaq::confmodel::Application Class Reference

#include <Application.hpp>

Inheritance diagram for dunedaq::confmodel::Application:

Collaboration diagram for dunedaq::confmodel::Application:

Public Member Functions
virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the Application 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. Name of the application binary to run.
void	set_application_name (const std::string &value)
	Set "application_name" attribute value. Name of the application binary to run.
const std::vector< std::string > &	get_commandline_parameters () const
	Get "commandline_parameters" attribute value. command line parameters to add when starting the application.
void	set_commandline_parameters (const std::vector< std::string > &value)
	Set "commandline_parameters" attribute value. command line parameters to add when starting the application.
const std::string &	get_log_path () const
	Get "log_path" attribute value. Where the applications, controllers and infrastructure applications stdout/err go. This take precedence over the Session's log_path. If none of them is set, PWD is used.
void	set_log_path (const std::string &value)
	Set "log_path" attribute value. Where the applications, controllers and infrastructure applications stdout/err go. This take precedence over the Session's log_path. If none of them is set, PWD is used.
const std::vector< const dunedaq::confmodel::VariableBase * > &	get_application_environment () const
	Get "application_environment" relationship value. Define process environment for this application.
void	set_application_environment (const std::vector< const dunedaq::confmodel::VariableBase * > &value)
	Set "application_environment" relationship value. Define process environment for this application.
const dunedaq::confmodel::VirtualHost *	get_runs_on () const
	Get "runs_on" relationship value. VirtualHost to run this application on.
void	set_runs_on (const dunedaq::confmodel::VirtualHost *value)
	Set "runs_on" relationship value. VirtualHost to run this application on.
const std::vector< const dunedaq::confmodel::Service * > &	get_exposes_service () const
	Get "exposes_service" relationship value. Services exposed i.e. provided by this application.
void	set_exposes_service (const std::vector< const dunedaq::confmodel::Service * > &value)
	Set "exposes_service" relationship value. Services exposed i.e. provided by this application.
const dunedaq::confmodel::OpMonConf *	get_opmon_conf () const
	Get "opmon_conf" relationship value. description of the monitoring behaviour in the application.
void	set_opmon_conf (const dunedaq::confmodel::OpMonConf *value)
	Set "opmon_conf" relationship value. description of the monitoring behaviour in the application.
const std::vector< std::string >	parse_commandline_parameters () const
virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the Application 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. Name of the application binary to run.
void	set_application_name (const std::string &value)
	Set "application_name" attribute value. Name of the application binary to run.
const std::vector< std::string > &	get_commandline_parameters () const
	Get "commandline_parameters" attribute value. command line parameters to add when starting the application.
void	set_commandline_parameters (const std::vector< std::string > &value)
	Set "commandline_parameters" attribute value. command line parameters to add when starting the application.
const std::string &	get_log_path () const
	Get "log_path" attribute value. Where the applications, controllers and infrastructure applications stdout/err go. This take precedence over the Session's log_path. If none of them is set, PWD is used.
void	set_log_path (const std::string &value)
	Set "log_path" attribute value. Where the applications, controllers and infrastructure applications stdout/err go. This take precedence over the Session's log_path. If none of them is set, PWD is used.
const std::vector< const dunedaq::confmodel::VariableBase * > &	get_application_environment () const
	Get "application_environment" relationship value. Define process environment for this application.
void	set_application_environment (const std::vector< const dunedaq::confmodel::VariableBase * > &value)
	Set "application_environment" relationship value. Define process environment for this application.
const dunedaq::confmodel::VirtualHost *	get_runs_on () const
	Get "runs_on" relationship value. VirtualHost to run this application on.
void	set_runs_on (const dunedaq::confmodel::VirtualHost *value)
	Set "runs_on" relationship value. VirtualHost to run this application on.
const std::vector< const dunedaq::confmodel::Service * > &	get_exposes_service () const
	Get "exposes_service" relationship value. Services exposed i.e. provided by this application.
void	set_exposes_service (const std::vector< const dunedaq::confmodel::Service * > &value)
	Set "exposes_service" relationship value. Services exposed i.e. provided by this application.
const dunedaq::confmodel::OpMonConf *	get_opmon_conf () const
	Get "opmon_conf" relationship value. description of the monitoring behaviour in the application.
void	set_opmon_conf (const dunedaq::confmodel::OpMonConf *value)
	Set "opmon_conf" relationship value. description of the monitoring behaviour in the application.
const std::vector< std::string >	parse_commandline_parameters () const
Public Member Functions inherited from dunedaq::conffwk::DalObject
const std::string &	UID () const noexcept
const std::string &	class_name () const noexcept
bool	castable (const std::string &target) const noexcept
bool	castable (const std::string *target) const noexcept
template<class TARGET >
const TARGET *	cast () const noexcept
	Casts object to different class.
std::string	full_name () const noexcept
const ConfigObject &	config_object () const
DalRegistry &	registry () const noexcept
Configuration &	configuration () const noexcept
void	unread ()
void	set (const ConfigObject &o) noexcept
void	move (const std::string &at)
void	rename (const std::string &new_id)
void	p_hdr (std::ostream &s, unsigned int indent, const std::string &cl, const char *nm=nullptr) const
	print object headers
std::ostream &	print_object (std::ostream &s) const
	print object details
void	throw_init_ex (dunedaq::conffwk::Exception &ex)
	throw object initialisation exception (i.e.

Static Public Member Functions
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_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
	Application (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~Application () 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
	Application (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~Application () 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_application_name
std::vector< std::string >	m_commandline_parameters
std::string	m_log_path
std::vector< const dunedaq::confmodel::VariableBase * >	m_application_environment
const dunedaq::confmodel::VirtualHost *	m_runs_on
std::vector< const dunedaq::confmodel::Service * >	m_exposes_service
const dunedaq::confmodel::OpMonConf *	m_opmon_conf

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

Additional Inherited Members
Protected Attributes inherited from dunedaq::conffwk::DalObject
std::mutex	m_mutex
	Used to protect changes of DAL object.
bool	p_was_read
	is true, if the object was read
DalRegistry &	p_registry
	Configuration object.
ConfigObject	p_obj
	Config object used by given template object.
std::string	p_UID
	Is used for template objects (see dqm_conffwk)

Detailed Description

A software executable

Definition at line 36 of file Application.hpp.

Constructor & Destructor Documentation

Application() [1/2]

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

protectednoexcept

Definition at line 23 of file Application.cpp.

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

~Application() [1/2]

dunedaq::confmodel::Application::~Application ( )

protectedvirtualnoexcept

Definition at line 84 of file Application.cpp.

    {
    }

Application() [2/2]

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

protectednoexcept

~Application() [2/2]

virtual dunedaq::confmodel::Application::~Application ( )

protectedvirtualnoexcept

Member Function Documentation

__get_application_environment_str() [1/2]

static const std::string & dunedaq::confmodel::Application::__get_application_environment_str ( )

inlinestaticnoexcept

Definition at line 215 of file Application.hpp.

{ return s_application_environment; }

__get_application_environment_str() [2/2]

static const std::string & dunedaq::confmodel::Application::__get_application_environment_str ( )

inlinestaticnoexcept

Definition at line 215 of file Application.hpp.

{ return s_application_environment; }

__get_application_name_str() [1/2]

static const std::string & dunedaq::confmodel::Application::__get_application_name_str ( )

inlinestaticnoexcept

Definition at line 104 of file Application.hpp.

{ return s_application_name; }

__get_application_name_str() [2/2]

static const std::string & dunedaq::confmodel::Application::__get_application_name_str ( )

inlinestaticnoexcept

Definition at line 104 of file Application.hpp.

{ return s_application_name; }

__get_commandline_parameters_str() [1/2]

static const std::string & dunedaq::confmodel::Application::__get_commandline_parameters_str ( )

inlinestaticnoexcept

Definition at line 105 of file Application.hpp.

{ return s_commandline_parameters; }

__get_commandline_parameters_str() [2/2]

static const std::string & dunedaq::confmodel::Application::__get_commandline_parameters_str ( )

inlinestaticnoexcept

Definition at line 105 of file Application.hpp.

{ return s_commandline_parameters; }

__get_exposes_service_str() [1/2]

static const std::string & dunedaq::confmodel::Application::__get_exposes_service_str ( )

inlinestaticnoexcept

Definition at line 217 of file Application.hpp.

{ return s_exposes_service; }

__get_exposes_service_str() [2/2]

static const std::string & dunedaq::confmodel::Application::__get_exposes_service_str ( )

inlinestaticnoexcept

Definition at line 217 of file Application.hpp.

{ return s_exposes_service; }

__get_log_path_str() [1/2]

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

inlinestaticnoexcept

Definition at line 106 of file Application.hpp.

{ return s_log_path; }

__get_log_path_str() [2/2]

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

inlinestaticnoexcept

Definition at line 106 of file Application.hpp.

{ return s_log_path; }

__get_opmon_conf_str() [1/2]

static const std::string & dunedaq::confmodel::Application::__get_opmon_conf_str ( )

inlinestaticnoexcept

Definition at line 218 of file Application.hpp.

{ return s_opmon_conf; }

__get_opmon_conf_str() [2/2]

static const std::string & dunedaq::confmodel::Application::__get_opmon_conf_str ( )

inlinestaticnoexcept

Definition at line 218 of file Application.hpp.

{ return s_opmon_conf; }

__get_runs_on_str() [1/2]

static const std::string & dunedaq::confmodel::Application::__get_runs_on_str ( )

inlinestaticnoexcept

Definition at line 216 of file Application.hpp.

{ return s_runs_on; }

__get_runs_on_str() [2/2]

static const std::string & dunedaq::confmodel::Application::__get_runs_on_str ( )

inlinestaticnoexcept

Definition at line 216 of file Application.hpp.

{ return s_runs_on; }

get() [1/4]

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

Reimplemented in dunedaq::appmodel::CRTReaderApplication, dunedaq::appmodel::CRTReaderApplication, dunedaq::appmodel::CTBApplication, dunedaq::appmodel::CTBApplication, dunedaq::appmodel::DaphneApplication, dunedaq::appmodel::DaphneApplication, dunedaq::appmodel::DFApplication, dunedaq::appmodel::DFApplication, dunedaq::appmodel::DFOApplication, dunedaq::appmodel::DFOApplication, dunedaq::appmodel::DTSHSIApplication, dunedaq::appmodel::DTSHSIApplication, dunedaq::appmodel::FakeDataApplication, dunedaq::appmodel::FakeDataApplication, dunedaq::appmodel::FakeHSIApplication, dunedaq::appmodel::FakeHSIApplication, dunedaq::appmodel::HSIEventToTCApplication, dunedaq::appmodel::HSIEventToTCApplication, dunedaq::appmodel::MLTApplication, dunedaq::appmodel::MLTApplication, dunedaq::appmodel::NP02ReadoutApplication, dunedaq::appmodel::NP02ReadoutApplication, dunedaq::appmodel::ReadoutApplication, dunedaq::appmodel::ReadoutApplication, dunedaq::appmodel::SmartDaqApplication, dunedaq::appmodel::SmartDaqApplication, dunedaq::appmodel::TDECrateApplication, dunedaq::appmodel::TDECrateApplication, dunedaq::appmodel::TPReplayApplication, dunedaq::appmodel::TPReplayApplication, dunedaq::appmodel::TPStreamWriterApplication, dunedaq::appmodel::TPStreamWriterApplication, dunedaq::appmodel::TriggerApplication, dunedaq::appmodel::TriggerApplication, dunedaq::appmodel::WIECApplication, dunedaq::appmodel::WIECApplication, dunedaq::confmodel::ConnectionService, dunedaq::confmodel::ConnectionService, dunedaq::confmodel::DaqApplication, dunedaq::confmodel::DaqApplication, dunedaq::confmodel::RCApplication, and dunedaq::confmodel::RCApplication.

Definition at line 88 of file Application.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::Application::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.

Reimplemented in dunedaq::appmodel::CRTReaderApplication, dunedaq::appmodel::CRTReaderApplication, dunedaq::appmodel::CTBApplication, dunedaq::appmodel::CTBApplication, dunedaq::appmodel::DaphneApplication, dunedaq::appmodel::DaphneApplication, dunedaq::appmodel::DFApplication, dunedaq::appmodel::DFApplication, dunedaq::appmodel::DFOApplication, dunedaq::appmodel::DFOApplication, dunedaq::appmodel::DTSHSIApplication, dunedaq::appmodel::DTSHSIApplication, dunedaq::appmodel::FakeDataApplication, dunedaq::appmodel::FakeDataApplication, dunedaq::appmodel::FakeHSIApplication, dunedaq::appmodel::FakeHSIApplication, dunedaq::appmodel::HSIEventToTCApplication, dunedaq::appmodel::HSIEventToTCApplication, dunedaq::appmodel::MLTApplication, dunedaq::appmodel::MLTApplication, dunedaq::appmodel::NP02ReadoutApplication, dunedaq::appmodel::NP02ReadoutApplication, dunedaq::appmodel::ReadoutApplication, dunedaq::appmodel::ReadoutApplication, dunedaq::appmodel::SmartDaqApplication, dunedaq::appmodel::SmartDaqApplication, dunedaq::appmodel::TDECrateApplication, dunedaq::appmodel::TDECrateApplication, dunedaq::appmodel::TPReplayApplication, dunedaq::appmodel::TPReplayApplication, dunedaq::appmodel::TPStreamWriterApplication, dunedaq::appmodel::TPStreamWriterApplication, dunedaq::appmodel::TriggerApplication, dunedaq::appmodel::TriggerApplication, dunedaq::appmodel::WIECApplication, dunedaq::appmodel::WIECApplication, dunedaq::confmodel::ConnectionService, dunedaq::confmodel::ConnectionService, dunedaq::confmodel::DaqApplication, dunedaq::confmodel::DaqApplication, dunedaq::confmodel::RCApplication, and dunedaq::confmodel::RCApplication.

get() [3/4]

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

protected

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

protected

get_application_environment() [1/2]

const std::vector< const dunedaq::confmodel::VariableBase * > & dunedaq::confmodel::Application::get_application_environment ( ) const

inline

Get "application_environment" relationship value. Define process environment for this application.

Returns

the relationship value

Exceptions

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

Definition at line 229 of file Application.hpp.

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

get_application_environment() [2/2]

const std::vector< const dunedaq::confmodel::VariableBase * > & dunedaq::confmodel::Application::get_application_environment ( ) const

inline

Get "application_environment" relationship value. Define process environment for this application.

Returns

the relationship value

Exceptions

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

Definition at line 229 of file Application.hpp.

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

get_application_name() [1/2]

const std::string & dunedaq::confmodel::Application::get_application_name ( ) const

inline

Get "application_name" attribute value. Name of the application binary to run.

Returns

the attribute value

Exceptions

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

Definition at line 117 of file Application.hpp.

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

get_application_name() [2/2]

const std::string & dunedaq::confmodel::Application::get_application_name ( ) const

inline

Get "application_name" attribute value. Name of the application binary to run.

Returns

the attribute value

Exceptions

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

Definition at line 117 of file Application.hpp.

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

get_commandline_parameters() [1/2]

const std::vector< std::string > & dunedaq::confmodel::Application::get_commandline_parameters ( ) const

inline

Get "commandline_parameters" attribute value. command line parameters to add when starting the application.

Returns

the attribute value

Exceptions

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

Definition at line 150 of file Application.hpp.

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

get_commandline_parameters() [2/2]

const std::vector< std::string > & dunedaq::confmodel::Application::get_commandline_parameters ( ) const

inline

Get "commandline_parameters" attribute value. command line parameters to add when starting the application.

Returns

the attribute value

Exceptions

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

Definition at line 150 of file Application.hpp.

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

get_exposes_service() [1/2]

const std::vector< const dunedaq::confmodel::Service * > & dunedaq::confmodel::Application::get_exposes_service ( ) const

inline

Get "exposes_service" relationship value. Services exposed i.e. provided by this application.

Returns

the relationship value

Exceptions

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

Definition at line 289 of file Application.hpp.

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

get_exposes_service() [2/2]

const std::vector< const dunedaq::confmodel::Service * > & dunedaq::confmodel::Application::get_exposes_service ( ) const

inline

Get "exposes_service" relationship value. Services exposed i.e. provided by this application.

Returns

the relationship value

Exceptions

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

Definition at line 289 of file Application.hpp.

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

get_log_path() [1/2]

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

inline

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.

Returns

the attribute value

Exceptions

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

Definition at line 183 of file Application.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::Application::get_log_path ( ) const

inline

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.

Returns

the attribute value

Exceptions

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

Definition at line 183 of file Application.hpp.

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

get_opmon_conf() [1/2]

const dunedaq::confmodel::OpMonConf * dunedaq::confmodel::Application::get_opmon_conf ( ) const

inline

Get "opmon_conf" relationship value. description of the monitoring behaviour in the application.

Returns

the relationship value

Exceptions

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

Definition at line 316 of file Application.hpp.

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

get_opmon_conf() [2/2]

const dunedaq::confmodel::OpMonConf * dunedaq::confmodel::Application::get_opmon_conf ( ) const

inline

Get "opmon_conf" relationship value. description of the monitoring behaviour in the application.

Returns

the relationship value

Exceptions

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

Definition at line 316 of file Application.hpp.

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

get_runs_on() [1/2]

const dunedaq::confmodel::VirtualHost * dunedaq::confmodel::Application::get_runs_on ( ) const

inline

Get "runs_on" relationship value. VirtualHost to run this application on.

Returns

the relationship value

Exceptions

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

Definition at line 256 of file Application.hpp.

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

get_runs_on() [2/2]

const dunedaq::confmodel::VirtualHost * dunedaq::confmodel::Application::get_runs_on ( ) const

inline

Get "runs_on" relationship value. VirtualHost to run this application on.

Returns

the relationship value

Exceptions

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

Definition at line 256 of file Application.hpp.

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

init() [1/2]

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

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children

if true, initialize referenced objects

Implements dunedaq::conffwk::DalObject.

Reimplemented in dunedaq::appmodel::CRTReaderApplication, dunedaq::appmodel::CRTReaderApplication, dunedaq::appmodel::CTBApplication, dunedaq::appmodel::CTBApplication, dunedaq::appmodel::DaphneApplication, dunedaq::appmodel::DaphneApplication, dunedaq::appmodel::DFApplication, dunedaq::appmodel::DFApplication, dunedaq::appmodel::DFOApplication, dunedaq::appmodel::DFOApplication, dunedaq::appmodel::DTSHSIApplication, dunedaq::appmodel::DTSHSIApplication, dunedaq::appmodel::FakeDataApplication, dunedaq::appmodel::FakeDataApplication, dunedaq::appmodel::FakeHSIApplication, dunedaq::appmodel::FakeHSIApplication, dunedaq::appmodel::HSIEventToTCApplication, dunedaq::appmodel::HSIEventToTCApplication, dunedaq::appmodel::MLTApplication, dunedaq::appmodel::MLTApplication, dunedaq::appmodel::NP02ReadoutApplication, dunedaq::appmodel::NP02ReadoutApplication, dunedaq::appmodel::ReadoutApplication, dunedaq::appmodel::ReadoutApplication, dunedaq::appmodel::SmartDaqApplication, dunedaq::appmodel::SmartDaqApplication, dunedaq::appmodel::TDECrateApplication, dunedaq::appmodel::TDECrateApplication, dunedaq::appmodel::TPReplayApplication, dunedaq::appmodel::TPReplayApplication, dunedaq::appmodel::TPStreamWriterApplication, dunedaq::appmodel::TPStreamWriterApplication, dunedaq::appmodel::TriggerApplication, dunedaq::appmodel::TriggerApplication, dunedaq::appmodel::WIECApplication, dunedaq::appmodel::WIECApplication, dunedaq::confmodel::ConnectionService, dunedaq::confmodel::ConnectionService, dunedaq::confmodel::DaqApplication, dunedaq::confmodel::DaqApplication, dunedaq::confmodel::RCApplication, and dunedaq::confmodel::RCApplication.

Definition at line 64 of file Application.cpp.

    {
      p_was_read = true;
      increment_read();
      TLOG_DEBUG(5) << "read object " << this << " (class " << s_class_name << ')';
 
      try {
        p_obj.get(s_application_name, m_application_name);
        p_obj.get(s_commandline_parameters, m_commandline_parameters);
        p_obj.get(s_log_path, m_log_path);
        p_registry._ref<dunedaq::confmodel::VariableBase>(p_obj, s_application_environment, m_application_environment, init_children);
        m_runs_on = p_registry._ref<dunedaq::confmodel::VirtualHost>(p_obj, s_runs_on, init_children);
        p_registry._ref<dunedaq::confmodel::Service>(p_obj, s_exposes_service, m_exposes_service, init_children);
        m_opmon_conf = p_registry._ref<dunedaq::confmodel::OpMonConf>(p_obj, s_opmon_conf, init_children);
      }
      catch (dunedaq::conffwk::Exception & ex) {
        throw_init_ex(ex);
      }
    }

init() [2/2]

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

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children

if true, initialize referenced objects

Implements dunedaq::conffwk::DalObject.

Reimplemented in dunedaq::appmodel::CRTReaderApplication, dunedaq::appmodel::CRTReaderApplication, dunedaq::appmodel::CTBApplication, dunedaq::appmodel::CTBApplication, dunedaq::appmodel::DaphneApplication, dunedaq::appmodel::DaphneApplication, dunedaq::appmodel::DFApplication, dunedaq::appmodel::DFApplication, dunedaq::appmodel::DFOApplication, dunedaq::appmodel::DFOApplication, dunedaq::appmodel::DTSHSIApplication, dunedaq::appmodel::DTSHSIApplication, dunedaq::appmodel::FakeDataApplication, dunedaq::appmodel::FakeDataApplication, dunedaq::appmodel::FakeHSIApplication, dunedaq::appmodel::FakeHSIApplication, dunedaq::appmodel::HSIEventToTCApplication, dunedaq::appmodel::HSIEventToTCApplication, dunedaq::appmodel::MLTApplication, dunedaq::appmodel::MLTApplication, dunedaq::appmodel::NP02ReadoutApplication, dunedaq::appmodel::NP02ReadoutApplication, dunedaq::appmodel::ReadoutApplication, dunedaq::appmodel::ReadoutApplication, dunedaq::appmodel::SmartDaqApplication, dunedaq::appmodel::SmartDaqApplication, dunedaq::appmodel::TDECrateApplication, dunedaq::appmodel::TDECrateApplication, dunedaq::appmodel::TPReplayApplication, dunedaq::appmodel::TPReplayApplication, dunedaq::appmodel::TPStreamWriterApplication, dunedaq::appmodel::TPStreamWriterApplication, dunedaq::appmodel::TriggerApplication, dunedaq::appmodel::TriggerApplication, dunedaq::appmodel::WIECApplication, dunedaq::appmodel::WIECApplication, dunedaq::confmodel::ConnectionService, dunedaq::confmodel::ConnectionService, dunedaq::confmodel::DaqApplication, dunedaq::confmodel::DaqApplication, dunedaq::confmodel::RCApplication, and dunedaq::confmodel::RCApplication.

parse_commandline_parameters() [1/2]

const std::vector< std::string > dunedaq::confmodel::Application::parse_commandline_parameters

(

)

const

Get the CLA for the application

parse_commandline_parameters() [2/2]

const std::vector< std::string > dunedaq::confmodel::Application::parse_commandline_parameters

(

)

const

Get the CLA for the application

print() [1/2]

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

virtual

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

Reimplemented in dunedaq::appmodel::CRTReaderApplication, dunedaq::appmodel::CRTReaderApplication, dunedaq::appmodel::CTBApplication, dunedaq::appmodel::CTBApplication, dunedaq::appmodel::DaphneApplication, dunedaq::appmodel::DaphneApplication, dunedaq::appmodel::DFApplication, dunedaq::appmodel::DFApplication, dunedaq::appmodel::DFOApplication, dunedaq::appmodel::DFOApplication, dunedaq::appmodel::DTSHSIApplication, dunedaq::appmodel::DTSHSIApplication, dunedaq::appmodel::FakeDataApplication, dunedaq::appmodel::FakeDataApplication, dunedaq::appmodel::FakeHSIApplication, dunedaq::appmodel::FakeHSIApplication, dunedaq::appmodel::HSIEventToTCApplication, dunedaq::appmodel::HSIEventToTCApplication, dunedaq::appmodel::MLTApplication, dunedaq::appmodel::MLTApplication, dunedaq::appmodel::NP02ReadoutApplication, dunedaq::appmodel::NP02ReadoutApplication, dunedaq::appmodel::ReadoutApplication, dunedaq::appmodel::ReadoutApplication, dunedaq::appmodel::SmartDaqApplication, dunedaq::appmodel::SmartDaqApplication, dunedaq::appmodel::TDECrateApplication, dunedaq::appmodel::TDECrateApplication, dunedaq::appmodel::TPReplayApplication, dunedaq::appmodel::TPReplayApplication, dunedaq::appmodel::TPStreamWriterApplication, dunedaq::appmodel::TPStreamWriterApplication, dunedaq::appmodel::TriggerApplication, dunedaq::appmodel::TriggerApplication, dunedaq::appmodel::WIECApplication, dunedaq::appmodel::WIECApplication, dunedaq::confmodel::ConnectionService, dunedaq::confmodel::ConnectionService, dunedaq::confmodel::DaqApplication, dunedaq::confmodel::DaqApplication, dunedaq::confmodel::RCApplication, and dunedaq::confmodel::RCApplication.

Definition at line 33 of file Application.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_application_name, m_application_name);
        dunedaq::conffwk::p_mv_attr(s, str, s_commandline_parameters, m_commandline_parameters);
        dunedaq::conffwk::p_sv_attr(s, str, s_log_path, m_log_path);
 
 
          // print direct relationships
 
        dunedaq::conffwk::p_mv_rel(s, str, s_application_environment, m_application_environment);
        dunedaq::conffwk::p_sv_rel(s, str, indent, s_runs_on, m_runs_on);
        dunedaq::conffwk::p_mv_rel(s, str, indent, s_exposes_service, m_exposes_service);
        dunedaq::conffwk::p_sv_rel(s, str, s_opmon_conf, m_opmon_conf);
      }
      catch (dunedaq::conffwk::Exception & ex) {
        dunedaq::conffwk::DalObject::p_error(s, ex);
      }
    }

print() [2/2]

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

virtual

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

Reimplemented in dunedaq::appmodel::CRTReaderApplication, dunedaq::appmodel::CRTReaderApplication, dunedaq::appmodel::CTBApplication, dunedaq::appmodel::CTBApplication, dunedaq::appmodel::DaphneApplication, dunedaq::appmodel::DaphneApplication, dunedaq::appmodel::DFApplication, dunedaq::appmodel::DFApplication, dunedaq::appmodel::DFOApplication, dunedaq::appmodel::DFOApplication, dunedaq::appmodel::DTSHSIApplication, dunedaq::appmodel::DTSHSIApplication, dunedaq::appmodel::FakeDataApplication, dunedaq::appmodel::FakeDataApplication, dunedaq::appmodel::FakeHSIApplication, dunedaq::appmodel::FakeHSIApplication, dunedaq::appmodel::HSIEventToTCApplication, dunedaq::appmodel::HSIEventToTCApplication, dunedaq::appmodel::MLTApplication, dunedaq::appmodel::MLTApplication, dunedaq::appmodel::NP02ReadoutApplication, dunedaq::appmodel::NP02ReadoutApplication, dunedaq::appmodel::ReadoutApplication, dunedaq::appmodel::ReadoutApplication, dunedaq::appmodel::SmartDaqApplication, dunedaq::appmodel::SmartDaqApplication, dunedaq::appmodel::TDECrateApplication, dunedaq::appmodel::TDECrateApplication, dunedaq::appmodel::TPReplayApplication, dunedaq::appmodel::TPReplayApplication, dunedaq::appmodel::TPStreamWriterApplication, dunedaq::appmodel::TPStreamWriterApplication, dunedaq::appmodel::TriggerApplication, dunedaq::appmodel::TriggerApplication, dunedaq::appmodel::WIECApplication, dunedaq::appmodel::WIECApplication, dunedaq::confmodel::ConnectionService, dunedaq::confmodel::ConnectionService, dunedaq::confmodel::DaqApplication, dunedaq::confmodel::DaqApplication, dunedaq::confmodel::RCApplication, and dunedaq::confmodel::RCApplication.

set_application_environment() [1/2]

void dunedaq::confmodel::Application::set_application_environment

(

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

value

)

Set "application_environment" relationship value. Define process environment for this application.

Parameters

value

new relationship value

Exceptions

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

Definition at line 117 of file Application.cpp.

    {
      _set_objects(s_application_environment, value);
    }

set_application_environment() [2/2]

void dunedaq::confmodel::Application::set_application_environment

(

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

value

)

Set "application_environment" relationship value. Define process environment for this application.

Parameters

value

new relationship value

Exceptions

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

set_application_name() [1/2]

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

inline

Set "application_name" attribute value. Name of the application binary to run.

Parameters

value

new attribute value

Exceptions

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

Definition at line 133 of file Application.hpp.

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

set_application_name() [2/2]

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

inline

Set "application_name" attribute value. Name of the application binary to run.

Parameters

value

new attribute value

Exceptions

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

Definition at line 133 of file Application.hpp.

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

set_commandline_parameters() [1/2]

void dunedaq::confmodel::Application::set_commandline_parameters ( const std::vector< std::string > & value )

inline

Set "commandline_parameters" attribute value. command line parameters to add when starting the application.

Parameters

value

new attribute value

Exceptions

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

Definition at line 166 of file Application.hpp.

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

set_commandline_parameters() [2/2]

void dunedaq::confmodel::Application::set_commandline_parameters ( const std::vector< std::string > & value )

inline

Set "commandline_parameters" attribute value. command line parameters to add when starting the application.

Parameters

value

new attribute value

Exceptions

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

Definition at line 166 of file Application.hpp.

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

set_exposes_service() [1/2]

void dunedaq::confmodel::Application::set_exposes_service

(

const std::vector< const dunedaq::confmodel::Service * > &

value

)

Set "exposes_service" relationship value. Services exposed i.e. provided by this application.

Parameters

value

new relationship value

Exceptions

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

Definition at line 127 of file Application.cpp.

    {
      _set_objects(s_exposes_service, value);
    }

set_exposes_service() [2/2]

void dunedaq::confmodel::Application::set_exposes_service

(

const std::vector< const dunedaq::confmodel::Service * > &

value

)

Set "exposes_service" relationship value. Services exposed i.e. provided by this application.

Parameters

value

new relationship value

Exceptions

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

set_log_path() [1/2]

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

inline

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.

Parameters

value

new attribute value

Exceptions

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

Definition at line 199 of file Application.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::Application::set_log_path ( const std::string & value )

inline

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.

Parameters

value

new attribute value

Exceptions

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

Definition at line 199 of file Application.hpp.

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

set_opmon_conf() [1/2]

void dunedaq::confmodel::Application::set_opmon_conf

(

const dunedaq::confmodel::OpMonConf *

value

)

Set "opmon_conf" relationship value. description of the monitoring behaviour in the application.

Parameters

value

new relationship value

Exceptions

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

Definition at line 132 of file Application.cpp.

    {
      _set_object(s_opmon_conf, value);
    }

set_opmon_conf() [2/2]

void dunedaq::confmodel::Application::set_opmon_conf

(

const dunedaq::confmodel::OpMonConf *

value

)

Set "opmon_conf" relationship value. description of the monitoring behaviour in the application.

Parameters

value

new relationship value

Exceptions

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

set_runs_on() [1/2]

void dunedaq::confmodel::Application::set_runs_on

(

const dunedaq::confmodel::VirtualHost *

value

)

Set "runs_on" relationship value. VirtualHost to run this application on.

Parameters

value

new relationship value

Exceptions

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

Definition at line 122 of file Application.cpp.

    {
      _set_object(s_runs_on, value);
    }

set_runs_on() [2/2]

void dunedaq::confmodel::Application::set_runs_on

(

const dunedaq::confmodel::VirtualHost *

value

)

Set "runs_on" relationship value. VirtualHost to run this application on.

Parameters

value

new relationship value

Exceptions

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

Friends And Related Symbol Documentation

conffwk::Configuration

conffwk::Configuration

friend

Definition at line 38 of file Application.hpp.

conffwk::DalFactory

conffwk::DalFactory

friend

Definition at line 40 of file Application.hpp.

conffwk::DalObject

conffwk::DalObject

friend

Definition at line 39 of file Application.hpp.

conffwk::DalRegistry

conffwk::DalRegistry

friend

Definition at line 41 of file Application.hpp.

Member Data Documentation

m_application_environment

std::vector< const dunedaq::confmodel::VariableBase * > dunedaq::confmodel::Application::m_application_environment

private

Definition at line 90 of file Application.hpp.

m_application_name

std::string dunedaq::confmodel::Application::m_application_name

private

Definition at line 87 of file Application.hpp.

m_commandline_parameters

std::vector< std::string > dunedaq::confmodel::Application::m_commandline_parameters

private

Definition at line 88 of file Application.hpp.

m_exposes_service

std::vector< const dunedaq::confmodel::Service * > dunedaq::confmodel::Application::m_exposes_service

private

Definition at line 92 of file Application.hpp.

m_log_path

std::string dunedaq::confmodel::Application::m_log_path

private

Definition at line 89 of file Application.hpp.

m_opmon_conf

const dunedaq::confmodel::OpMonConf * dunedaq::confmodel::Application::m_opmon_conf

private

Definition at line 93 of file Application.hpp.

m_runs_on

const dunedaq::confmodel::VirtualHost * dunedaq::confmodel::Application::m_runs_on

private

Definition at line 91 of file Application.hpp.

s_application_environment

static const std::string dunedaq::confmodel::Application::s_application_environment = "application_environment"

inlinestatic

Definition at line 210 of file Application.hpp.

s_application_name

static const std::string dunedaq::confmodel::Application::s_application_name = "application_name"

inlinestatic

Definition at line 100 of file Application.hpp.

s_class_name

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

static

The name of the configuration class.

Definition at line 53 of file Application.hpp.

s_commandline_parameters

static const std::string dunedaq::confmodel::Application::s_commandline_parameters = "commandline_parameters"

inlinestatic

Definition at line 101 of file Application.hpp.

s_exposes_service

static const std::string dunedaq::confmodel::Application::s_exposes_service = "exposes_service"

inlinestatic

Definition at line 212 of file Application.hpp.

s_log_path

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

inlinestatic

Definition at line 102 of file Application.hpp.

s_opmon_conf

static const std::string dunedaq::confmodel::Application::s_opmon_conf = "opmon_conf"

inlinestatic

Definition at line 213 of file Application.hpp.

s_runs_on

static const std::string dunedaq::confmodel::Application::s_runs_on = "runs_on"

inlinestatic

Definition at line 211 of file Application.hpp.

---

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

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