#include <DeviceInfo.h>

Public Attributes
pid_t	pid
	The pid of the device associated to this device.

int	exitStatus = -1

size_t	historyPos
	The position inside the history circular buffer of this device.

size_t	historySize
	The size of the history circular buffer.

LogParsingHelpers::LogLevel	maxLogLevel
	The maximum log level ever seen by this device.

LogParsingHelpers::LogLevel	logLevel {LogParsingHelpers::LogLevel::Info}
	The minimum log level for log messages sent/displayed by this device.

LogParsingHelpers::LogLevel	minFailureLevel
	The minimum level after which the device will exit with 0.

std::vector< std::string >	history

std::vector< LogParsingHelpers::LogLevel >	historyLevel

std::string	firstSevereError

std::string	lastError

std::string	unprinted
	An unterminated string which is not ready to be printed yet.

bool	active
	Whether the device is active (running) or not.

bool	readyToQuit = false
	Whether the device is ready to quit.

StreamingState	streamingState = StreamingState::Streaming
	The current state of the device, as reported by it.

std::string	deviceState

Metric2DViewIndex	inputChannelMetricsViewIndex

Metric2DViewIndex	outputChannelMetricsViewIndex

boost::property_tree::ptree	currentConfig
	Current configuration for the device.

boost::property_tree::ptree	currentProvenance
	Current provenance for the configuration keys.

size_t	lastSignal
	Timestamp of the last signal received.

int	providedState = 0
	An incremental number for the state of the device.

Detailed Description

This struct holds information about a given device as known by the driver. Due to the distributed nature of O2, you should not assume that the updates to this struct are a reflection of the current state of the device, merely the last known state.

Definition at line 34 of file DeviceInfo.h.

Member Data Documentation

◆ active

bool o2::framework::DeviceInfo::active

Whether the device is active (running) or not.

Definition at line 65 of file DeviceInfo.h.

◆ currentConfig

boost::property_tree::ptree o2::framework::DeviceInfo::currentConfig

Current configuration for the device.

Definition at line 82 of file DeviceInfo.h.

◆ currentProvenance

boost::property_tree::ptree o2::framework::DeviceInfo::currentProvenance

Current provenance for the configuration keys.

Definition at line 84 of file DeviceInfo.h.

◆ deviceState

std::string o2::framework::DeviceInfo::deviceState

The current state of the device, as reported by it Use fair::mq::GetState() to have the enum value.

Returns: a string from one of fair::mq::GetStateName

Definition at line 73 of file DeviceInfo.h.

◆ exitStatus

int o2::framework::DeviceInfo::exitStatus = -1

The exit status of the device, if not running. Notice that -1 means that no exit status was set, since the actual values which will be seen by the parent are guaranteed to be between 0 and 255.

Definition at line 41 of file DeviceInfo.h.

◆ firstSevereError

std::string o2::framework::DeviceInfo::firstSevereError

Definition at line 60 of file DeviceInfo.h.

◆ history

std::vector<std::string> o2::framework::DeviceInfo::history

A circular buffer for the history of logs entries received by this device

Definition at line 56 of file DeviceInfo.h.

◆ historyLevel

std::vector<LogParsingHelpers::LogLevel> o2::framework::DeviceInfo::historyLevel

A circular buffer for the severity of each of the entries in the circular buffer associated to the device.

Definition at line 59 of file DeviceInfo.h.

◆ historyPos

size_t o2::framework::DeviceInfo::historyPos

The position inside the history circular buffer of this device.

Definition at line 43 of file DeviceInfo.h.

◆ historySize

size_t o2::framework::DeviceInfo::historySize

The size of the history circular buffer.

Definition at line 45 of file DeviceInfo.h.

◆ inputChannelMetricsViewIndex

Metric2DViewIndex o2::framework::DeviceInfo::inputChannelMetricsViewIndex

Index for the metrics to be displayed associated to each input channel of the device.

Definition at line 76 of file DeviceInfo.h.

◆ lastError

std::string o2::framework::DeviceInfo::lastError

Definition at line 61 of file DeviceInfo.h.

◆ lastSignal

size_t o2::framework::DeviceInfo::lastSignal

Timestamp of the last signal received.

Definition at line 86 of file DeviceInfo.h.

◆ logLevel

LogParsingHelpers::LogLevel o2::framework::DeviceInfo::logLevel {LogParsingHelpers::LogLevel::Info}

The minimum log level for log messages sent/displayed by this device.

Definition at line 49 of file DeviceInfo.h.

◆ maxLogLevel

LogParsingHelpers::LogLevel o2::framework::DeviceInfo::maxLogLevel

The maximum log level ever seen by this device.

Definition at line 47 of file DeviceInfo.h.

◆ minFailureLevel

LogParsingHelpers::LogLevel o2::framework::DeviceInfo::minFailureLevel

The minimum level after which the device will exit with 0.

Definition at line 52 of file DeviceInfo.h.

◆ outputChannelMetricsViewIndex

Metric2DViewIndex o2::framework::DeviceInfo::outputChannelMetricsViewIndex

Index for the metrics to be displayed associated to each input channel of the device.

Definition at line 79 of file DeviceInfo.h.

◆ pid

pid_t o2::framework::DeviceInfo::pid

The pid of the device associated to this device.

Definition at line 36 of file DeviceInfo.h.

◆ providedState

int o2::framework::DeviceInfo::providedState = 0

An incremental number for the state of the device.

Definition at line 88 of file DeviceInfo.h.

◆ readyToQuit

bool o2::framework::DeviceInfo::readyToQuit = false

Whether the device is ready to quit.

Definition at line 67 of file DeviceInfo.h.

◆ streamingState

StreamingState o2::framework::DeviceInfo::streamingState = StreamingState::Streaming

The current state of the device, as reported by it.

Definition at line 69 of file DeviceInfo.h.

◆ unprinted

std::string o2::framework::DeviceInfo::unprinted

An unterminated string which is not ready to be printed yet.

Definition at line 63 of file DeviceInfo.h.

The documentation for this struct was generated from the following file:

/home/runner/work/AliceO2/AliceO2/Framework/Core/include/Framework/DeviceInfo.h

Public Attributes