dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER > Class Template Reference

#include <TriggerGenericMaker.hpp>

Inheritance diagram for dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >:

Collaboration diagram for dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >:

Public Member Functions
	TriggerGenericMaker (const std::string &name)
virtual	~TriggerGenericMaker ()
	TriggerGenericMaker (const TriggerGenericMaker &)=delete
TriggerGenericMaker &	operator= (const TriggerGenericMaker &)=delete
	TriggerGenericMaker (TriggerGenericMaker &&)=delete
TriggerGenericMaker &	operator= (TriggerGenericMaker &&)=delete
void	get_info (opmonlib::InfoCollector &ci, int) override

Protected Member Functions
void	set_algorithm_name (const std::string &name)
void	set_sourceid (uint32_t element_id)
void	set_windowing (daqdataformats::timestamp_t window_time, daqdataformats::timestamp_t buffer_time)

Private Types
using	metric_counter_type = decltype(triggergenericmakerinfo::Info::received_count)
using	source_t = dunedaq::iomanager::ReceiverConcept<IN>
using	sink_t = dunedaq::iomanager::SenderConcept<OUT>

Private Member Functions
virtual std::unique_ptr< MAKER >	make_maker (const nlohmann::json &obj)=0
void	do_start (const nlohmann::json &startobj)
void	do_stop (const nlohmann::json &)
void	do_configure (const nlohmann::json &obj)
void	do_scrap (const nlohmann::json &obj)
void	do_work (std::atomic< bool > &m_running_flag)
bool	receive (IN &in)
bool	send (OUT &&out)

Private Attributes
dunedaq::utilities::WorkerThread	m_thread
std::atomic< metric_counter_type >	m_received_count
std::atomic< metric_counter_type >	m_sent_count
dfmessages::run_number_t	m_run_number
std::shared_ptr< source_t >	m_input_queue
std::shared_ptr< sink_t >	m_output_queue
std::chrono::milliseconds	m_queue_timeout
std::string	m_algorithm_name
uint32_t	m_sourceid
daqdataformats::timestamp_t	m_buffer_time
daqdataformats::timestamp_t	m_window_time
std::unique_ptr< MAKER >	m_maker
nlohmann::json	m_maker_conf
TriggerGenericWorker< IN, OUT, MAKER >	worker

Friends
class	TriggerGenericWorker< IN, OUT, MAKER >

Detailed Description

template<class IN, class OUT, class MAKER>
class dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >

Definition at line 45 of file TriggerGenericMaker.hpp.

Member Typedef Documentation

metric_counter_type

template<class IN , class OUT , class MAKER >

using dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >::metric_counter_type = decltype(triggergenericmakerinfo::Info::received_count)

private

Definition at line 116 of file TriggerGenericMaker.hpp.

sink_t

template<class IN , class OUT , class MAKER >

using dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >::sink_t = dunedaq::iomanager::SenderConcept<OUT>

private

Definition at line 124 of file TriggerGenericMaker.hpp.

source_t

template<class IN , class OUT , class MAKER >

using dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >::source_t = dunedaq::iomanager::ReceiverConcept<IN>

private

Definition at line 121 of file TriggerGenericMaker.hpp.

Constructor & Destructor Documentation

TriggerGenericMaker() [1/3]

template<class IN , class OUT , class MAKER >

dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >::TriggerGenericMaker ( const std::string & name )

inlineexplicit

Definition at line 50 of file TriggerGenericMaker.hpp.

    : DAQModule(name)
    , m_thread(std::bind(&TriggerGenericMaker::do_work, this, std::placeholders::_1))
    , m_received_count(0)
    , m_sent_count(0)
    , m_run_number(0)
    , m_input_queue(nullptr)
    , m_output_queue(nullptr)
    , m_queue_timeout(100)
    , m_algorithm_name("[uninitialized]")
    , m_sourceid(dunedaq::daqdataformats::SourceID::s_invalid_id)
    , m_buffer_time(0)
    , m_window_time(625000)
    , worker(*this) // should be last; may use other members
  {
    register_command("start", &TriggerGenericMaker::do_start);
    register_command("stop", &TriggerGenericMaker::do_stop);
    register_command("conf", &TriggerGenericMaker::do_configure);
    register_command("scrap", &TriggerGenericMaker::do_scrap);
  }

~TriggerGenericMaker()

template<class IN , class OUT , class MAKER >

virtual dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >::~TriggerGenericMaker ( )

inlinevirtual

Definition at line 71 of file TriggerGenericMaker.hpp.

{}

TriggerGenericMaker() [2/3]

template<class IN , class OUT , class MAKER >

dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >::TriggerGenericMaker ( const TriggerGenericMaker< IN, OUT, MAKER > & )

delete

TriggerGenericMaker() [3/3]

template<class IN , class OUT , class MAKER >

dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >::TriggerGenericMaker ( TriggerGenericMaker< IN, OUT, MAKER > && )

delete

Member Function Documentation

do_configure()

template<class IN , class OUT , class MAKER >

void dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >::do_configure ( const nlohmann::json & obj )

inlineprivate

Definition at line 160 of file TriggerGenericMaker.hpp.

  {
    // P. Rodrigues 2022-07-13
    // We stash the config here and don't actually create the maker
    // algorithm until start time, so that the algorithm doesn't
    // persist between runs and hold onto its state from the previous
    // run
    m_maker_conf = obj;
   
    // worker should be notified that configuration potentially changed
    worker.reconfigure();
  }

do_scrap()

template<class IN , class OUT , class MAKER >

void dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >::do_scrap ( const nlohmann::json & obj )

inlineprivate

Definition at line 173 of file TriggerGenericMaker.hpp.

  {
    m_input_queue.reset();
    m_output_queue.reset();
    m_maker.reset();
    m_maker_conf.clear();
  }

do_start()

template<class IN , class OUT , class MAKER >

void dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >::do_start ( const nlohmann::json & startobj )

inlineprivate

Definition at line 145 of file TriggerGenericMaker.hpp.

  {
    m_received_count = 0;
    m_sent_count = 0;
    m_maker = make_maker(m_maker_conf);
    worker.reconfigure();
    m_thread.start_working_thread(get_name());
    m_run_number = startobj.value<dunedaq::daqdataformats::run_number_t>("run", 0);
  }

do_stop()

template<class IN , class OUT , class MAKER >

void dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >::do_stop ( const nlohmann::json & )

inlineprivate

Definition at line 155 of file TriggerGenericMaker.hpp.

  {
    m_thread.stop_working_thread();
  }

do_work()

template<class IN , class OUT , class MAKER >

void dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >::do_work ( std::atomic< bool > & m_running_flag )

inlineprivate

Definition at line 181 of file TriggerGenericMaker.hpp.

  {
    // Loop until a stop is received
    while (m_running_flag.load()) {
      // While there are items in the input queue, continue draining even if
      // the running_flag is false, but stop _immediately_ when input is empty
      IN in;
      while (receive(in)) {
        if (m_running_flag.load()) {
      worker.process(in); 
    }
      }
    }
    // P. Rodrigues 2022-06-01. The argument here is whether to drop
    // buffered outputs. We choose 'true' because some significant
    // time can pass between the last input sent by readout and when
    // we receive a stop. (This happens because stop is sent serially
    // to readout units before trigger, and each RU takes ~1s to
    // stop). So by the time we receive a stop command, our buffered
    // outputs are stale and will cause tardy warnings from the zipper
    // downstream
    worker.drain(true);
    TLOG() << get_name() << ": Exiting do_work() method for run " << m_run_number << ", received " << m_received_count
           << " inputs (" << worker.get_low_level_input_count() << " sub-inputs) and successfully sent " << m_sent_count
           << " outputs. ";
    worker.reset();
  }

get_info()

template<class IN , class OUT , class MAKER >

void dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >::get_info ( opmonlib::InfoCollector & ci, int  )

inlineoverride

Definition at line 85 of file TriggerGenericMaker.hpp.

  {
    triggergenericmakerinfo::Info i;
 
    i.received_count = m_received_count.load();
    i.sent_count = m_sent_count.load();
    if (m_maker) { i.data_vs_system_ms = m_maker->m_data_vs_system_time; }
    else i.data_vs_system_ms = 0;    
 
    ci.add(i);
  }

make_maker()

template<class IN , class OUT , class MAKER >

virtual std::unique_ptr< MAKER > dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >::make_maker ( const nlohmann::json & obj )

privatepure virtual

operator=() [1/2]

template<class IN , class OUT , class MAKER >

TriggerGenericMaker & dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >::operator= ( const TriggerGenericMaker< IN, OUT, MAKER > & )

delete

operator=() [2/2]

template<class IN , class OUT , class MAKER >

TriggerGenericMaker & dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >::operator= ( TriggerGenericMaker< IN, OUT, MAKER > && )

delete

receive()

template<class IN , class OUT , class MAKER >

bool dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >::receive ( IN & in )

inlineprivate

Definition at line 209 of file TriggerGenericMaker.hpp.

  {
    try {
      in = m_input_queue->receive(m_queue_timeout);
    } catch (const dunedaq::iomanager::TimeoutExpired& excpt) {
      // it is perfectly reasonable that there might be no data in the queue
      // some fraction of the times that we check, so we just continue on and try again
      return false;
    }
    ++m_received_count;
    return true;
  }

