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

#include <TPReplayModule.hpp>

Inheritance diagram for dunedaq::appmodel::TPReplayModule:
[legend]
Collaboration diagram for dunedaq::appmodel::TPReplayModule:
[legend]

Public Member Functions

virtual void print (unsigned int offset, bool print_header, std::ostream &s) const
 Print details of the TPReplayModule object.
 
virtual std::vector< const dunedaq::conffwk::DalObject * > get (const std::string &name, bool upcast_unregistered=true) const
 Get values of relationships and results of some algorithms as a vector of dunedaq::conffwk::DalObject pointers.
 
const dunedaq::appmodel::TPReplayModuleConfget_configuration () const
 Get "configuration" relationship value.
 
void set_configuration (const dunedaq::appmodel::TPReplayModuleConf *value)
 Set "configuration" relationship value.
 
virtual void print (unsigned int offset, bool print_header, std::ostream &s) const
 Print details of the TPReplayModule object.
 
virtual std::vector< const dunedaq::conffwk::DalObject * > get (const std::string &name, bool upcast_unregistered=true) const
 Get values of relationships and results of some algorithms as a vector of dunedaq::conffwk::DalObject pointers.
 
const dunedaq::appmodel::TPReplayModuleConfget_configuration () const
 Get "configuration" relationship value.
 
void set_configuration (const dunedaq::appmodel::TPReplayModuleConf *value)
 Set "configuration" relationship value.
 
- Public Member Functions inherited from dunedaq::confmodel::DaqModule
const std::vector< const dunedaq::confmodel::Connection * > & get_inputs () const
 Get "inputs" relationship value. List of connections to/from this module.
 
void set_inputs (const std::vector< const dunedaq::confmodel::Connection * > &value)
 Set "inputs" relationship value. List of connections to/from this module.
 
const std::vector< const dunedaq::confmodel::Connection * > & get_outputs () const
 Get "outputs" relationship value. Output connections from this module.
 
void set_outputs (const std::vector< const dunedaq::confmodel::Connection * > &value)
 Set "outputs" relationship value. Output connections from this module.
 
const std::vector< const dunedaq::confmodel::HostComponent * > & get_used_resources () const
 Get "used_resources" relationship value.
 
void set_used_resources (const std::vector< const dunedaq::confmodel::HostComponent * > &value)
 Set "used_resources" relationship value.
 
const std::vector< const dunedaq::confmodel::Connection * > & get_inputs () const
 Get "inputs" relationship value. List of connections to/from this module.
 
void set_inputs (const std::vector< const dunedaq::confmodel::Connection * > &value)
 Set "inputs" relationship value. List of connections to/from this module.
 
const std::vector< const dunedaq::confmodel::Connection * > & get_outputs () const
 Get "outputs" relationship value. Output connections from this module.
 
void set_outputs (const std::vector< const dunedaq::confmodel::Connection * > &value)
 Set "outputs" relationship value. Output connections from this module.
 
const std::vector< const dunedaq::confmodel::HostComponent * > & get_used_resources () const
 Get "used_resources" relationship value.
 
void set_used_resources (const std::vector< const dunedaq::confmodel::HostComponent * > &value)
 Set "used_resources" relationship value.
 
- 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_configuration_str () noexcept
 
static const std::string & __get_configuration_str () noexcept
 
- Static Public Member Functions inherited from dunedaq::confmodel::DaqModule
static const std::string & __get_inputs_str () noexcept
 
static const std::string & __get_outputs_str () noexcept
 
static const std::string & __get_used_resources_str () noexcept
 
static const std::string & __get_inputs_str () noexcept
 
static const std::string & __get_outputs_str () noexcept
 
static const std::string & __get_used_resources_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_configuration = "configuration"
 
- Static Public Attributes inherited from dunedaq::confmodel::DaqModule
static const std::string & s_class_name
 
static const std::string s_inputs = "inputs"
 
static const std::string s_outputs = "outputs"
 
static const std::string s_used_resources = "used_resources"
 

