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

#include <TCAlgorithm.hpp>

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

Public Member Functions

virtual void print (unsigned int offset, bool print_header, std::ostream &s) const
 Print details of the TCAlgorithm 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.
 
uint32_t get_prescale () const
 Get "prescale" attribute value. Prescale factor to apply to algorithm output.
 
void set_prescale (uint32_t value)
 Set "prescale" attribute value. Prescale factor to apply to algorithm output.
 
const std::string & get_tc_type_name () const
 Get "tc_type_name" attribute value. The output TC type name this algorithm will output.
 
void set_tc_type_name (const std::string &value)
 Set "tc_type_name" attribute value. The output TC type name this algorithm will output.
 
virtual void print (unsigned int offset, bool print_header, std::ostream &s) const
 Print details of the TCAlgorithm 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.
 
uint32_t get_prescale () const
 Get "prescale" attribute value. Prescale factor to apply to algorithm output.
 
void set_prescale (uint32_t value)
 Set "prescale" attribute value. Prescale factor to apply to algorithm output.
 
const std::string & get_tc_type_name () const
 Get "tc_type_name" attribute value. The output TC type name this algorithm will output.
 
void set_tc_type_name (const std::string &value)
 Set "tc_type_name" attribute value. The output TC type name this algorithm will output.
 
- Public Member Functions inherited from dunedaq::confmodel::Jsonable
nlohmann::json to_json (bool direct=false, bool skip_name=false) const
 
nlohmann::json to_json (bool direct=false, bool skip_name=false) 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_prescale_str () noexcept
 
static const std::string & __get_tc_type_name_str () noexcept
 
static const std::string & __get_prescale_str () noexcept
 
static const std::string & __get_tc_type_name_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_prescale = "prescale"
 
static const std::string s_tc_type_name = "tc_type_name"
 
- Static Public Attributes inherited from dunedaq::confmodel::Jsonable
static const std::string & s_class_name
 

Protected Member Functions

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

uint32_t m_prescale
 
std::string m_tc_type_name
 

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

Base class for TC algorithms

Definition at line 27 of file TCAlgorithm.hpp.

Constructor & Destructor Documentation

◆ TCAlgorithm() [1/2]

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

Definition at line 26 of file TCAlgorithm.cpp.

26 :
29
30 {
31 ;
32 }
The base class for any generated DAL object.
Definition DalObject.hpp:45

◆ ~TCAlgorithm() [1/2]

dunedaq::appmodel::TCAlgorithm::~TCAlgorithm ( )
protectedvirtualnoexcept

Definition at line 77 of file TCAlgorithm.cpp.

78 {
79 }

◆ TCAlgorithm() [2/2]

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

◆ ~TCAlgorithm() [2/2]

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

Member Function Documentation

◆ __get_prescale_str() [1/2]

static const std::string & dunedaq::appmodel::TCAlgorithm::__get_prescale_str ( )
inlinestaticnoexcept

Definition at line 89 of file TCAlgorithm.hpp.

89{ return s_prescale; }
static const std::string s_prescale

◆ __get_prescale_str() [2/2]

static const std::string & dunedaq::appmodel::TCAlgorithm::__get_prescale_str ( )
inlinestaticnoexcept

Definition at line 89 of file TCAlgorithm.hpp.

89{ return s_prescale; }

◆ __get_tc_type_name_str() [1/2]

static const std::string & dunedaq::appmodel::TCAlgorithm::__get_tc_type_name_str ( )
inlinestaticnoexcept

Definition at line 90 of file TCAlgorithm.hpp.

90{ return s_tc_type_name; }
static const std::string s_tc_type_name

◆ __get_tc_type_name_str() [2/2]

static const std::string & dunedaq::appmodel::TCAlgorithm::__get_tc_type_name_str ( )
inlinestaticnoexcept

Definition at line 90 of file TCAlgorithm.hpp.

90{ return s_tc_type_name; }

◆ get() [1/4]

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

Reimplemented in dunedaq::appmodel::TCMakerADCSimpleWindowAlgorithm, dunedaq::appmodel::TCMakerADCSimpleWindowAlgorithm, dunedaq::appmodel::TCMakerBundleNAlgorithm, dunedaq::appmodel::TCMakerBundleNAlgorithm, dunedaq::appmodel::TCMakerChannelAdjacencyAlgorithm, dunedaq::appmodel::TCMakerChannelAdjacencyAlgorithm, dunedaq::appmodel::TCMakerChannelDistanceAlgorithm, dunedaq::appmodel::TCMakerChannelDistanceAlgorithm, dunedaq::appmodel::TCMakerDBSCANAlgorithm, dunedaq::appmodel::TCMakerDBSCANAlgorithm, dunedaq::appmodel::TCMakerHorizontalMuonAlgorithm, dunedaq::appmodel::TCMakerHorizontalMuonAlgorithm, dunedaq::appmodel::TCMakerMichelElectronAlgorithm, dunedaq::appmodel::TCMakerMichelElectronAlgorithm, dunedaq::appmodel::TCMakerPlaneCoincidenceAlgorithm, dunedaq::appmodel::TCMakerPlaneCoincidenceAlgorithm, dunedaq::appmodel::TCMakerPrescaleAlgorithm, and dunedaq::appmodel::TCMakerPrescaleAlgorithm.

