dunedaq::appmodel::TPCRawDataProcessor Class Reference

#include <TPCRawDataProcessor.hpp>

Inheritance diagram for dunedaq::appmodel::TPCRawDataProcessor:

Collaboration diagram for dunedaq::appmodel::TPCRawDataProcessor:

Public Member Functions
virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the TPCRawDataProcessor 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_frame_count_limit () const
	Get "frame_count_limit" attribute value. When this number of frames is reached the TPs are sent to the sink. SELECT 0 if you want this condition not to be used. In this case, sending TPs will only rely on the number of TP.
void	set_frame_count_limit (uint32_t value)
	Set "frame_count_limit" attribute value. When this number of frames is reached the TPs are sent to the sink. SELECT 0 if you want this condition not to be used. In this case, sending TPs will only rely on the number of TP.
uint32_t	get_tp_count_limit () const
	Get "tp_count_limit" attribute value. When this number of TPs is reached, the TPs are sent to the sink. SELECT 0 if you want this condition not to be used. In this case, sending TPs will only rely on the number of frames.
void	set_tp_count_limit (uint32_t value)
	Set "tp_count_limit" attribute value. When this number of TPs is reached, the TPs are sent to the sink. SELECT 0 if you want this condition not to be used. In this case, sending TPs will only rely on the number of frames.
uint32_t	get_metric_collect_opmon_rate () const
	Get "metric_collect_opmon_rate" attribute value. The rate at which processor metric is polled from processors for monitoring.
void	set_metric_collect_opmon_rate (uint32_t value)
	Set "metric_collect_opmon_rate" attribute value. The rate at which processor metric is polled from processors for monitoring.
const std::vector< const dunedaq::appmodel::ProcessingStep * > &	get_processing_steps () const
	Get "processing_steps" relationship value.
void	set_processing_steps (const std::vector< const dunedaq::appmodel::ProcessingStep * > &value)
	Set "processing_steps" relationship value.
const dunedaq::appmodel::SamplesOverThresholdMinima *	get_sot_minima () const
	Get "sot_minima" relationship value. TP samples over threshold minimum requirement by plane.
void	set_sot_minima (const dunedaq::appmodel::SamplesOverThresholdMinima *value)
	Set "sot_minima" relationship value. TP samples over threshold minimum requirement by plane.
virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the TPCRawDataProcessor 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_frame_count_limit () const
	Get "frame_count_limit" attribute value. When this number of frames is reached the TPs are sent to the sink. SELECT 0 if you want this condition not to be used. In this case, sending TPs will only rely on the number of TP.
void	set_frame_count_limit (uint32_t value)
	Set "frame_count_limit" attribute value. When this number of frames is reached the TPs are sent to the sink. SELECT 0 if you want this condition not to be used. In this case, sending TPs will only rely on the number of TP.
uint32_t	get_tp_count_limit () const
	Get "tp_count_limit" attribute value. When this number of TPs is reached, the TPs are sent to the sink. SELECT 0 if you want this condition not to be used. In this case, sending TPs will only rely on the number of frames.
void	set_tp_count_limit (uint32_t value)
	Set "tp_count_limit" attribute value. When this number of TPs is reached, the TPs are sent to the sink. SELECT 0 if you want this condition not to be used. In this case, sending TPs will only rely on the number of frames.
uint32_t	get_metric_collect_opmon_rate () const
	Get "metric_collect_opmon_rate" attribute value. The rate at which processor metric is polled from processors for monitoring.
void	set_metric_collect_opmon_rate (uint32_t value)
	Set "metric_collect_opmon_rate" attribute value. The rate at which processor metric is polled from processors for monitoring.
const std::vector< const dunedaq::appmodel::ProcessingStep * > &	get_processing_steps () const
	Get "processing_steps" relationship value.
void	set_processing_steps (const std::vector< const dunedaq::appmodel::ProcessingStep * > &value)
	Set "processing_steps" relationship value.
const dunedaq::appmodel::SamplesOverThresholdMinima *	get_sot_minima () const
	Get "sot_minima" relationship value. TP samples over threshold minimum requirement by plane.
