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

List of all members.

Public Member Functions

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

Detailed Description

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

Definition at line 18 of file BoardReaderApp.hh.


Constructor & Destructor Documentation

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

BoardReaderApp Constructor.

Parameters:
rank Rank of this BoardReader
name Friendly name of this application instance (MessageFacility Category)

Definition at line 3 of file BoardReaderApp.cc.


Member Function Documentation

void artdaq::BoardReaderApp::BootedEnter (  )  [override, virtual]

Action taken upon entering the "Booted" state.

This resets the BoardReaderCore pointer

Reimplemented from artdaq::Commandable.

Definition at line 154 of file BoardReaderApp.cc.

bool artdaq::BoardReaderApp::do_initialize ( fhicl::ParameterSet const &  pset,
uint64_t  timeout,
uint64_t  timestamp 
) [override, virtual]

Initialize the BoardReaderCore.

Parameters:
pset ParameterSet used to configure the BoardReaderCore
timeout Timeout for transition
timestamp Timestamp of transition
Returns:
Whether the transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 11 of file BoardReaderApp.cc.

bool artdaq::BoardReaderApp::do_pause ( uint64_t  timeout,
uint64_t  timestamp 
) [override, virtual]

Pause the BoardReaderCore.

Parameters:
timeout Timeout for transition
timestamp Timestamp of transition
Returns:
Whether the transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 79 of file BoardReaderApp.cc.

bool artdaq::BoardReaderApp::do_reinitialize ( fhicl::ParameterSet const &  pset,
uint64_t  timeout,
uint64_t  timestamp 
) [override, virtual]

Reinitialize the BoardReaderCore.

Parameters:
pset ParameterSet used to configure the BoardReaderCore
timeout Timeout for transition
timestamp Timestamp of transition
Returns:
Whether the transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 142 of file BoardReaderApp.cc.

bool artdaq::BoardReaderApp::do_resume ( uint64_t  timeout,
uint64_t  timestamp 
) [override, virtual]

Resume the BoardReaderCore.

Parameters:
timeout Timeout for transition
timestamp Timestamp of transition
Returns:
Whether the transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 100 of file BoardReaderApp.cc.

bool artdaq::BoardReaderApp::do_shutdown ( uint64_t  timeout  )  [override, virtual]

Shutdown the BoardReaderCore.

Parameters:
timeout Timeout for transition
Returns:
Whether the transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 117 of file BoardReaderApp.cc.

bool artdaq::BoardReaderApp::do_soft_initialize ( fhicl::ParameterSet const &  pset,
uint64_t  timeout,
uint64_t  timestamp 
) [override, virtual]

Soft-Initialize the BoardReaderCore.

Parameters:
pset ParameterSet used to configure the BoardReaderCore
timeout Timeout for transition
timestamp Timestamp of transition
Returns:
Whether the transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 129 of file BoardReaderApp.cc.

bool artdaq::BoardReaderApp::do_start ( art::RunID  id,
uint64_t  timeout,
uint64_t  timestamp 
) [override, virtual]

Start the BoardReaderCore.

Parameters:
id Run ID of new run
timeout Timeout for transition
timestamp Timestamp of transition
Returns:
Whether the transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 33 of file BoardReaderApp.cc.

bool artdaq::BoardReaderApp::do_stop ( uint64_t  timeout,
uint64_t  timestamp 
) [override, virtual]

Stop the BoardReaderCore.

Parameters:
timeout Timeout for transition
timestamp Timestamp of transition
Returns:
Whether the transition succeeded

Reimplemented from artdaq::Commandable.

Definition at line 57 of file BoardReaderApp.cc.

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

Copy Assignment Operator is deleted.

Returns:
BoardReaderApp copy

Reimplemented from artdaq::Commandable.

std::string artdaq::BoardReaderApp::report ( std::string const &  which  )  const [override, virtual]

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

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

Reimplemented from artdaq::Commandable.

Definition at line 165 of file BoardReaderApp.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