Definition at line 81 of file TCAlgorithm.cpp.

82 {
83 std::vector<const dunedaq::conffwk::DalObject *> vec;
84
85 if (!get(name, vec, upcast_unregistered, true))
86 throw_get_ex(name, s_class_name, this);
87
88 return vec;
89 }
static const std::string & s_class_name
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 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]

◆ get() [3/4]

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

Definition at line 91 of file TCAlgorithm.cpp.

92 {
93 if (first_call)
94 {
95 std::lock_guard scoped_lock(m_mutex);
96
97 check();
98 check_init();
99
100 if (get_rel_objects(name, upcast_unregistered, vec))
101 return true;
102 }
103
104 if (Jsonable::get(name, vec, upcast_unregistered, false)) return true;
105
106 if (first_call)
107 return get_algo_objects(name, vec);
108
109 return false;
110 }
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::TCAlgorithm::get ( const std::string & name,
std::vector< const dunedaq::conffwk::DalObject * > & vec,
bool upcast_unregistered,
bool first_call ) const
protected

◆ get_prescale() [1/2]

uint32_t dunedaq::appmodel::TCAlgorithm::get_prescale ( ) const
inline

Get "prescale" attribute value. Prescale factor to apply to algorithm output.

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

Definition at line 101 of file TCAlgorithm.hpp.

102 {
103 std::lock_guard scoped_lock(m_mutex);
104 check();
105 check_init();
106 return m_prescale;
107 }

◆ get_prescale() [2/2]

uint32_t dunedaq::appmodel::TCAlgorithm::get_prescale ( ) const
inline

Get "prescale" attribute value. Prescale factor to apply to algorithm output.

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

Definition at line 101 of file TCAlgorithm.hpp.

102 {
103 std::lock_guard scoped_lock(m_mutex);
104 check();
105 check_init();
106 return m_prescale;
107 }

◆ get_tc_type_name() [1/2]

const std::string & dunedaq::appmodel::TCAlgorithm::get_tc_type_name ( ) const
inline

Get "tc_type_name" attribute value. The output TC type name this algorithm will output.

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

Definition at line 134 of file TCAlgorithm.hpp.

135 {
136 std::lock_guard scoped_lock(m_mutex);
137 check();
138 check_init();
139 return m_tc_type_name;
140 }

◆ get_tc_type_name() [2/2]

const std::string & dunedaq::appmodel::TCAlgorithm::get_tc_type_name ( ) const
inline

Get "tc_type_name" attribute value. The output TC type name this algorithm will output.

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

Definition at line 134 of file TCAlgorithm.hpp.

135 {
136 std::lock_guard scoped_lock(m_mutex);
137 check();
138 check_init();
139 return m_tc_type_name;
140 }

◆ init() [1/2]

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

Initialize object (method generated by genconffwk)

Parameters
init_childrenif true, initialize referenced objects

Reimplemented from dunedaq::confmodel::Jsonable.

Reimplemented in dunedaq::appmodel::TCMakerADCSimpleWindowAlgorithm, dunedaq::appmodel::TCMakerADCSimpleWindowAlgorithm, dunedaq::appmodel::TCMakerBundleNAlgorithm, dunedaq::appmodel::TCMakerBundleNAlgorithm, dunedaq::appmodel::TCMakerChannelAdjacencyAlgorithm, dunedaq::appmodel::TCMakerChannelAdjacencyAlgorithm, dunedaq::appmodel::TCMakerChannelDistanceAlgorithm, dunedaq::appmodel::TCMakerChannelDistanceAlgorithm, dunedaq::appmodel::TCMakerDBSCANAlgorithm, dunedaq::appmodel::TCMakerDBSCANAlgorithm, dunedaq::appmodel::TCMakerHorizontalMuonAlgorithm, dunedaq::appmodel::TCMakerHorizontalMuonAlgorithm, dunedaq::appmodel::TCMakerMichelElectronAlgorithm, dunedaq::appmodel::TCMakerMichelElectronAlgorithm, dunedaq::appmodel::TCMakerPlaneCoincidenceAlgorithm, dunedaq::appmodel::TCMakerPlaneCoincidenceAlgorithm, dunedaq::appmodel::TCMakerPrescaleAlgorithm, and dunedaq::appmodel::TCMakerPrescaleAlgorithm.

Definition at line 62 of file TCAlgorithm.cpp.

63 {
64 Jsonable::init(init_children);
65
66 TLOG_DEBUG(5) << "read object " << this << " (class " << s_class_name << ')';
67
68 try {
71 }
72 catch (dunedaq::conffwk::Exception & ex) {
73 throw_init_ex(ex);
74 }
75 }
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
ConfigObject p_obj
Config object used by given template object.
#define TLOG_DEBUG(lvl,...)
Definition Logging.hpp:112

