artdaq  v3_03_00
artdaq::BoardReaderApp Class Reference

BoardReaderApp is an artdaq::Commandable derived class which controls the BoardReaderCore state machine. More...

#include <artdaq/Application/BoardReaderApp.hh>

Inheritance diagram for artdaq::BoardReaderApp:
artdaq::Commandable

Public Member Functions

 BoardReaderApp ()
 BoardReaderApp Constructor.
 
 BoardReaderApp (BoardReaderApp const &)=delete
 Copy Constructor is deleted.
 
virtual ~BoardReaderApp ()=default
 Default Destructor.
 
BoardReaderAppoperator= (BoardReaderApp const &)=delete
 Copy Assignment Operator is deleted. More...
 
bool do_initialize (fhicl::ParameterSet const &pset, uint64_t timeout, uint64_t timestamp) override
 Initialize the BoardReaderCore. More...
 
bool do_start (art::RunID id, uint64_t timeout, uint64_t timestamp) override
 Start the BoardReaderCore. More...
 
bool do_stop (uint64_t timeout, uint64_t timestamp) override
 Stop the BoardReaderCore. More...
 
bool do_pause (uint64_t timeout, uint64_t timestamp) override
 Pause the BoardReaderCore. More...
 
bool do_resume (uint64_t timeout, uint64_t timestamp) override
 Resume the BoardReaderCore. More...
 
bool do_shutdown (uint64_t timeout) override
 Shutdown the BoardReaderCore. More...
 
bool do_soft_initialize (fhicl::ParameterSet const &pset, uint64_t timeout, uint64_t timestamp) override
 Soft-Initialize the BoardReaderCore. More...
 
bool do_reinitialize (fhicl::ParameterSet const &pset, uint64_t timeout, uint64_t timestamp) override
 Reinitialize the BoardReaderCore. More...
 
void BootedEnter () override
 Action taken upon entering the "Booted" state. More...
 
bool do_meta_command (std::string const &command, std::string const &arg) override
 Perform a user-defined command (passed to CommandableFragmentGenerator) 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 BoardReaderCore. 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 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 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_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

BoardReaderApp is an artdaq::Commandable derived class which controls the BoardReaderCore state machine.

Definition at line 17 of file BoardReaderApp.hh.

Member Function Documentation

void artdaq::BoardReaderApp::BootedEnter ( )
overridevirtual

Action taken upon entering the "Booted" state.

This resets the BoardReaderCore pointer

Reimplemented from artdaq::Commandable.

Definition at line 182 of file BoardReaderApp.cc.

bool artdaq::BoardReaderApp::do_initialize ( fhicl::ParameterSet const &  pset,
uint64_t  timeout,
uint64_t  timestamp 
)
overridevirtual

Initialize the BoardReaderCore.

Parameters
psetParameterSet used to configure the BoardReaderCore
timeoutTimeout for transition
timestampTimestamp of transition
Returns
Whether the transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 14 of file BoardReaderApp.cc.

bool artdaq::BoardReaderApp::do_meta_command ( std::string const &  command,
std::string const &  arg 
)
overridevirtual

Perform a user-defined command (passed to CommandableFragmentGenerator)

Parameters
commandName of the command
argArgument for the command
Returns
Whether the command succeeded

Reimplemented from artdaq::Commandable.

Definition at line 193 of file BoardReaderApp.cc.

bool artdaq::BoardReaderApp::do_pause ( uint64_t  timeout,
uint64_t  timestamp 
)
overridevirtual

Pause the BoardReaderCore.

Parameters
timeoutTimeout for transition
timestampTimestamp of transition
Returns
Whether the transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 102 of file BoardReaderApp.cc.

bool artdaq::BoardReaderApp::do_reinitialize ( fhicl::ParameterSet const &  pset,
uint64_t  timeout,
uint64_t  timestamp 
)
overridevirtual

Reinitialize the BoardReaderCore.

Parameters
psetParameterSet used to configure the BoardReaderCore
timeoutTimeout for transition
timestampTimestamp of transition
Returns
Whether the transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 170 of file BoardReaderApp.cc.

bool artdaq::BoardReaderApp::do_resume ( uint64_t  timeout,
uint64_t  timestamp 
)
overridevirtual

Resume the BoardReaderCore.

Parameters
timeoutTimeout for transition
timestampTimestamp of transition
Returns
Whether the transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 121 of file BoardReaderApp.cc.

bool artdaq::BoardReaderApp::do_shutdown ( uint64_t  timeout)
overridevirtual

Shutdown the BoardReaderCore.

Parameters
timeoutTimeout for transition
Returns
Whether the transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 142 of file BoardReaderApp.cc.

bool artdaq::BoardReaderApp::do_soft_initialize ( fhicl::ParameterSet const &  pset,
uint64_t  timeout,
uint64_t  timestamp 
)
overridevirtual

Soft-Initialize the BoardReaderCore.

Parameters
psetParameterSet used to configure the BoardReaderCore
timeoutTimeout for transition
timestampTimestamp of transition
Returns
Whether the transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 157 of file BoardReaderApp.cc.

bool artdaq::BoardReaderApp::do_start ( art::RunID  id,
uint64_t  timeout,
uint64_t  timestamp 
)
overridevirtual

Start the BoardReaderCore.

Parameters
idRun ID of new run
timeoutTimeout for transition
timestampTimestamp of transition
Returns
Whether the transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 40 of file BoardReaderApp.cc.

bool artdaq::BoardReaderApp::do_stop ( uint64_t  timeout,
uint64_t  timestamp 
)
overridevirtual

Stop the BoardReaderCore.

Parameters
timeoutTimeout for transition
timestampTimestamp of transition
Returns
Whether the transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 76 of file BoardReaderApp.cc.

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

Copy Assignment Operator is deleted.

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

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

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

Reimplemented from artdaq::Commandable.

Definition at line 205 of file BoardReaderApp.cc.


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