artdaq
v3_02_00
|
CompositeDriver handles a set of lower-level generators. More...
#include <artdaq/Application/CompositeDriver.hh>
Public Member Functions | |
CompositeDriver (fhicl::ParameterSet const &ps) | |
CompositeDriver Constructor. More... | |
virtual | ~CompositeDriver () noexcept |
Destructor. Calls the destructors for each configured CommandableFragmentGenerator. | |
void | start () override |
Start all configured CommandableFragmentGenerators. | |
void | stopNoMutex () override |
Call non-locked stop methods for all configured CommandableFragmentGenerators. | |
void | stop () override |
Call stop methods for all configured CommandableFragmentGenerators. Currently handled by stopNoMutex. | |
void | pause () override |
Pause all configured CommandableFragmentGenerators. | |
void | resume () override |
Resume all configured CommandableFragmentGenerators. | |
![]() | |
CommandableFragmentGenerator () | |
CommandableFragmentGenerator default constructor. More... | |
CommandableFragmentGenerator (const fhicl::ParameterSet &ps) | |
CommandableFragmentGenerator Constructor. More... | |
virtual | ~CommandableFragmentGenerator () |
CommandableFragmentGenerator Destructor. More... | |
void | joinThreads () |
Join any data-taking threads. Should be called when destructing CommandableFragmentGenerator. More... | |
bool | getNext (FragmentPtrs &output) overridefinal |
getNext calls either applyRequests or getNext_ to get any data that is ready to be sent to the EventBuilders More... | |
void | applyRequestsIgnoredMode (artdaq::FragmentPtrs &frags) |
Create fragments using data buffer for request mode Ignored. Precondition: dataBufferMutex_ and request_mutex_ are locked More... | |
void | applyRequestsSingleMode (artdaq::FragmentPtrs &frags) |
Create fragments using data buffer for request mode Single. Precondition: dataBufferMutex_ and request_mutex_ are locked More... | |
void | applyRequestsBufferMode (artdaq::FragmentPtrs &frags) |
Create fragments using data buffer for request mode Buffer. Precondition: dataBufferMutex_ and request_mutex_ are locked More... | |
void | applyRequestsWindowMode (artdaq::FragmentPtrs &frags) |
Create fragments using data buffer for request mode Window. Precondition: dataBufferMutex_ and request_mutex_ are locked More... | |
bool | applyRequests (FragmentPtrs &output) |
See if any requests have been received, and add the corresponding data Fragment objects to the output list. More... | |
bool | sendEmptyFragment (FragmentPtrs &frags, size_t sequenceId, std::string desc) |
Send an EmptyFragmentType Fragment. More... | |
void | sendEmptyFragments (FragmentPtrs &frags, std::map< Fragment::sequence_id_t, Fragment::timestamp_t > &requests) |
This function is for Buffered and Single request modes, as they can only respond to one data request at a time If the request message seqID > ev_counter, simply send empties until they're equal. More... | |
void | startDataThread () |
Function that launches the data thread (getDataLoop()) | |
void | startMonitoringThread () |
Function that launches the monitoring thread (getMonitoringDataLoop()) | |
void | getDataLoop () |
When separate_data_thread is set to true, this loop repeatedly calls getNext_ and adds returned Fragment objects to the data buffer, blocking when the data buffer is full. | |
bool | waitForDataBufferReady () |
Wait for the data buffer to drain (dataBufferIsTooLarge returns false), periodically reporting status. More... | |
bool | dataBufferIsTooLarge () |
Test the configured constraints on the data buffer. More... | |
void | getDataBufferStats () |
Calculate the size of the dataBuffer and report appropriate metrics. More... | |
void | checkDataBuffer () |
Perform data buffer pruning operations. If the RequestMode is Single, removes all but the latest Fragment from the data buffer. In Window and Buffer RequestModes, this function discards the oldest Fragment objects until the data buffer is below its size constraints, then also checks for stale Fragments, based on the timestamp of the most recent Fragment. | |
void | getMonitoringDataLoop () |
This function regularly calls checkHWStatus_(), and sets the isHardwareOK flag accordingly. | |
std::vector < Fragment::fragment_id_t > | fragmentIDs () override |
Get the list of Fragment IDs handled by this CommandableFragmentGenerator. More... | |
void | StartCmd (int run, uint64_t timeout, uint64_t timestamp) |
Start the CommandableFragmentGenerator. More... | |
void | StopCmd (uint64_t timeout, uint64_t timestamp) |
Stop the CommandableFragmentGenerator. More... | |
void | PauseCmd (uint64_t timeout, uint64_t timestamp) |
Pause the CommandableFragmentGenerator. More... | |
void | ResumeCmd (uint64_t timeout, uint64_t timestamp) |
Resume the CommandableFragmentGenerator. More... | |
std::string | ReportCmd (std::string const &which="") |
Get a report about a user-specified run-time quantity. More... | |
virtual std::string | metricsReportingInstanceName () const |
Get the name used when reporting metrics. More... | |
bool | exception () const |
Get the current value of the exception flag. More... | |
virtual bool | metaCommand (std::string const &command, std::string const &arg) |
The meta-command is used for implementing user-specific commands in a CommandableFragmentGenerator. More... | |
Additional Inherited Members | |
![]() | |
int | run_number () const |
Get the current Run number. More... | |
int | subrun_number () const |
Get the current Subrun number. More... | |
uint64_t | timeout () const |
Timeout of last command. More... | |
uint64_t | timestamp () const |
Timestamp of last command. More... | |
bool | should_stop () const |
Get the current value of the should_stop flag. More... | |
bool | check_stop () |
Routine used by applyRequests to make sure that all outstanding requests have been fulfilled before returning. More... | |
int | board_id () const |
Gets the current board_id. More... | |
int | fragment_id () const |
Get the current Fragment ID, if there is only one. More... | |
size_t | ev_counter () const |
Get the current value of the event counter. More... | |
size_t | ev_counter_inc (size_t step=1, bool force=false) |
Increment the event counter, if the current RequestMode allows it. More... | |
void | set_exception (bool exception) |
Control the exception flag. More... | |
void | metricsReportingInstanceName (std::string const &name) |
Sets the name for metrics reporting. More... | |
std::string | printMode_ () |
Return the string representation of the current RequestMode. More... | |
virtual bool | getNext_ (FragmentPtrs &output)=0 |
virtual bool | checkHWStatus_ () |
virtual void | pauseNoMutex () |
virtual std::string | report () |
virtual std::string | reportSpecific (std::string const &) |
![]() | |
std::mutex | mutex_ |
Mutex used to ensure that multiple transition commands do not run at the same time. | |
CompositeDriver handles a set of lower-level generators.
When multiple CommandableFragmentGenerators are needed by a single BoardReader, CompositeDriver may be used to provide a single interface to all of them.
Definition at line 17 of file CompositeDriver.hh.
|
explicit |
CompositeDriver Constructor.
ps | ParameterSet used to configure CompositeDriver |
* CompositeDriver accepts the following Parameters: * "generator_config_list" (REQUIRED): A FHiCL sequence of FHiCL tables, each one configuring * a CommandableFragmentGenerator instance. *
Definition at line 13 of file CompositeDriver_generator.cc.