artdaq  v2_03_00
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Pages
Public Member Functions | List of all members
artdaq::AggregatorApp Class Reference

AggregatorApp is an artdaq::Commandable derived class which controls the AggregatorCore. More...

#include <artdaq/Application/AggregatorApp.hh>

+ Inheritance diagram for artdaq::AggregatorApp:

Public Member Functions

 AggregatorApp (int rank, std::string name)
 AggregatorApp Constructor. More...
 
 AggregatorApp (AggregatorApp const &)=delete
 Copy Constructor is Deleted.
 
virtual ~AggregatorApp ()=default
 Default virtual destructor.
 
AggregatorAppoperator= (AggregatorApp const &)=delete
 Copy Assignment operator is Deleted. More...
 
bool do_initialize (fhicl::ParameterSet const &pset, uint64_t, uint64_t) override
 Initialize the AggregatorCore. More...
 
bool do_start (art::RunID id, uint64_t, uint64_t) override
 Start the AggregatorCore. More...
 
bool do_stop (uint64_t, uint64_t) override
 Stop the AggregatorCore. More...
 
bool do_pause (uint64_t, uint64_t) override
 Pause the AggregatorCore. More...
 
bool do_resume (uint64_t, uint64_t) override
 Resume the AggregatorCore. More...
 
bool do_shutdown (uint64_t) override
 Shutdown the AggregatorCore. More...
 
bool do_soft_initialize (fhicl::ParameterSet const &, uint64_t, uint64_t) override
 Soft-initialize the AggregatorCore. No-Op. More...
 
bool do_reinitialize (fhicl::ParameterSet const &, uint64_t, uint64_t) override
 Reinitialize the AggregatorCore. 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 AggregatorCore. More...
 
std::string register_monitor (fhicl::ParameterSet const &info) override
 Register an art Online Monitor to the AggregatorCore. More...
 
std::string unregister_monitor (std::string const &label) override
 Remove an art Online Monitor from the AggregatorCore. 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 bool reset_stats (std::string const &which)
 Virutal function which resets statistics. 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...
 

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

AggregatorApp is an artdaq::Commandable derived class which controls the AggregatorCore.

Definition at line 17 of file AggregatorApp.hh.

Constructor & Destructor Documentation

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

AggregatorApp Constructor.

Parameters
rankThe rank of the Aggregator
nameThe nickname of the Aggregator

Definition at line 7 of file AggregatorApp.cc.

Member Function Documentation

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

Initialize the AggregatorCore.

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

Reimplemented from artdaq::Commandable.

Definition at line 16 of file AggregatorApp.cc.

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

Pause the AggregatorCore.

Returns
Whether the pause transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 73 of file AggregatorApp.cc.

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

Reinitialize the AggregatorCore. No-Op.

Returns
This function always returns true

Reimplemented from artdaq::Commandable.

Definition at line 125 of file AggregatorApp.cc.

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

Resume the AggregatorCore.

Returns
Whether the resume transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 90 of file AggregatorApp.cc.

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

Shutdown the AggregatorCore.

Returns
Whether the shutdown transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 107 of file AggregatorApp.cc.

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

Soft-initialize the AggregatorCore. No-Op.

Returns
This function always returns true

Reimplemented from artdaq::Commandable.

Definition at line 120 of file AggregatorApp.cc.

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

Start the AggregatorCore.

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

Reimplemented from artdaq::Commandable.

Definition at line 36 of file AggregatorApp.cc.

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

Stop the AggregatorCore.

Returns
Whether the stop transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 56 of file AggregatorApp.cc.

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

Copy Assignment operator is Deleted.

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

Register an art Online Monitor to the AggregatorCore.

Parameters
infoParameterSet containing information about the monitor
Returns
String detailing result status

Reimplemented from artdaq::Commandable.

Definition at line 163 of file AggregatorApp.cc.

std::string artdaq::AggregatorApp::report ( std::string const &  which) const
overridevirtual

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

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

Reimplemented from artdaq::Commandable.

Definition at line 130 of file AggregatorApp.cc.

std::string artdaq::AggregatorApp::unregister_monitor ( std::string const &  label)
overridevirtual

Remove an art Online Monitor from the AggregatorCore.

Parameters
labelName of the monitor to remove
Returns
String detailing result status

Reimplemented from artdaq::Commandable.

Definition at line 188 of file AggregatorApp.cc.


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