void	set_sot_minima (const dunedaq::appmodel::SamplesOverThresholdMinima *value)
	Set "sot_minima" relationship value. TP samples over threshold minimum requirement by plane.
Public Member Functions inherited from dunedaq::appmodel::RawDataProcessor
const std::vector< uint32_t > &	get_channel_mask () const
	Get "channel_mask" attribute value. List of channels to be masked from TP generation.
void	set_channel_mask (const std::vector< uint32_t > &value)
	Set "channel_mask" attribute value. List of channels to be masked from TP generation.
const std::string &	get_channel_map () const
	Get "channel_map" attribute value.
void	set_channel_map (const std::string &value)
	Set "channel_map" attribute value.
const std::vector< uint32_t > &	get_channel_mask () const
	Get "channel_mask" attribute value. List of channels to be masked from TP generation.
void	set_channel_mask (const std::vector< uint32_t > &value)
	Set "channel_mask" attribute value. List of channels to be masked from TP generation.
const std::string &	get_channel_map () const
	Get "channel_map" attribute value.
void	set_channel_map (const std::string &value)
	Set "channel_map" attribute value.
Public Member Functions inherited from dunedaq::appmodel::DataProcessor
uint32_t	get_queue_sizes () const
	Get "queue_sizes" attribute value.
void	set_queue_sizes (uint32_t value)
	Set "queue_sizes" attribute value.
const std::string &	get_thread_names_prefix () const
	Get "thread_names_prefix" attribute value.
void	set_thread_names_prefix (const std::string &value)
	Set "thread_names_prefix" attribute value.
bool	get_latency_monitoring () const
	Get "latency_monitoring" attribute value.
void	set_latency_monitoring (bool value)
	Set "latency_monitoring" attribute value.
uint32_t	get_queue_sizes () const
	Get "queue_sizes" attribute value.
void	set_queue_sizes (uint32_t value)
	Set "queue_sizes" attribute value.
const std::string &	get_thread_names_prefix () const
	Get "thread_names_prefix" attribute value.
void	set_thread_names_prefix (const std::string &value)
	Set "thread_names_prefix" attribute value.
bool	get_latency_monitoring () const
	Get "latency_monitoring" attribute value.
void	set_latency_monitoring (bool value)
	Set "latency_monitoring" attribute 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 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_frame_count_limit_str () noexcept
static const std::string &	__get_tp_count_limit_str () noexcept
static const std::string &	__get_metric_collect_opmon_rate_str () noexcept
static const std::string &	__get_processing_steps_str () noexcept
static const std::string &	__get_sot_minima_str () noexcept
static const std::string &	__get_frame_count_limit_str () noexcept
static const std::string &	__get_tp_count_limit_str () noexcept
static const std::string &	__get_metric_collect_opmon_rate_str () noexcept
static const std::string &	__get_processing_steps_str () noexcept
static const std::string &	__get_sot_minima_str () noexcept
Static Public Member Functions inherited from dunedaq::appmodel::RawDataProcessor
static const std::string &	__get_channel_mask_str () noexcept
static const std::string &	__get_channel_map_str () noexcept
static const std::string &	__get_channel_mask_str () noexcept
static const std::string &	__get_channel_map_str () noexcept
Static Public Member Functions inherited from dunedaq::appmodel::DataProcessor
static const std::string &	__get_queue_sizes_str () noexcept
static const std::string &	__get_thread_names_prefix_str () noexcept
static const std::string &	__get_latency_monitoring_str () noexcept
static const std::string &	__get_queue_sizes_str () noexcept
static const std::string &	__get_thread_names_prefix_str () noexcept
static const std::string &	__get_latency_monitoring_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_frame_count_limit = "frame_count_limit"
static const std::string	s_tp_count_limit = "tp_count_limit"
static const std::string	s_metric_collect_opmon_rate = "metric_collect_opmon_rate"
static const std::string	s_processing_steps = "processing_steps"
static const std::string	s_sot_minima = "sot_minima"
Static Public Attributes inherited from dunedaq::appmodel::RawDataProcessor
static const std::string &	s_class_name
static const std::string	s_channel_mask = "channel_mask"
static const std::string	s_channel_map = "channel_map"
Static Public Attributes inherited from dunedaq::appmodel::DataProcessor
static const std::string &	s_class_name
static const std::string	s_queue_sizes = "queue_sizes"
static const std::string	s_thread_names_prefix = "thread_names_prefix"
static const std::string	s_latency_monitoring = "latency_monitoring"

