artdaq  v3_00_03
artdaq::DataLoggerApp Class Reference

DataLoggerApp is an artdaq::Commandable derived class which controls the DataLoggerCore. More...

#include <artdaq/Application/DataLoggerApp.hh>

Inheritance diagram for artdaq::DataLoggerApp:
artdaq::Commandable

Public Member Functions

 DataLoggerApp (int rank, std::string name)
 DataLoggerApp Constructor. More...
 
 DataLoggerApp (DataLoggerApp const &)=delete
 Copy Constructor is Deleted.
 
virtual ~DataLoggerApp ()=default
 Default virtual destructor.
 
DataLoggerAppoperator= (DataLoggerApp const &)=delete
 Copy Assignment operator is Deleted. More...
 
bool do_initialize (fhicl::ParameterSet const &pset, uint64_t, uint64_t) override
 Initialize the DataLoggerCore. More...
 
bool do_start (art::RunID id, uint64_t, uint64_t) override
 Start the DataLoggerCore. More...
 
bool do_stop (uint64_t, uint64_t) override
 Stop the DataLoggerCore. More...
 
bool do_pause (uint64_t, uint64_t) override
 Pause the DataLoggerCore. More...
 
bool do_resume (uint64_t, uint64_t) override
 Resume the DataLoggerCore. More...
 
bool do_shutdown (uint64_t) override
 Shutdown the DataLoggerCore. More...
 
bool do_soft_initialize (fhicl::ParameterSet const &, uint64_t, uint64_t) override
 Soft-initialize the DataLoggerCore. No-Op. More...
 
bool do_reinitialize (fhicl::ParameterSet const &, uint64_t, uint64_t) override
 Reinitialize the DataLoggerCore. 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 DataLoggerCore. 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...
 
virtual std::string register_monitor (fhicl::ParameterSet const &)
 Perform the register_monitor action. More...
 
virtual std::string unregister_monitor (std::string const &)
 Perform the unregister_monitor action. More...
 
std::vector< std::string > legal_commands () const
 Get the legal transition commands from the current state. 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 &)
 Get the TRACE mask for the given trace name. More...
 
virtual bool do_trace_set (std::string const &, std::string const &, uint64_t)
 Set the given TRACE mask for the given trace name. More...
 
virtual bool do_meta_command (std::string const &, std::string const &)
 Run a module-defined command with the given parameter string. 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

DataLoggerApp is an artdaq::Commandable derived class which controls the DataLoggerCore.

Definition at line 17 of file DataLoggerApp.hh.

Constructor & Destructor Documentation

artdaq::DataLoggerApp::DataLoggerApp ( int  rank,
std::string  name 
)

DataLoggerApp Constructor.

Parameters
rankThe rank of the DataLogger
nameThe nickname of the DataLogger

Definition at line 7 of file DataLoggerApp.cc.

Member Function Documentation

bool artdaq::DataLoggerApp::do_initialize ( fhicl::ParameterSet const &  pset,
uint64_t  ,
uint64_t   
)
overridevirtual

Initialize the DataLoggerCore.

Parameters
psetParameterSet used to initialize the DataLoggerCore
Returns
Whether the initialize transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 17 of file DataLoggerApp.cc.

bool artdaq::DataLoggerApp::do_pause ( uint64_t  ,
uint64_t   
)
overridevirtual

Pause the DataLoggerCore.

Returns
Whether the pause transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 66 of file DataLoggerApp.cc.

bool artdaq::DataLoggerApp::do_reinitialize ( fhicl::ParameterSet const &  ,
uint64_t  ,
uint64_t   
)
overridevirtual

Reinitialize the DataLoggerCore. No-Op.

Returns
This function always returns true

Reimplemented from artdaq::Commandable.

Definition at line 110 of file DataLoggerApp.cc.

bool artdaq::DataLoggerApp::do_resume ( uint64_t  ,
uint64_t   
)
overridevirtual

Resume the DataLoggerCore.

Returns
Whether the resume transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 79 of file DataLoggerApp.cc.

bool artdaq::DataLoggerApp::do_shutdown ( uint64_t  )
overridevirtual

Shutdown the DataLoggerCore.

Returns
Whether the shutdown transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 92 of file DataLoggerApp.cc.

bool artdaq::DataLoggerApp::do_soft_initialize ( fhicl::ParameterSet const &  ,
uint64_t  ,
uint64_t   
)
overridevirtual

Soft-initialize the DataLoggerCore. No-Op.

Returns
This function always returns true

Reimplemented from artdaq::Commandable.

Definition at line 105 of file DataLoggerApp.cc.

bool artdaq::DataLoggerApp::do_start ( art::RunID  id,
uint64_t  ,
uint64_t   
)
overridevirtual

Start the DataLoggerCore.

Parameters
idRun number of the new run
Returns
Whether the start transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 37 of file DataLoggerApp.cc.

bool artdaq::DataLoggerApp::do_stop ( uint64_t  ,
uint64_t   
)
overridevirtual

Stop the DataLoggerCore.

Returns
Whether the stop transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 53 of file DataLoggerApp.cc.

DataLoggerApp& artdaq::DataLoggerApp::operator= ( DataLoggerApp const &  )
delete

Copy Assignment operator is Deleted.

Returns
DataLoggerApp copy
std::string artdaq::DataLoggerApp::report ( std::string const &  which) const
overridevirtual

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

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

Reimplemented from artdaq::Commandable.

Definition at line 115 of file DataLoggerApp.cc.


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