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:
artdaq::Commandable

List of all members.

Public Member Functions

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

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:
rank The rank of the Aggregator
name The 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   
) [override, virtual]

Initialize the AggregatorCore.

Parameters:
pset ParameterSet 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   
) [override, virtual]

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   
) [override, virtual]

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   
) [override, virtual]

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   )  [override, virtual]

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   
) [override, virtual]

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   
) [override, virtual]

Start the AggregatorCore.

Parameters:
id Run 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   
) [override, virtual]

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

Copy Assignment operator is Deleted.

Returns:
AggregatorApp copy

Reimplemented from artdaq::Commandable.

std::string artdaq::AggregatorApp::register_monitor ( fhicl::ParameterSet const &  info  )  [override, virtual]

Register an art Online Monitor to the AggregatorCore.

Parameters:
info ParameterSet 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 [override, virtual]

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

Parameters:
which What 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  )  [override, virtual]

Remove an art Online Monitor from the AggregatorCore.

Parameters:
label Name 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:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator

Generated on 23 May 2017 for artdaq by  doxygen 1.6.1