artdaq  v3_03_00
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

Public Member Functions

 DispatcherApp ()
 DispatcherApp Constructor.
 
 DispatcherApp (DispatcherApp const &)=delete
 Copy Constructor is Deleted.
 
virtual ~DispatcherApp ()=default
 Default virtual destructor.
 
DispatcherAppoperator= (DispatcherApp const &)=delete
 Copy Assignment operator is Deleted. More...
 
bool do_initialize (fhicl::ParameterSet const &pset, uint64_t, uint64_t) override
 Initialize the DispatcherCore. More...
 
bool do_start (art::RunID id, uint64_t, uint64_t) override
 Start the DispatcherCore. More...
 
bool do_stop (uint64_t, uint64_t) override
 Stop the DispatcherCore. More...
 
bool do_pause (uint64_t, uint64_t) override
 Pause the DispatcherCore. More...
 
bool do_resume (uint64_t, uint64_t) override
 Resume the DispatcherCore. More...
 
bool do_shutdown (uint64_t) override
 Shutdown the DispatcherCore. More...
 
bool do_soft_initialize (fhicl::ParameterSet const &, uint64_t, uint64_t) override
 Soft-initialize the DispatcherCore. No-Op. More...
 
bool do_reinitialize (fhicl::ParameterSet const &, uint64_t, uint64_t) override
 Reinitialize the DispatcherCore. No-Op. More...
 
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. More...
 
std::string register_monitor (fhicl::ParameterSet const &info) override
 Register an art Online Monitor to the DispatcherCore. More...
 
std::string unregister_monitor (std::string const &label) override
 Remove an art Online Monitor from the DispatcherCore. More...
 
- Public Member Functions inherited from artdaq::Commandable
 Commandable ()
 
 Commandable (Commandable const &)=delete
 Copy Constructor is deleted.
 
virtual ~Commandable ()=default
 Default Destructor.
 
Commandableoperator= (Commandable const &)=delete
 Copy Assignment operator is deleted. More...
 
bool initialize (fhicl::ParameterSet const &pset, uint64_t timeout, uint64_t timestamp)
 Processes the initialize request. More...
 
bool start (art::RunID id, uint64_t timeout, uint64_t timestamp)
 Processes the start transition. More...
 
bool stop (uint64_t timeout, uint64_t timestamp)
 Processes the stop transition. More...
 
bool pause (uint64_t timeout, uint64_t timestamp)
 Processes the pause transition. More...
 
bool resume (uint64_t timeout, uint64_t timestamp)
 Processes the resume transition. More...
 
bool shutdown (uint64_t timeout)
 Processes the shutdown transition. More...
 
bool soft_initialize (fhicl::ParameterSet const &pset, uint64_t timeout, uint64_t timestamp)
 Processes the soft-initialize request. More...
 
bool reinitialize (fhicl::ParameterSet const &pset, uint64_t timeout, uint64_t timestamp)
 Processes the reinitialize request. More...
 
bool in_run_failure ()
 Actions taken when the in_run_failure state is set. More...
 
std::string status () const
 Returns the current state of the Commandable. More...
 
std::vector< std::string > legal_commands () const
 Get the legal transition commands from the current state. More...
 
virtual bool do_rollover_subrun (uint64_t eventNum)
 Perform the rollover_subrun transition. More...
 
virtual void badTransition (const std::string &trans)
 This function is called when an attempt is made to call an illegal transition. More...
 
virtual void BootedEnter ()
 Perform actions upon entering the Booted state. More...
 
virtual void InRunExit ()
 Perform actions upon leaving the InRun state. More...
 
virtual std::string do_trace_get (std::string const &name)
 Get the TRACE mask for the given TRACE name If name is "ALL", then all TRACE masks will be printed. More...
 
virtual bool do_trace_set (std::string const &type, std::string const &name, uint64_t mask)
 Set the given TRACE mask for the given TRACE name. More...
 
virtual bool do_meta_command (std::string const &command, std::string const &args)
 Run a module-defined command with the given parameter string. More...
 
virtual bool do_add_config_archive_entry (std::string const &, std::string const &)
 Add the specified key-value pair to the configuration archive list. More...
 
virtual bool do_clear_config_archive ()
 Clears the configuration archive list. More...
 

Additional Inherited Members

- Protected Member Functions inherited from artdaq::Commandable
std::string current_state () const
 Return the name of the current state. More...
 
- Protected Attributes inherited from artdaq::Commandable
CommandableContext fsm_
 The generated State Machine (using smc_compiler)
 
bool external_request_status_
 Whether the last command succeeded.
 
std::string report_string_
 Status information about the last command.
 

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   
)
overridevirtual

Initialize the DispatcherCore.

Parameters
psetParameterSet 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   
)
overridevirtual

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   
)
overridevirtual

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   
)
overridevirtual

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  )
overridevirtual

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   
)
overridevirtual

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   
)
overridevirtual

Start the DispatcherCore.

Parameters
idRun 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   
)
overridevirtual

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 &  )
delete

Copy Assignment operator is Deleted.

Returns
DispatcherApp copy
std::string artdaq::DispatcherApp::register_monitor ( fhicl::ParameterSet const &  info)
overridevirtual

Register an art Online Monitor to the DispatcherCore.

Parameters
infoParameterSet 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
overridevirtual

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

Parameters
whichWhat 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)
overridevirtual

Remove an art Online Monitor from the DispatcherCore.

Parameters
labelName 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: