Class StatApplicationManager

Defined in File StatApplicationManager.h

Inheritance Relationships

Base Type

public ska::pst::common::ApplicationManager (Class ApplicationManager)

Class Documentation

class StatApplicationManager : public ska::pst::common::ApplicationManager 

Manager for running SKA PST STAT within a pipeline.

Public Types

enum ProcessingState

Enumeration of statistics processor’s state.

Values:

enumerator Unknown

enumerator Idle

enumerator Processing

enumerator Waiting

Public Functions

StatApplicationManager(std::string base_path)

Create instance of a Stat Application Manager object.

Parameters: base_path – directory to which stat hdf5 files will be written.

~StatApplicationManager(): Destroy the Stat Application Manager object.

inline std::string get_stat_base_path()

Get the base path the StatApplicationManager is constructed with.

Returns: std::string filesystem base path to where files will be written

void configure_from_file(const std::string &config_file)

Configure beam and scan as described by the configuration file.

Parameters: config_file – configuration file containing beam and scan configuration parameters

virtual void validate_configure_beam(const ska::pst::common::AsciiHeader &config, ska::pst::common::ValidationContext *context) override

Configure beam as described by the configuration parameters.

Parameters

config – beam configuration containing the recording path, data and weights key
context – A validation context where errors should be added.

virtual void validate_configure_scan(const ska::pst::common::AsciiHeader &config, ska::pst::common::ValidationContext *context) override

Configure scan as described by the configuration parameters.

Parameters

config – scan configuration containing the bytes_per_second and scan_len_max
context – A validation context where errors should be added.

virtual void validate_start_scan(const ska::pst::common::AsciiHeader &config) override

Start scan as described by the configuration parameters.

Parameters: config – start scan configuration

virtual void perform_initialise() override: Initialisation callback.

virtual void perform_configure_beam() override: Beam Configuration callback that is called by ska::pst::common::ApplicationManager::main. Contains the instructions required prior to transitioning the state from Idle to BeamConfigured.

virtual void perform_configure_scan() override: Scan Configuration callback that is called by ska::pst::common::ApplicationManager::main. Contains the instructions required prior to transitioning the state from BeamConfigured to ScanConfigured.

virtual void perform_start_scan() override: StartScan callback that is called by ska::pst::common::ApplicationManager::main. Contains the instructions required prior to transitioning the state from ScanConfigured to Scanning. Launches perform_scan on a separate thread.

virtual void perform_scan() override: Scan callback that is called by ska::pst::common::ApplicationManager::main. Contains scanning instructions meant to be launched in a separate thread.

virtual void perform_stop_scan() override: StopScan callback that is called by ska::pst::common::ApplicationManager::main. Contains the instructions required prior to transitioning the state from Scanning to ScanConfigured.

virtual void perform_deconfigure_scan() override: DeconfigureScan callback that is called by ska::pst::common::ApplicationManager::main. Contains the instructions required prior to transitioning the state from ScanConfigured to BeamConfigured.

virtual void perform_deconfigure_beam() override: DeconfigureBeam callback that is called by ska::pst::common::ApplicationManager::main. Contains the instructions required prior to transitioning the state from BeamConfigured to Idle.

virtual void perform_terminate() override: Terminate callback that is called by ska::pst::common::ApplicationManager::main. Contains the instructions required prior to transitioning the state from RuntimeError to Idle.

inline void set_timeout(int _timeout): Set the timeout for connecting to the DataBlockView object.

StatStorage::scalar_stats_t get_scalar_stats()

Get the scalar stats object.

Returns: StatStorage::scalar_stats_t

inline ProcessingState get_processing_state()

Get the processing state of the application manager.

Returns: State processing state of the application manager