Protected Member Functions

 TPReplayModule (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~TPReplayModule () 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
 
 TPReplayModule (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~TPReplayModule () 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::DaqModule
 DaqModule (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~DaqModule () noexcept
 
bool get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const
 
 DaqModule (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~DaqModule () 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

const dunedaq::appmodel::TPReplayModuleConfm_configuration
 

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

Definition at line 32 of file TPReplayModule.hpp.

Constructor & Destructor Documentation

◆ TPReplayModule() [1/2]

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

Definition at line 31 of file TPReplayModule.cpp.

31 :
34 m_configuration (nullptr)
35
36 {
37 ;
38 }
const dunedaq::appmodel::TPReplayModuleConf * m_configuration
The base class for any generated DAL object.
Definition DalObject.hpp:45

◆ ~TPReplayModule() [1/2]

dunedaq::appmodel::TPReplayModule::~TPReplayModule ( )
protectedvirtualnoexcept

Definition at line 81 of file TPReplayModule.cpp.

82 {
83 }

◆ TPReplayModule() [2/2]

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

◆ ~TPReplayModule() [2/2]

virtual dunedaq::appmodel::TPReplayModule::~TPReplayModule ( )
protectedvirtualnoexcept

Member Function Documentation

◆ __get_configuration_str() [1/2]

static const std::string & dunedaq::appmodel::TPReplayModule::__get_configuration_str ( )
inlinestaticnoexcept

Definition at line 92 of file TPReplayModule.hpp.

92{ return s_configuration; }
static const std::string s_configuration

◆ __get_configuration_str() [2/2]

static const std::string & dunedaq::appmodel::TPReplayModule::__get_configuration_str ( )
inlinestaticnoexcept

Definition at line 92 of file TPReplayModule.hpp.

92{ return s_configuration; }

◆ get() [1/4]

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

Definition at line 85 of file TPReplayModule.cpp.

86 {
87 std::vector<const dunedaq::conffwk::DalObject *> vec;
88
89 if (!get(name, vec, upcast_unregistered, true))
90 throw_get_ex(name, s_class_name, this);
91
92 return vec;
93 }
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
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

◆ get() [2/4]

virtual std::vector< const dunedaq::conffwk::DalObject * > dunedaq::appmodel::TPReplayModule::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::DaqModule.

◆ get() [3/4]

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

Definition at line 95 of file TPReplayModule.cpp.

96 {
97 if (first_call)
98 {
99 std::lock_guard scoped_lock(m_mutex);
100
101 check();
102 check_init();
103
104 if (get_rel_objects(name, upcast_unregistered, vec))
105 return true;
106 }
107
108 if (DaqModule::get(name, vec, upcast_unregistered, false)) return true;
109
110 if (first_call)
111 return get_algo_objects(name, vec);
112
113 return false;
114 }
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.

◆ get() [4/4]

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

◆ get_configuration() [1/2]

const dunedaq::appmodel::TPReplayModuleConf * dunedaq::appmodel::TPReplayModule::get_configuration ( ) const
inline

Get "configuration" relationship value.

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

Definition at line 102 of file TPReplayModule.hpp.

103 {
104 std::lock_guard scoped_lock(m_mutex);
105 check();
106 check_init();
107 if (!m_configuration)
108 {
109 std::ostringstream text;
110 text << "relationship \"" << s_configuration << "\" of object " << this << " is not set";
111 throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
112 }
113 return m_configuration;
114 }
#define ERS_HERE
Generic configuration exception.

◆ get_configuration() [2/2]

const dunedaq::appmodel::TPReplayModuleConf * dunedaq::appmodel::TPReplayModule::get_configuration ( ) const
inline

Get "configuration" relationship value.

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

Definition at line 102 of file TPReplayModule.hpp.

103 {
104 std::lock_guard scoped_lock(m_mutex);
105 check();
106 check_init();
107 if (!m_configuration)
108 {
109 std::ostringstream text;
110 text << "relationship \"" << s_configuration << "\" of object " << this << " is not set";
111 throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
112 }
113 return m_configuration;
114 }

◆ init() [1/2]

void dunedaq::appmodel::TPReplayModule::init ( bool init_children)
protectedvirtual

Initialize object (method generated by genconffwk)

Parameters
init_childrenif true, initialize referenced objects

Reimplemented from dunedaq::confmodel::DaqModule.

Definition at line 67 of file TPReplayModule.cpp.

68 {
69 DaqModule::init(init_children);
70
71 TLOG_DEBUG(5) << "read object " << this << " (class " << s_class_name << ')';
72
73 try {
75 }
76 catch (dunedaq::conffwk::Exception & ex) {
77 throw_init_ex(ex);
78 }
79 }
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).
#define TLOG_DEBUG(lvl,...)
Definition Logging.hpp:112

◆ init() [2/2]

virtual void dunedaq::appmodel::TPReplayModule::init ( bool init_children)
protectedvirtual

Initialize object (method generated by genconffwk)

Parameters
init_childrenif true, initialize referenced objects

Reimplemented from dunedaq::confmodel::DaqModule.

◆ print() [1/2]

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

Print details of the TPReplayModule 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::DaqModule.

Definition at line 41 of file TPReplayModule.cpp.

42 {
43 check_init();
44
45 try {
46 const std::string str(indent+2, ' ');
47
48 if (print_header)
49 p_hdr(s, indent, s_class_name, "dunedaq::appmodel");
50
51
52 // print direct super-classes
53
55
56
57 // print direct relationships
58
60 }
61 catch (dunedaq::conffwk::Exception & ex) {
63 }
64 }
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 DaqModule object.
Definition DaqModule.cpp:28
void p_sv_rel(std::ostream &s, const std::string &str, const std::string &name, const DalObject *obj)
print weak single-value relationship

◆ print() [2/2]

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

Print details of the TPReplayModule 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::DaqModule.

◆ set_configuration() [1/2]

void dunedaq::appmodel::TPReplayModule::set_configuration ( const dunedaq::appmodel::TPReplayModuleConf * value)

Set "configuration" relationship value.

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

Definition at line 116 of file TPReplayModule.cpp.

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

◆ set_configuration() [2/2]

void dunedaq::appmodel::TPReplayModule::set_configuration ( const dunedaq::appmodel::TPReplayModuleConf * value)

Set "configuration" relationship value.

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

Friends And Related Symbol Documentation

◆ conffwk::Configuration

Definition at line 34 of file TPReplayModule.hpp.

◆ conffwk::DalFactory

conffwk::DalFactory
friend

Definition at line 36 of file TPReplayModule.hpp.

◆ conffwk::DalObject

Definition at line 35 of file TPReplayModule.hpp.

◆ conffwk::DalRegistry

Definition at line 37 of file TPReplayModule.hpp.

Member Data Documentation

◆ m_configuration

const dunedaq::appmodel::TPReplayModuleConf * dunedaq::appmodel::TPReplayModule::m_configuration
private

Definition at line 83 of file TPReplayModule.hpp.

◆ s_class_name

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

The name of the configuration class.

Definition at line 49 of file TPReplayModule.hpp.

◆ s_configuration

static const std::string dunedaq::appmodel::TPReplayModule::s_configuration = "configuration"
inlinestatic

Definition at line 90 of file TPReplayModule.hpp.


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