send()

template<class IN , class OUT , class MAKER >

bool dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >::send ( OUT && out )

inlineprivate

Definition at line 222 of file TriggerGenericMaker.hpp.

  {
    try {
      m_output_queue->send(std::move(out), m_queue_timeout);
    } catch (const dunedaq::iomanager::TimeoutExpired& excpt) {
      ers::warning(excpt);
      return false;
    }
    ++m_sent_count;
    return true;
  }

set_algorithm_name()

template<class IN , class OUT , class MAKER >

void dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >::set_algorithm_name ( const std::string & name )

inlineprotected

Definition at line 98 of file TriggerGenericMaker.hpp.

{ m_algorithm_name = name; }

set_sourceid()

template<class IN , class OUT , class MAKER >

void dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >::set_sourceid ( uint32_t element_id )

inlineprotected

Definition at line 101 of file TriggerGenericMaker.hpp.

  {
    m_sourceid = element_id;
  }

set_windowing()

template<class IN , class OUT , class MAKER >

void dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >::set_windowing ( daqdataformats::timestamp_t window_time, daqdataformats::timestamp_t buffer_time )

inlineprotected

Definition at line 107 of file TriggerGenericMaker.hpp.

  {
    m_window_time = window_time;
    m_buffer_time = buffer_time;
  }

Friends And Related Symbol Documentation

TriggerGenericWorker< IN, OUT, MAKER >

template<class IN , class OUT , class MAKER >

friend class TriggerGenericWorker< IN, OUT, MAKER >

friend

Definition at line 1 of file TriggerGenericMaker.hpp.

Member Data Documentation

m_algorithm_name

template<class IN , class OUT , class MAKER >

std::string dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >::m_algorithm_name

private

Definition at line 129 of file TriggerGenericMaker.hpp.

m_buffer_time

template<class IN , class OUT , class MAKER >

daqdataformats::timestamp_t dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >::m_buffer_time

private

Definition at line 133 of file TriggerGenericMaker.hpp.

m_input_queue

template<class IN , class OUT , class MAKER >

std::shared_ptr<source_t> dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >::m_input_queue

private

Definition at line 122 of file TriggerGenericMaker.hpp.

m_maker

template<class IN , class OUT , class MAKER >

std::unique_ptr<MAKER> dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >::m_maker

private

Definition at line 136 of file TriggerGenericMaker.hpp.

m_maker_conf

template<class IN , class OUT , class MAKER >

nlohmann::json dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >::m_maker_conf

private

Definition at line 137 of file TriggerGenericMaker.hpp.

m_output_queue

template<class IN , class OUT , class MAKER >

std::shared_ptr<sink_t> dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >::m_output_queue

private

Definition at line 125 of file TriggerGenericMaker.hpp.

m_queue_timeout

template<class IN , class OUT , class MAKER >

std::chrono::milliseconds dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >::m_queue_timeout

private

Definition at line 127 of file TriggerGenericMaker.hpp.

m_received_count

template<class IN , class OUT , class MAKER >

std::atomic<metric_counter_type> dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >::m_received_count

private

Definition at line 117 of file TriggerGenericMaker.hpp.

m_run_number

template<class IN , class OUT , class MAKER >

dfmessages::run_number_t dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >::m_run_number

private

Definition at line 119 of file TriggerGenericMaker.hpp.

m_sent_count

template<class IN , class OUT , class MAKER >

std::atomic<metric_counter_type> dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >::m_sent_count

private

Definition at line 118 of file TriggerGenericMaker.hpp.

m_sourceid

template<class IN , class OUT , class MAKER >

uint32_t dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >::m_sourceid

private

Definition at line 131 of file TriggerGenericMaker.hpp.

m_thread

template<class IN , class OUT , class MAKER >

dunedaq::utilities::WorkerThread dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >::m_thread

private

Definition at line 114 of file TriggerGenericMaker.hpp.

m_window_time

template<class IN , class OUT , class MAKER >

daqdataformats::timestamp_t dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >::m_window_time

private

Definition at line 134 of file TriggerGenericMaker.hpp.

worker

template<class IN , class OUT , class MAKER >

TriggerGenericWorker<IN, OUT, MAKER> dunedaq::trigger::TriggerGenericMaker< IN, OUT, MAKER >::worker

private

Definition at line 139 of file TriggerGenericMaker.hpp.

---

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

• /github/workspace/dunedaq/sourcecode/trigger/src/trigger/TriggerGenericMaker.hpp