Protected Member Functions
	TPCRawDataProcessor (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~TPCRawDataProcessor () 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
	TPCRawDataProcessor (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~TPCRawDataProcessor () 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::appmodel::RawDataProcessor
	RawDataProcessor (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~RawDataProcessor () noexcept
bool	get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const
	RawDataProcessor (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~RawDataProcessor () 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::appmodel::DataProcessor
	DataProcessor (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~DataProcessor () noexcept
bool	get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const
	DataProcessor (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~DataProcessor () 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_frame_count_limit
uint32_t	m_tp_count_limit
uint32_t	m_metric_collect_opmon_rate
std::vector< const dunedaq::appmodel::ProcessingStep * >	m_processing_steps
const dunedaq::appmodel::SamplesOverThresholdMinima *	m_sot_minima

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

Definition at line 33 of file TPCRawDataProcessor.hpp.

Constructor & Destructor Documentation

TPCRawDataProcessor() [1/2]

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

protectednoexcept

Definition at line 32 of file TPCRawDataProcessor.cpp.

                                                                                                          :
      dunedaq::conffwk::DalObject(db, o),
      RawDataProcessor(db, o),
      m_sot_minima (nullptr)
 
    {
      ;
    }

~TPCRawDataProcessor() [1/2]

dunedaq::appmodel::TPCRawDataProcessor::~TPCRawDataProcessor ( )

protectedvirtualnoexcept

Definition at line 94 of file TPCRawDataProcessor.cpp.

    {
    }

TPCRawDataProcessor() [2/2]

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

protectednoexcept

~TPCRawDataProcessor() [2/2]

virtual dunedaq::appmodel::TPCRawDataProcessor::~TPCRawDataProcessor ( )

protectedvirtualnoexcept

Member Function Documentation

__get_frame_count_limit_str() [1/2]

static const std::string & dunedaq::appmodel::TPCRawDataProcessor::__get_frame_count_limit_str ( )

inlinestaticnoexcept

Definition at line 99 of file TPCRawDataProcessor.hpp.

{ return s_frame_count_limit; }

__get_frame_count_limit_str() [2/2]

static const std::string & dunedaq::appmodel::TPCRawDataProcessor::__get_frame_count_limit_str ( )

inlinestaticnoexcept

Definition at line 99 of file TPCRawDataProcessor.hpp.

{ return s_frame_count_limit; }

__get_metric_collect_opmon_rate_str() [1/2]

static const std::string & dunedaq::appmodel::TPCRawDataProcessor::__get_metric_collect_opmon_rate_str ( )

inlinestaticnoexcept

Definition at line 101 of file TPCRawDataProcessor.hpp.

{ return s_metric_collect_opmon_rate; }

__get_metric_collect_opmon_rate_str() [2/2]

static const std::string & dunedaq::appmodel::TPCRawDataProcessor::__get_metric_collect_opmon_rate_str ( )

inlinestaticnoexcept

Definition at line 101 of file TPCRawDataProcessor.hpp.

{ return s_metric_collect_opmon_rate; }

__get_processing_steps_str() [1/2]

static const std::string & dunedaq::appmodel::TPCRawDataProcessor::__get_processing_steps_str ( )

inlinestaticnoexcept

Definition at line 208 of file TPCRawDataProcessor.hpp.

{ return s_processing_steps; }

__get_processing_steps_str() [2/2]

static const std::string & dunedaq::appmodel::TPCRawDataProcessor::__get_processing_steps_str ( )

inlinestaticnoexcept

Definition at line 208 of file TPCRawDataProcessor.hpp.

{ return s_processing_steps; }

__get_sot_minima_str() [1/2]

static const std::string & dunedaq::appmodel::TPCRawDataProcessor::__get_sot_minima_str ( )

inlinestaticnoexcept

Definition at line 209 of file TPCRawDataProcessor.hpp.

{ return s_sot_minima; }

__get_sot_minima_str() [2/2]

static const std::string & dunedaq::appmodel::TPCRawDataProcessor::__get_sot_minima_str ( )

inlinestaticnoexcept

Definition at line 209 of file TPCRawDataProcessor.hpp.

{ return s_sot_minima; }

__get_tp_count_limit_str() [1/2]

static const std::string & dunedaq::appmodel::TPCRawDataProcessor::__get_tp_count_limit_str ( )

inlinestaticnoexcept

Definition at line 100 of file TPCRawDataProcessor.hpp.

{ return s_tp_count_limit; }

__get_tp_count_limit_str() [2/2]

static const std::string & dunedaq::appmodel::TPCRawDataProcessor::__get_tp_count_limit_str ( )

inlinestaticnoexcept

Definition at line 100 of file TPCRawDataProcessor.hpp.

{ return s_tp_count_limit; }

get() [1/4]

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

Reimplemented from dunedaq::appmodel::RawDataProcessor.

Definition at line 98 of file TPCRawDataProcessor.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::appmodel::TPCRawDataProcessor::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

Reimplemented from dunedaq::appmodel::RawDataProcessor.

get() [3/4]

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

protected

Definition at line 108 of file TPCRawDataProcessor.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 (RawDataProcessor::get(name, vec, upcast_unregistered, false)) return true;
 
      if (first_call)
        return get_algo_objects(name, vec);
 
      return false;
    }

get() [4/4]

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

protected

get_frame_count_limit() [1/2]

uint32_t dunedaq::appmodel::TPCRawDataProcessor::get_frame_count_limit ( ) const

inline

Get "frame_count_limit" attribute value. When this number of frames is reached the TPs are sent to the sink. SELECT 0 if you want this condition not to be used. In this case, sending TPs will only rely on the number of TP.

Returns

the attribute value

Exceptions

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

Definition at line 112 of file TPCRawDataProcessor.hpp.

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

get_frame_count_limit() [2/2]

uint32_t dunedaq::appmodel::TPCRawDataProcessor::get_frame_count_limit ( ) const

inline

Get "frame_count_limit" attribute value. When this number of frames is reached the TPs are sent to the sink. SELECT 0 if you want this condition not to be used. In this case, sending TPs will only rely on the number of TP.

Returns

the attribute value

Exceptions

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

Definition at line 112 of file TPCRawDataProcessor.hpp.

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

get_metric_collect_opmon_rate() [1/2]

uint32_t dunedaq::appmodel::TPCRawDataProcessor::get_metric_collect_opmon_rate ( ) const

inline

Get "metric_collect_opmon_rate" attribute value. The rate at which processor metric is polled from processors for monitoring.

Returns

the attribute value

Exceptions

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

Definition at line 178 of file TPCRawDataProcessor.hpp.

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

get_metric_collect_opmon_rate() [2/2]

uint32_t dunedaq::appmodel::TPCRawDataProcessor::get_metric_collect_opmon_rate ( ) const

inline

Get "metric_collect_opmon_rate" attribute value. The rate at which processor metric is polled from processors for monitoring.

Returns

the attribute value

Exceptions

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

Definition at line 178 of file TPCRawDataProcessor.hpp.

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

get_processing_steps() [1/2]

const std::vector< const dunedaq::appmodel::ProcessingStep * > & dunedaq::appmodel::TPCRawDataProcessor::get_processing_steps ( ) const

inline

Get "processing_steps" relationship value.

Returns

the relationship value

Exceptions

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

Definition at line 219 of file TPCRawDataProcessor.hpp.

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

get_processing_steps() [2/2]

const std::vector< const dunedaq::appmodel::ProcessingStep * > & dunedaq::appmodel::TPCRawDataProcessor::get_processing_steps ( ) const

inline

Get "processing_steps" relationship value.

Returns

the relationship value

Exceptions

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

Definition at line 219 of file TPCRawDataProcessor.hpp.

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

get_sot_minima() [1/2]

const dunedaq::appmodel::SamplesOverThresholdMinima * dunedaq::appmodel::TPCRawDataProcessor::get_sot_minima ( ) const

inline

Get "sot_minima" relationship value. TP samples over threshold minimum requirement by plane.

Returns

the relationship value

Exceptions

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

Definition at line 251 of file TPCRawDataProcessor.hpp.

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

get_sot_minima() [2/2]

const dunedaq::appmodel::SamplesOverThresholdMinima * dunedaq::appmodel::TPCRawDataProcessor::get_sot_minima ( ) const

inline

Get "sot_minima" relationship value. TP samples over threshold minimum requirement by plane.

Returns

the relationship value

Exceptions

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

Definition at line 251 of file TPCRawDataProcessor.hpp.

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

get_tp_count_limit() [1/2]

uint32_t dunedaq::appmodel::TPCRawDataProcessor::get_tp_count_limit ( ) const

inline

Get "tp_count_limit" attribute value. When this number of TPs is reached, the TPs are sent to the sink. SELECT 0 if you want this condition not to be used. In this case, sending TPs will only rely on the number of frames.

Returns

the attribute value

Exceptions

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

Definition at line 145 of file TPCRawDataProcessor.hpp.

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

get_tp_count_limit() [2/2]

uint32_t dunedaq::appmodel::TPCRawDataProcessor::get_tp_count_limit ( ) const

inline

Get "tp_count_limit" attribute value. When this number of TPs is reached, the TPs are sent to the sink. SELECT 0 if you want this condition not to be used. In this case, sending TPs will only rely on the number of frames.

Returns

the attribute value

Exceptions

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

Definition at line 145 of file TPCRawDataProcessor.hpp.

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

init() [1/2]

void dunedaq::appmodel::TPCRawDataProcessor::init ( bool init_children )

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children

if true, initialize referenced objects

Reimplemented from dunedaq::appmodel::RawDataProcessor.

Definition at line 76 of file TPCRawDataProcessor.cpp.

    {
      RawDataProcessor::init(init_children);
 
      TLOG_DEBUG(5) << "read object " << this << " (class " << s_class_name << ')';
 
      try {
        p_obj.get(s_frame_count_limit, m_frame_count_limit);
        p_obj.get(s_tp_count_limit, m_tp_count_limit);
        p_obj.get(s_metric_collect_opmon_rate, m_metric_collect_opmon_rate);
        p_registry._ref<dunedaq::appmodel::ProcessingStep>(p_obj, s_processing_steps, m_processing_steps, init_children);
        m_sot_minima = p_registry._ref<dunedaq::appmodel::SamplesOverThresholdMinima>(p_obj, s_sot_minima, init_children);
      }
      catch (dunedaq::conffwk::Exception & ex) {
        throw_init_ex(ex);
      }
    }

init() [2/2]

virtual void dunedaq::appmodel::TPCRawDataProcessor::init ( bool init_children )

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children

if true, initialize referenced objects

Reimplemented from dunedaq::appmodel::RawDataProcessor.

print() [1/2]

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

virtual

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

Reimplemented from dunedaq::appmodel::RawDataProcessor.

Definition at line 42 of file TPCRawDataProcessor.cpp.

    {
      check_init();
 
      try {
        const std::string str(indent+2, ' ');
 
        if (print_header)
          p_hdr(s, indent, s_class_name, "dunedaq::appmodel");
 
 
          // print direct super-classes
 
        dunedaq::appmodel::RawDataProcessor::print(indent, false, s);
 
 
          // print direct attributes
 
        dunedaq::conffwk::p_sv_attr(s, str, s_frame_count_limit, m_frame_count_limit);
        dunedaq::conffwk::p_sv_attr(s, str, s_tp_count_limit, m_tp_count_limit);
        dunedaq::conffwk::p_sv_attr(s, str, s_metric_collect_opmon_rate, m_metric_collect_opmon_rate);
 
 
          // print direct relationships
 
        dunedaq::conffwk::p_mv_rel(s, str, s_processing_steps, m_processing_steps);
        dunedaq::conffwk::p_sv_rel(s, str, s_sot_minima, m_sot_minima);
      }
      catch (dunedaq::conffwk::Exception & ex) {
        dunedaq::conffwk::DalObject::p_error(s, ex);
      }
    }

print() [2/2]

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

virtual

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

Reimplemented from dunedaq::appmodel::RawDataProcessor.

set_frame_count_limit() [1/2]

void dunedaq::appmodel::TPCRawDataProcessor::set_frame_count_limit ( uint32_t value )

inline

Set "frame_count_limit" attribute value. When this number of frames is reached the TPs are sent to the sink. SELECT 0 if you want this condition not to be used. In this case, sending TPs will only rely on the number of TP.

Parameters

value

new attribute value

Exceptions

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

Definition at line 128 of file TPCRawDataProcessor.hpp.

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

set_frame_count_limit() [2/2]

void dunedaq::appmodel::TPCRawDataProcessor::set_frame_count_limit ( uint32_t value )

inline

Set "frame_count_limit" attribute value. When this number of frames is reached the TPs are sent to the sink. SELECT 0 if you want this condition not to be used. In this case, sending TPs will only rely on the number of TP.

Parameters

value

new attribute value

Exceptions

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

Definition at line 128 of file TPCRawDataProcessor.hpp.

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

set_metric_collect_opmon_rate() [1/2]

void dunedaq::appmodel::TPCRawDataProcessor::set_metric_collect_opmon_rate ( uint32_t value )

inline

Set "metric_collect_opmon_rate" attribute value. The rate at which processor metric is polled from processors for monitoring.

Parameters

value

new attribute value

Exceptions

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

Definition at line 194 of file TPCRawDataProcessor.hpp.

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

set_metric_collect_opmon_rate() [2/2]

void dunedaq::appmodel::TPCRawDataProcessor::set_metric_collect_opmon_rate ( uint32_t value )

inline

Set "metric_collect_opmon_rate" attribute value. The rate at which processor metric is polled from processors for monitoring.

Parameters

value

new attribute value

Exceptions

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

Definition at line 194 of file TPCRawDataProcessor.hpp.

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

set_processing_steps() [1/2]

void dunedaq::appmodel::TPCRawDataProcessor::set_processing_steps

(

const std::vector< const dunedaq::appmodel::ProcessingStep * > &

value

)

Set "processing_steps" relationship value.

Parameters

value

new relationship value

Exceptions

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

Definition at line 129 of file TPCRawDataProcessor.cpp.

    {
      _set_objects(s_processing_steps, value);
    }

set_processing_steps() [2/2]

void dunedaq::appmodel::TPCRawDataProcessor::set_processing_steps

(

const std::vector< const dunedaq::appmodel::ProcessingStep * > &

value

)

Set "processing_steps" relationship value.

Parameters

value

new relationship value

Exceptions

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

set_sot_minima() [1/2]

void dunedaq::appmodel::TPCRawDataProcessor::set_sot_minima

(

const dunedaq::appmodel::SamplesOverThresholdMinima *

value

)

Set "sot_minima" relationship value. TP samples over threshold minimum requirement by plane.

Parameters

value

new relationship value

Exceptions

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

Definition at line 134 of file TPCRawDataProcessor.cpp.

    {
      _set_object(s_sot_minima, value);
    }

set_sot_minima() [2/2]

void dunedaq::appmodel::TPCRawDataProcessor::set_sot_minima

(

const dunedaq::appmodel::SamplesOverThresholdMinima *

value

)

Set "sot_minima" relationship value. TP samples over threshold minimum requirement by plane.

Parameters

value

new relationship value

Exceptions

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

set_tp_count_limit() [1/2]

void dunedaq::appmodel::TPCRawDataProcessor::set_tp_count_limit ( uint32_t value )

inline

Set "tp_count_limit" attribute value. When this number of TPs is reached, the TPs are sent to the sink. SELECT 0 if you want this condition not to be used. In this case, sending TPs will only rely on the number of frames.

Parameters

value

new attribute value

Exceptions

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

Definition at line 161 of file TPCRawDataProcessor.hpp.

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

set_tp_count_limit() [2/2]

void dunedaq::appmodel::TPCRawDataProcessor::set_tp_count_limit ( uint32_t value )

inline

Set "tp_count_limit" attribute value. When this number of TPs is reached, the TPs are sent to the sink. SELECT 0 if you want this condition not to be used. In this case, sending TPs will only rely on the number of frames.

Parameters

value

new attribute value

Exceptions

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

Definition at line 161 of file TPCRawDataProcessor.hpp.

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

Friends And Related Symbol Documentation

conffwk::Configuration

conffwk::Configuration

friend

Definition at line 35 of file TPCRawDataProcessor.hpp.

conffwk::DalFactory

conffwk::DalFactory

friend

Definition at line 37 of file TPCRawDataProcessor.hpp.

conffwk::DalObject

conffwk::DalObject

friend

Definition at line 36 of file TPCRawDataProcessor.hpp.

conffwk::DalRegistry

conffwk::DalRegistry

friend

Definition at line 38 of file TPCRawDataProcessor.hpp.

Member Data Documentation

m_frame_count_limit

uint32_t dunedaq::appmodel::TPCRawDataProcessor::m_frame_count_limit

private

Definition at line 84 of file TPCRawDataProcessor.hpp.

m_metric_collect_opmon_rate

uint32_t dunedaq::appmodel::TPCRawDataProcessor::m_metric_collect_opmon_rate

private

Definition at line 86 of file TPCRawDataProcessor.hpp.

m_processing_steps

std::vector< const dunedaq::appmodel::ProcessingStep * > dunedaq::appmodel::TPCRawDataProcessor::m_processing_steps

private

Definition at line 87 of file TPCRawDataProcessor.hpp.

m_sot_minima

const dunedaq::appmodel::SamplesOverThresholdMinima * dunedaq::appmodel::TPCRawDataProcessor::m_sot_minima

private

Definition at line 88 of file TPCRawDataProcessor.hpp.

m_tp_count_limit

uint32_t dunedaq::appmodel::TPCRawDataProcessor::m_tp_count_limit

private

Definition at line 85 of file TPCRawDataProcessor.hpp.

s_class_name

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

static

The name of the configuration class.

Definition at line 50 of file TPCRawDataProcessor.hpp.

s_frame_count_limit

static const std::string dunedaq::appmodel::TPCRawDataProcessor::s_frame_count_limit = "frame_count_limit"

inlinestatic

Definition at line 95 of file TPCRawDataProcessor.hpp.

s_metric_collect_opmon_rate

static const std::string dunedaq::appmodel::TPCRawDataProcessor::s_metric_collect_opmon_rate = "metric_collect_opmon_rate"

inlinestatic

Definition at line 97 of file TPCRawDataProcessor.hpp.

s_processing_steps

static const std::string dunedaq::appmodel::TPCRawDataProcessor::s_processing_steps = "processing_steps"

inlinestatic

Definition at line 205 of file TPCRawDataProcessor.hpp.

s_sot_minima

static const std::string dunedaq::appmodel::TPCRawDataProcessor::s_sot_minima = "sot_minima"

inlinestatic

Definition at line 206 of file TPCRawDataProcessor.hpp.

s_tp_count_limit

static const std::string dunedaq::appmodel::TPCRawDataProcessor::s_tp_count_limit = "tp_count_limit"

inlinestatic

Definition at line 96 of file TPCRawDataProcessor.hpp.

---

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

• /github/workspace/dunedaq/build/appmodel/codegen/include/appmodel/TPCRawDataProcessor.hpp
• /github/workspace/dunedaq/build/appmodel/codegen/src/TPCRawDataProcessor.hpp
• /github/workspace/dunedaq/build/appmodel/codegen/src/TPCRawDataProcessor.cpp