artdaq::DispatcherApp Class Reference

DispatcherApp is an artdaq::Commandable derived class which controls the DispatcherCore. More...

#include <artdaq/Application/DispatcherApp.hh>

Inheritance diagram for artdaq::DispatcherApp:
artdaq::Commandable

List of all members.

Public Member Functions

 DispatcherApp ()
 DispatcherApp Constructor.
 DispatcherApp (DispatcherApp const &)
 Copy Constructor is Deleted.
virtual ~DispatcherApp ()
 Default virtual destructor.
DispatcherAppoperator= (DispatcherApp const &)
 Copy Assignment operator is Deleted.
bool do_initialize (fhicl::ParameterSet const &pset, uint64_t, uint64_t) override
 Initialize the DispatcherCore.
bool do_start (art::RunID id, uint64_t, uint64_t) override
 Start the DispatcherCore.
bool do_stop (uint64_t, uint64_t) override
 Stop the DispatcherCore.
bool do_pause (uint64_t, uint64_t) override
 Pause the DispatcherCore.
bool do_resume (uint64_t, uint64_t) override
 Resume the DispatcherCore.
bool do_shutdown (uint64_t) override
 Shutdown the DispatcherCore.
bool do_soft_initialize (fhicl::ParameterSet const &, uint64_t, uint64_t) override
 Soft-initialize the DispatcherCore. No-Op.
bool do_reinitialize (fhicl::ParameterSet const &, uint64_t, uint64_t) override
 Reinitialize the DispatcherCore. No-Op.
std::string report (std::string const &which) const override
 If which is "transition_status", report the status of the last transition. Otherwise pass through to DispatcherCore.
std::string register_monitor (fhicl::ParameterSet const &info) override
 Register an art Online Monitor to the DispatcherCore.
std::string unregister_monitor (std::string const &label) override
 Remove an art Online Monitor from the DispatcherCore.

Detailed Description

DispatcherApp is an artdaq::Commandable derived class which controls the DispatcherCore.

Definition at line 17 of file DispatcherApp.hh.


Member Function Documentation

bool artdaq::DispatcherApp::do_initialize ( fhicl::ParameterSet const &  pset,
uint64_t  ,
uint64_t   
) [override, virtual]

Initialize the DispatcherCore.

Parameters:
pset ParameterSet used to initialize the DispatcherCore
Returns:
Whether the initialize transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 17 of file DispatcherApp.cc.

bool artdaq::DispatcherApp::do_pause ( uint64_t  ,
uint64_t   
) [override, virtual]

Pause the DispatcherCore.

Returns:
Whether the pause transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 66 of file DispatcherApp.cc.

bool artdaq::DispatcherApp::do_reinitialize ( fhicl::ParameterSet const &  ,
uint64_t  ,
uint64_t   
) [override, virtual]

Reinitialize the DispatcherCore. No-Op.

Returns:
This function always returns true

Reimplemented from artdaq::Commandable.

Definition at line 109 of file DispatcherApp.cc.

bool artdaq::DispatcherApp::do_resume ( uint64_t  ,
uint64_t   
) [override, virtual]

Resume the DispatcherCore.

Returns:
Whether the resume transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 78 of file DispatcherApp.cc.

bool artdaq::DispatcherApp::do_shutdown ( uint64_t   )  [override, virtual]

Shutdown the DispatcherCore.

Returns:
Whether the shutdown transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 91 of file DispatcherApp.cc.

bool artdaq::DispatcherApp::do_soft_initialize ( fhicl::ParameterSet const &  ,
uint64_t  ,
uint64_t   
) [override, virtual]

Soft-initialize the DispatcherCore. No-Op.

Returns:
This function always returns true

Reimplemented from artdaq::Commandable.

Definition at line 104 of file DispatcherApp.cc.

bool artdaq::DispatcherApp::do_start ( art::RunID  id,
uint64_t  ,
uint64_t   
) [override, virtual]

Start the DispatcherCore.

Parameters:
id Run number of the new run
Returns:
Whether the start transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 37 of file DispatcherApp.cc.

bool artdaq::DispatcherApp::do_stop ( uint64_t  ,
uint64_t   
) [override, virtual]

Stop the DispatcherCore.

Returns:
Whether the stop transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 53 of file DispatcherApp.cc.

DispatcherApp& artdaq::DispatcherApp::operator= ( DispatcherApp const &   ) 

Copy Assignment operator is Deleted.

Returns:
DispatcherApp copy

Reimplemented from artdaq::Commandable.

std::string artdaq::DispatcherApp::register_monitor ( fhicl::ParameterSet const &  info  )  [override, virtual]

Register an art Online Monitor to the DispatcherCore.

Parameters:
info ParameterSet containing information about the monitor
Returns:
String detailing result status

Reimplemented from artdaq::Commandable.

Definition at line 147 of file DispatcherApp.cc.

std::string artdaq::DispatcherApp::report ( std::string const &  which  )  const [override, virtual]

If which is "transition_status", report the status of the last transition. Otherwise pass through to DispatcherCore.

Parameters:
which What to report on
Returns:
Report string. Empty for unknown "which" parameter

Reimplemented from artdaq::Commandable.

Definition at line 114 of file DispatcherApp.cc.

std::string artdaq::DispatcherApp::unregister_monitor ( std::string const &  label  )  [override, virtual]

Remove an art Online Monitor from the DispatcherCore.

Parameters:
label Name of the monitor to remove
Returns:
String detailing result status

Reimplemented from artdaq::Commandable.

Definition at line 172 of file DispatcherApp.cc.


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

Generated on 24 Sep 2018 for artdaq by  doxygen 1.6.1