|
DUNE-DAQ
DUNE Trigger and Data Acquisition software
|
#include <ProcessingStep.hpp>
Public Member Functions | |
| virtual void | print (unsigned int offset, bool print_header, std::ostream &s) const |
| Print details of the ProcessingStep 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. | |
| uint64_t | get_metric_collect_time_sample_period () const |
| Get "metric_collect_time_sample_period" attribute value. If metric_collect_toggle_state is true, the processor will store values of its monitored quantities every metric_collect_time_sample_period time samples. | |
| void | set_metric_collect_time_sample_period (uint64_t value) |
| Set "metric_collect_time_sample_period" attribute value. If metric_collect_toggle_state is true, the processor will store values of its monitored quantities every metric_collect_time_sample_period time samples. | |
| bool | get_metric_collect_toggle_state () const |
| Get "metric_collect_toggle_state" attribute value. Whether metric storaging function is enabled. | |
| void | set_metric_collect_toggle_state (bool value) |
| Set "metric_collect_toggle_state" attribute value. Whether metric storaging function is enabled. | |
| virtual void | print (unsigned int offset, bool print_header, std::ostream &s) const |
| Print details of the ProcessingStep 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. | |
| uint64_t | get_metric_collect_time_sample_period () const |
| Get "metric_collect_time_sample_period" attribute value. If metric_collect_toggle_state is true, the processor will store values of its monitored quantities every metric_collect_time_sample_period time samples. | |
| void | set_metric_collect_time_sample_period (uint64_t value) |
| Set "metric_collect_time_sample_period" attribute value. If metric_collect_toggle_state is true, the processor will store values of its monitored quantities every metric_collect_time_sample_period time samples. | |
| bool | get_metric_collect_toggle_state () const |
| Get "metric_collect_toggle_state" attribute value. Whether metric storaging function is enabled. | |
| void | set_metric_collect_toggle_state (bool value) |
| Set "metric_collect_toggle_state" attribute value. Whether metric storaging function is enabled. | |
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 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_metric_collect_time_sample_period_str () noexcept |
| static const std::string & | __get_metric_collect_toggle_state_str () noexcept |
| static const std::string & | __get_metric_collect_time_sample_period_str () noexcept |
| static const std::string & | __get_metric_collect_toggle_state_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_metric_collect_time_sample_period = "metric_collect_time_sample_period" |
| static const std::string | s_metric_collect_toggle_state = "metric_collect_toggle_state" |
Static Public Attributes inherited from dunedaq::confmodel::Jsonable | |
| static const std::string & | s_class_name |
Protected Member Functions | |
| ProcessingStep (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept | |
| virtual | ~ProcessingStep () 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 |
| ProcessingStep (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept | |
| virtual | ~ProcessingStep () 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 | |
| uint64_t | m_metric_collect_time_sample_period |
| bool | m_metric_collect_toggle_state |
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) | |
Base class for TPG processors.
Definition at line 27 of file ProcessingStep.hpp.
|
protectednoexcept |
Definition at line 26 of file ProcessingStep.cpp.
|
protectedvirtualnoexcept |
Definition at line 77 of file ProcessingStep.cpp.
|
protectednoexcept |
|
protectedvirtualnoexcept |
|
inlinestaticnoexcept |
Definition at line 89 of file ProcessingStep.hpp.
|
inlinestaticnoexcept |
Definition at line 89 of file ProcessingStep.hpp.
|
inlinestaticnoexcept |
Definition at line 90 of file ProcessingStep.hpp.
|
inlinestaticnoexcept |
Definition at line 90 of file ProcessingStep.hpp.
|
virtual |
Get values of relationships and results of some algorithms as a vector of dunedaq::conffwk::DalObject pointers.
Parameters are:
| name | name of the relationship or algorithm |
| std::exception | if there is no relationship or algorithm with such name in this and base classes |
Reimplemented from dunedaq::confmodel::Jsonable.
Reimplemented in dunedaq::appmodel::AVXAbsRunSumProcessor, dunedaq::appmodel::AVXAbsRunSumProcessor, dunedaq::appmodel::AVXFixedPedestalSubtractProcessor, dunedaq::appmodel::AVXFixedPedestalSubtractProcessor, dunedaq::appmodel::AVXFrugalPedestalSubtractProcessor, dunedaq::appmodel::AVXFrugalPedestalSubtractProcessor, dunedaq::appmodel::AVXRunSumProcessor, dunedaq::appmodel::AVXRunSumProcessor, dunedaq::appmodel::AVXThresholdProcessor, and dunedaq::appmodel::AVXThresholdProcessor.
Definition at line 81 of file ProcessingStep.cpp.
|
virtual |
Get values of relationships and results of some algorithms as a vector of dunedaq::conffwk::DalObject pointers.
Parameters are:
| name | name of the relationship or algorithm |
| std::exception | if there is no relationship or algorithm with such name in this and base classes |
Reimplemented from dunedaq::confmodel::Jsonable.
Reimplemented in dunedaq::appmodel::AVXAbsRunSumProcessor, dunedaq::appmodel::AVXAbsRunSumProcessor, dunedaq::appmodel::AVXFixedPedestalSubtractProcessor, dunedaq::appmodel::AVXFixedPedestalSubtractProcessor, dunedaq::appmodel::AVXFrugalPedestalSubtractProcessor, dunedaq::appmodel::AVXFrugalPedestalSubtractProcessor, dunedaq::appmodel::AVXRunSumProcessor, dunedaq::appmodel::AVXRunSumProcessor, dunedaq::appmodel::AVXThresholdProcessor, and dunedaq::appmodel::AVXThresholdProcessor.
|
protected |
Definition at line 91 of file ProcessingStep.cpp.
|
protected |
|
inline |
Get "metric_collect_time_sample_period" attribute value. If metric_collect_toggle_state is true, the processor will store values of its monitored quantities every metric_collect_time_sample_period time samples.
Definition at line 101 of file ProcessingStep.hpp.
|
inline |
Get "metric_collect_time_sample_period" attribute value. If metric_collect_toggle_state is true, the processor will store values of its monitored quantities every metric_collect_time_sample_period time samples.
Definition at line 101 of file ProcessingStep.hpp.
|
inline |
Get "metric_collect_toggle_state" attribute value. Whether metric storaging function is enabled.
Definition at line 134 of file ProcessingStep.hpp.
|
inline |
Get "metric_collect_toggle_state" attribute value. Whether metric storaging function is enabled.
Definition at line 134 of file ProcessingStep.hpp.
|
protectedvirtual |
Initialize object (method generated by genconffwk)
| init_children | if true, initialize referenced objects |
Reimplemented from dunedaq::confmodel::Jsonable.
Reimplemented in dunedaq::appmodel::AVXAbsRunSumProcessor, dunedaq::appmodel::AVXAbsRunSumProcessor, dunedaq::appmodel::AVXFixedPedestalSubtractProcessor, dunedaq::appmodel::AVXFixedPedestalSubtractProcessor, dunedaq::appmodel::AVXFrugalPedestalSubtractProcessor, dunedaq::appmodel::AVXFrugalPedestalSubtractProcessor, dunedaq::appmodel::AVXRunSumProcessor, dunedaq::appmodel::AVXRunSumProcessor, dunedaq::appmodel::AVXThresholdProcessor, and dunedaq::appmodel::AVXThresholdProcessor.
Definition at line 62 of file ProcessingStep.cpp.
|
protectedvirtual |
Initialize object (method generated by genconffwk)
| init_children | if true, initialize referenced objects |
Reimplemented from dunedaq::confmodel::Jsonable.
Reimplemented in dunedaq::appmodel::AVXAbsRunSumProcessor, dunedaq::appmodel::AVXAbsRunSumProcessor, dunedaq::appmodel::AVXFixedPedestalSubtractProcessor, dunedaq::appmodel::AVXFixedPedestalSubtractProcessor, dunedaq::appmodel::AVXFrugalPedestalSubtractProcessor, dunedaq::appmodel::AVXFrugalPedestalSubtractProcessor, dunedaq::appmodel::AVXRunSumProcessor, dunedaq::appmodel::AVXRunSumProcessor, dunedaq::appmodel::AVXThresholdProcessor, and dunedaq::appmodel::AVXThresholdProcessor.
|
virtual |
Print details of the ProcessingStep object.
Parameters are:
| 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 |
Reimplemented from dunedaq::confmodel::Jsonable.
Reimplemented in dunedaq::appmodel::AVXAbsRunSumProcessor, dunedaq::appmodel::AVXAbsRunSumProcessor, dunedaq::appmodel::AVXFixedPedestalSubtractProcessor, dunedaq::appmodel::AVXFixedPedestalSubtractProcessor, dunedaq::appmodel::AVXFrugalPedestalSubtractProcessor, dunedaq::appmodel::AVXFrugalPedestalSubtractProcessor, dunedaq::appmodel::AVXRunSumProcessor, dunedaq::appmodel::AVXRunSumProcessor, dunedaq::appmodel::AVXThresholdProcessor, and dunedaq::appmodel::AVXThresholdProcessor.
Definition at line 35 of file ProcessingStep.cpp.
|
virtual |
Print details of the ProcessingStep object.
Parameters are:
| 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 |
Reimplemented from dunedaq::confmodel::Jsonable.
Reimplemented in dunedaq::appmodel::AVXAbsRunSumProcessor, dunedaq::appmodel::AVXAbsRunSumProcessor, dunedaq::appmodel::AVXFixedPedestalSubtractProcessor, dunedaq::appmodel::AVXFixedPedestalSubtractProcessor, dunedaq::appmodel::AVXFrugalPedestalSubtractProcessor, dunedaq::appmodel::AVXFrugalPedestalSubtractProcessor, dunedaq::appmodel::AVXRunSumProcessor, dunedaq::appmodel::AVXRunSumProcessor, dunedaq::appmodel::AVXThresholdProcessor, and dunedaq::appmodel::AVXThresholdProcessor.
|
inline |
Set "metric_collect_time_sample_period" attribute value. If metric_collect_toggle_state is true, the processor will store values of its monitored quantities every metric_collect_time_sample_period time samples.
| value | new attribute value |
Definition at line 117 of file ProcessingStep.hpp.
|
inline |
Set "metric_collect_time_sample_period" attribute value. If metric_collect_toggle_state is true, the processor will store values of its monitored quantities every metric_collect_time_sample_period time samples.
| value | new attribute value |
Definition at line 117 of file ProcessingStep.hpp.
|
inline |
Set "metric_collect_toggle_state" attribute value. Whether metric storaging function is enabled.
| value | new attribute value |
Definition at line 150 of file ProcessingStep.hpp.
|
inline |
Set "metric_collect_toggle_state" attribute value. Whether metric storaging function is enabled.
| value | new attribute value |
Definition at line 150 of file ProcessingStep.hpp.
|
friend |
Definition at line 29 of file ProcessingStep.hpp.
|
friend |
Definition at line 31 of file ProcessingStep.hpp.
|
friend |
Definition at line 30 of file ProcessingStep.hpp.
|
friend |
Definition at line 32 of file ProcessingStep.hpp.
|
private |
Definition at line 78 of file ProcessingStep.hpp.
|
private |
Definition at line 79 of file ProcessingStep.hpp.
|
static |
The name of the configuration class.
Definition at line 44 of file ProcessingStep.hpp.
|
inlinestatic |
Definition at line 86 of file ProcessingStep.hpp.
|
inlinestatic |
Definition at line 87 of file ProcessingStep.hpp.