◆ init() [2/2]

◆ print() [1/2]

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

Print details of the TCAlgorithm 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::Jsonable.

Reimplemented in dunedaq::appmodel::TCMakerADCSimpleWindowAlgorithm, dunedaq::appmodel::TCMakerADCSimpleWindowAlgorithm, dunedaq::appmodel::TCMakerBundleNAlgorithm, dunedaq::appmodel::TCMakerBundleNAlgorithm, dunedaq::appmodel::TCMakerChannelAdjacencyAlgorithm, dunedaq::appmodel::TCMakerChannelAdjacencyAlgorithm, dunedaq::appmodel::TCMakerChannelDistanceAlgorithm, dunedaq::appmodel::TCMakerChannelDistanceAlgorithm, dunedaq::appmodel::TCMakerDBSCANAlgorithm, dunedaq::appmodel::TCMakerDBSCANAlgorithm, dunedaq::appmodel::TCMakerHorizontalMuonAlgorithm, dunedaq::appmodel::TCMakerHorizontalMuonAlgorithm, dunedaq::appmodel::TCMakerMichelElectronAlgorithm, dunedaq::appmodel::TCMakerMichelElectronAlgorithm, dunedaq::appmodel::TCMakerPlaneCoincidenceAlgorithm, dunedaq::appmodel::TCMakerPlaneCoincidenceAlgorithm, dunedaq::appmodel::TCMakerPrescaleAlgorithm, and dunedaq::appmodel::TCMakerPrescaleAlgorithm.

Definition at line 35 of file TCAlgorithm.cpp.

36 {
37 check_init();
38
39 try {
40 const std::string str(indent+2, ' ');
41
42 if (print_header)
43 p_hdr(s, indent, s_class_name, "dunedaq::appmodel");
44
45
46 // print direct super-classes
47
49
50
51 // print direct attributes
52
55 }
56 catch (dunedaq::conffwk::Exception & ex) {
58 }
59 }
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 Jsonable object.
Definition Jsonable.cpp:22
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]

◆ set_prescale() [1/2]

void dunedaq::appmodel::TCAlgorithm::set_prescale ( uint32_t value)
inline

Set "prescale" attribute value. Prescale factor to apply to algorithm output.

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

Definition at line 117 of file TCAlgorithm.hpp.

118 {
119 std::lock_guard scoped_lock(m_mutex);
120 check();
121 clear();
123 }
void set_by_val(const std::string &name, T value)
Set attribute value.

◆ set_prescale() [2/2]

void dunedaq::appmodel::TCAlgorithm::set_prescale ( uint32_t value)
inline

Set "prescale" attribute value. Prescale factor to apply to algorithm output.

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

Definition at line 117 of file TCAlgorithm.hpp.

118 {
119 std::lock_guard scoped_lock(m_mutex);
120 check();
121 clear();
123 }

◆ set_tc_type_name() [1/2]

void dunedaq::appmodel::TCAlgorithm::set_tc_type_name ( const std::string & value)
inline

Set "tc_type_name" attribute value. The output TC type name this algorithm will output.

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

Definition at line 150 of file TCAlgorithm.hpp.

151 {
152 std::lock_guard scoped_lock(m_mutex);
153 check();
154 clear();
156 }
void set_by_ref(const std::string &name, T &value)
Set attribute value.

◆ set_tc_type_name() [2/2]

void dunedaq::appmodel::TCAlgorithm::set_tc_type_name ( const std::string & value)
inline

Set "tc_type_name" attribute value. The output TC type name this algorithm will output.

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

Definition at line 150 of file TCAlgorithm.hpp.

151 {
152 std::lock_guard scoped_lock(m_mutex);
153 check();
154 clear();
156 }

Friends And Related Symbol Documentation

◆ conffwk::Configuration

Definition at line 29 of file TCAlgorithm.hpp.

◆ conffwk::DalFactory

conffwk::DalFactory
friend

Definition at line 31 of file TCAlgorithm.hpp.

◆ conffwk::DalObject

Definition at line 30 of file TCAlgorithm.hpp.

◆ conffwk::DalRegistry

Definition at line 32 of file TCAlgorithm.hpp.

Member Data Documentation

◆ m_prescale

uint32_t dunedaq::appmodel::TCAlgorithm::m_prescale
private

Definition at line 78 of file TCAlgorithm.hpp.

◆ m_tc_type_name

std::string dunedaq::appmodel::TCAlgorithm::m_tc_type_name
private

Definition at line 79 of file TCAlgorithm.hpp.

◆ s_class_name

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

The name of the configuration class.

Definition at line 44 of file TCAlgorithm.hpp.

◆ s_prescale

static const std::string dunedaq::appmodel::TCAlgorithm::s_prescale = "prescale"
inlinestatic

Definition at line 86 of file TCAlgorithm.hpp.

◆ s_tc_type_name

static const std::string dunedaq::appmodel::TCAlgorithm::s_tc_type_name = "tc_type_name"
inlinestatic

Definition at line 87 of file TCAlgorithm.hpp.


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