artdaq  v3_02_00
artdaq::EventBuilderApp Class Reference

EventBuilderApp is an artdaq::Commandable derived class which controls the EventBuilderCore. More...

#include <artdaq/Application/EventBuilderApp.hh>

Inheritance diagram for artdaq::EventBuilderApp:
artdaq::Commandable

Public Member Functions

 EventBuilderApp ()
 EventBuilderApp Constructor.
 
 EventBuilderApp (EventBuilderApp const &)=delete
 Copy Constructor is deleted.
 
virtual ~EventBuilderApp ()=default
 Default Destructor.
 
EventBuilderAppoperator= (EventBuilderApp const &)=delete
 Copy Assignment Operator is deleted. More...
 
bool do_initialize (fhicl::ParameterSet const &pset, uint64_t, uint64_t) override
 Initialize the EventBuilderCore. More...
 
bool do_start (art::RunID id, uint64_t, uint64_t) override
 Start the EventBuilderCore. More...
 
bool do_stop (uint64_t, uint64_t) override
 Stop the EventBuilderCore. More...
 
bool do_pause (uint64_t, uint64_t) override
 Pause the EventBuilderCore. More...
 
bool do_resume (uint64_t, uint64_t) override
 Resume the EventBuilderCore. More...
 
bool do_shutdown (uint64_t) override
 Shutdown the EventBuilderCore. More...
 
bool do_soft_initialize (fhicl::ParameterSet const &pset, uint64_t, uint64_t) override
 Soft-Initialize the EventBuilderCore. More...
 
bool do_reinitialize (fhicl::ParameterSet const &pset, uint64_t, uint64_t) override
 Reinitialize the EventBuilderCore. More...
 
bool do_rollover_subrun (uint64_t eventNum) override
 Rollover the subrun after the given event. More...
 
void BootedEnter () override
 Action taken upon entering the "Booted" state. 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 EventBuilderCore. 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 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

EventBuilderApp is an artdaq::Commandable derived class which controls the EventBuilderCore.

Definition at line 17 of file EventBuilderApp.hh.

Member Function Documentation

void artdaq::EventBuilderApp::BootedEnter ( )
overridevirtual

Action taken upon entering the "Booted" state.

This is a No-Op

Reimplemented from artdaq::Commandable.

Definition at line 145 of file EventBuilderApp.cc.

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

Initialize the EventBuilderCore.

Parameters
psetParameterSet used to configure the EventBuilderCore
Returns
Whether the transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 14 of file EventBuilderApp.cc.

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

Pause the EventBuilderCore.

Returns
Whether the transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 67 of file EventBuilderApp.cc.

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

Reinitialize the EventBuilderCore.

Parameters
psetParameterSet used to configure the EventBuilderCore
Returns
Whether the transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 118 of file EventBuilderApp.cc.

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

Resume the EventBuilderCore.

Returns
Whether the transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 80 of file EventBuilderApp.cc.

bool artdaq::EventBuilderApp::do_rollover_subrun ( uint64_t  eventNum)
overridevirtual

Rollover the subrun after the given event.

Parameters
eventNumSequence ID of boundary

Reimplemented from artdaq::Commandable.

Definition at line 131 of file EventBuilderApp.cc.

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

Shutdown the EventBuilderCore.

Returns
Whether the transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 93 of file EventBuilderApp.cc.

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

Soft-Initialize the EventBuilderCore.

Parameters
psetParameterSet used to configure the EventBuilderCore
Returns
Whether the transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 105 of file EventBuilderApp.cc.

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

Start the EventBuilderCore.

Parameters
idRun ID of new run
Returns
Whether the transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 39 of file EventBuilderApp.cc.

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

Stop the EventBuilderCore.

Returns
Whether the transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 55 of file EventBuilderApp.cc.

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

Copy Assignment Operator is deleted.

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

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

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

Reimplemented from artdaq::Commandable.

Definition at line 156 of file EventBuilderApp.cc.


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