State for the main GUI window. More...

Classes
struct	AllMetricsStore

struct	ChannelsTableHelper

struct	ColumnInfo

struct	DeviceGUIState
	State for the Device specific inspector. More...

struct	Group

struct	HeatMapHelper

struct	HistoData

struct	MetricDisplayState

struct	MetricIndex

struct	MetricLabelsContext
	Context to draw the labels with the metrics. More...

struct	MetricsPainter
	Helper to draw metrics. More...

struct	MultiplotData

struct	Node

struct	NodeColor

struct	NodeLink

struct	NodePos

struct	OldestPossibleInput

struct	OldestPossibleOutput

struct	TopologyNodeInfo
	Information associated to a node in the topology. More...

struct	WorkspaceGUIState
	State for the workspace. More...

Typedefs
using	LogLevel = LogParsingHelpers::LogLevel

Enumerations
enum struct	MetricsDisplayStyle : int { Lines = 0 , Histos = 1 , Sparks = 2 , Table = 3 , Stems = 4 }

enum	MetricTypes { DEVICE_METRICS = 0 , DRIVER_METRICS , TOTAL_TYPES_OF_METRICS }

Functions
void	displayDataRelayer (DeviceMetricsInfo const &metrics, DeviceInfo const &info, DeviceSpec const &spec, DataProcessingStates const &, ImVec2 const &size)
	View of the DataRelayer metrics for a given DeviceInfo.

ImVec4	colorForLogLevel (LogParsingHelpers::LogLevel logLevel)

void	displayHistory (const DeviceInfo &info, DeviceControl &control)

void	displaySparks (double startTime, std::vector< MetricIndex > &visibleMetricsIndex, std::vector< MetricDisplayState > &metricDisplayStates, AllMetricsStore const &metricStore)

int	formatSI (double value, char buff, int size, void user_data)

int	formatTimeSinceStart (double value, char buff, int size, void user_data)

void	displayDeviceMetrics (const char *label, size_t rangeBegin, size_t rangeEnd, size_t bins, MetricsDisplayStyle displayType, std::vector< MetricDisplayState > &state, AllMetricsStore const &metricStore, DriverInfo const &driverInfo)

void	metricsTableRow (std::vector< MetricIndex > metricIndex, AllMetricsStore const &metricsStore, int row)

bool	hasAll (const char s, const char q)

void	TextCenter (char const *text)

void	displayMetrics (gui::WorkspaceGUIState &state, DriverInfo const &driverInfo, std::vector< DeviceInfo > const &infos, std::vector< DataProcessorInfo > const &metadata, std::vector< DeviceControl > &controls, AllMetricsStore const &metricsStore)

void	pushWindowColorDueToStatus (const DeviceInfo &info)

void	popWindowColorDueToStatus ()

void	displayDriverInfo (DriverInfo const &driverInfo, DriverControl &driverControl)

std::function< void(void)>	getGUIDebugger (std::vector< DeviceInfo > const &infos, std::vector< DeviceSpec > const &devices, std::vector< DataProcessingStates > const &allStates, std::vector< DataProcessorInfo > const &metadata, std::vector< DeviceMetricsInfo > const &metricsInfos, DriverInfo const &driverInfo, std::vector< DeviceControl > &controls, DriverControl &driverControl)
	Helper to get the callback to draw the debug GUI.

void	updateMousePos (float x, float y)

void	updateMouseButton (bool clicked)

void	updateMouseWheel (int direction)

void	updateWindowSize (int x, int y)

void	keyEvent (char key, bool down)

void	charIn (char key)

void	deviceStateTable (DataProcessingStates const &states)

void	deviceInfoTable (char const *label, ProcessingStateId id, DataProcessingStates const &states, std::variant< std::vector< InputRoute >, std::vector< OutputRoute > > routes, DeviceMetricsInfo const &metrics)

void	configurationTable (boost::property_tree::ptree const &currentConfig, boost::property_tree::ptree const &currentProvenance)

void	optionsTable (const char *label, std::vector< ConfigParamSpec > const &options, const DeviceControl &control)

void	servicesTable (const char *label, std::vector< ServiceSpec > const &services)

void	displayDeviceInspector (DeviceSpec const &spec, DeviceInfo const &info, DataProcessingStates const &states, DeviceMetricsInfo const &metrics, DataProcessorInfo const &metadata, DeviceControl &control)
	Helper to display information about a device.

NodeColor	decideColorForNode (const DeviceInfo &info)

const ImVec2	NODE_WINDOW_PADDING (8.0f, 8.0f)

void	displayGrid (bool show_grid, ImVec2 offset, ImDrawList *draw_list)
	Displays a grid.

void	displayLegend (bool show_legend, ImVec2 offset, ImDrawList *draw_list)

void	showTopologyNodeGraph (WorkspaceGUIState &state, std::vector< DeviceInfo > const &infos, std::vector< DeviceSpec > const &specs, std::vector< DataProcessingStates > const &allStates, std::vector< DataProcessorInfo > const &metadata, std::vector< DeviceControl > &controls, std::vector< DeviceMetricsInfo > const &metricsInfos)

Variables
const float	NODE_SLOT_RADIUS = 4.0f
	Node size.

constexpr int	MAX_SLOTS = 512

constexpr int	MAX_INPUT_VALUE_SIZE = 24

Detailed Description

State for the main GUI window.

Typedef Documentation

◆ LogLevel

using o2::framework::gui::LogLevel = typedef LogParsingHelpers::LogLevel

Definition at line 42 of file FrameworkGUIDevicesGraph.cxx.

Enumeration Type Documentation

◆ MetricsDisplayStyle

enum struct o2::framework::gui::MetricsDisplayStyle : int

strong

Enumerator
Lines
Histos
Sparks
Table
Stems

Definition at line 171 of file FrameworkGUIDebugger.cxx.

◆ MetricTypes

enum o2::framework::gui::MetricTypes

Enumerator
DEVICE_METRICS
DRIVER_METRICS
TOTAL_TYPES_OF_METRICS

Definition at line 199 of file FrameworkGUIDebugger.cxx.

Function Documentation

◆ charIn()

void o2::framework::gui::charIn ( char key )

Definition at line 1288 of file FrameworkGUIDebugger.cxx.

◆ colorForLogLevel()

ImVec4 o2::framework::gui::colorForLogLevel ( LogParsingHelpers::LogLevel logLevel )

Definition at line 67 of file FrameworkGUIDebugger.cxx.

◆ configurationTable()

void o2::framework::gui::configurationTable	(	boost::property_tree::ptree const &	currentConfig,
		boost::property_tree::ptree const &	currentProvenance
	)

Definition at line 117 of file FrameworkGUIDeviceInspector.cxx.

◆ decideColorForNode()

NodeColor o2::framework::gui::decideColorForNode ( const DeviceInfo & info )

Definition at line 44 of file FrameworkGUIDevicesGraph.cxx.

◆ deviceInfoTable()

void o2::framework::gui::deviceInfoTable	(	char const *	label,
		ProcessingStateId	id,
		DataProcessingStates const &	states,
		std::variant< std::vector< InputRoute >, std::vector< OutputRoute > >	routes,
		DeviceMetricsInfo const &	metrics
	)

Definition at line 82 of file FrameworkGUIDeviceInspector.cxx.

◆ deviceStateTable()

void o2::framework::gui::deviceStateTable ( DataProcessingStates const & states )

Definition at line 56 of file FrameworkGUIDeviceInspector.cxx.

◆ displayDataRelayer()

void o2::framework::gui::displayDataRelayer	(	DeviceMetricsInfo const &	metrics,
		DeviceInfo const &	info,
		DeviceSpec const &	spec,
		DataProcessingStates const &	states,
		ImVec2 const &	size
	)

View of the DataRelayer metrics for a given DeviceInfo.

Definition at line 101 of file FrameworkGUIDataRelayerUsage.cxx.

◆ displayDeviceInspector()

void o2::framework::gui::displayDeviceInspector	(	DeviceSpec const &	spec,
		DeviceInfo const &	info,
		DataProcessingStates const &	states,
		DeviceMetricsInfo const &	metrics,
		DataProcessorInfo const &	metadata,
		DeviceControl &	control
	)

Helper to display information about a device.

Definition at line 258 of file FrameworkGUIDeviceInspector.cxx.

◆ displayDeviceMetrics()

void o2::framework::gui::displayDeviceMetrics	(	const char *	label,
		size_t	rangeBegin,
		size_t	rangeEnd,
		size_t	bins,
		MetricsDisplayStyle	displayType,
		std::vector< MetricDisplayState > &	state,
		AllMetricsStore const &	metricStore,
		DriverInfo const &	driverInfo
	)

Definition at line 352 of file FrameworkGUIDebugger.cxx.

◆ displayDriverInfo()

void o2::framework::gui::displayDriverInfo	(	DriverInfo const &	driverInfo,
		DriverControl &	driverControl
	)

Display information window about the driver and its state.

Definition at line 1011 of file FrameworkGUIDebugger.cxx.

◆ displayGrid()

void o2::framework::gui::displayGrid	(	bool	show_grid,
		ImVec2	offset,
		ImDrawList *	draw_list
	)

Displays a grid.

Definition at line 107 of file FrameworkGUIDevicesGraph.cxx.

◆ displayHistory()

void o2::framework::gui::displayHistory	(	const DeviceInfo &	info,
		DeviceControl &	control
	)

Definition at line 89 of file FrameworkGUIDebugger.cxx.

◆ displayLegend()

void o2::framework::gui::displayLegend	(	bool	show_legend,
		ImVec2	offset,
		ImDrawList *	draw_list
	)

Definition at line 122 of file FrameworkGUIDevicesGraph.cxx.

◆ displayMetrics()

void o2::framework::gui::displayMetrics	(	gui::WorkspaceGUIState &	state,
		DriverInfo const &	driverInfo,
		std::vector< DeviceInfo > const &	infos,
		std::vector< DataProcessorInfo > const &	metadata,
		std::vector< DeviceControl > &	controls,
		AllMetricsStore const &	metricsStore
	)

Calculate the size of all the metrics for a given device

Definition at line 621 of file FrameworkGUIDebugger.cxx.

◆ displaySparks()

void o2::framework::gui::displaySparks	(	double	startTime,
		std::vector< MetricIndex > &	visibleMetricsIndex,
		std::vector< MetricDisplayState > &	metricDisplayStates,
		AllMetricsStore const &	metricStore
	)

Definition at line 213 of file FrameworkGUIDebugger.cxx.

◆ formatSI()

int o2::framework::gui::formatSI	(	double	value,
		char *	buff,
		int	size,
		void *	user_data
	)

Definition at line 317 of file FrameworkGUIDebugger.cxx.

◆ formatTimeSinceStart()

int o2::framework::gui::formatTimeSinceStart	(	double	value,
		char *	buff,
		int	size,
		void *	user_data
	)

Definition at line 340 of file FrameworkGUIDebugger.cxx.

◆ getGUIDebugger()

std::function< void(void)> o2::framework::gui::getGUIDebugger	(	std::vector< DeviceInfo > const &	infos,
		std::vector< DeviceSpec > const &	devices,
		std::vector< DataProcessingStates > const &	allStates,
		std::vector< DataProcessorInfo > const &	metadata,
		std::vector< DeviceMetricsInfo > const &	metricsInfos,
		DriverInfo const &	driverInfo,
		std::vector< DeviceControl > &	controls,
		DriverControl &	driverControl
	)

Helper to get the callback to draw the debug GUI.

Definition at line 1115 of file FrameworkGUIDebugger.cxx.

◆ hasAll()

bool o2::framework::gui::hasAll	(	const char *	s,
		const char *	q
	)

Definition at line 593 of file FrameworkGUIDebugger.cxx.

◆ keyEvent()

void o2::framework::gui::keyEvent	(	char	key,
		bool	down
	)

Definition at line 1240 of file FrameworkGUIDebugger.cxx.

◆ metricsTableRow()

void o2::framework::gui::metricsTableRow	(	std::vector< MetricIndex >	metricIndex,
		AllMetricsStore const &	metricsStore,
		int	row
	)

Definition at line 549 of file FrameworkGUIDebugger.cxx.

◆ NODE_WINDOW_PADDING()

const ImVec2 o2::framework::gui::NODE_WINDOW_PADDING	(	8.	0f,
		8.	0f
	)

◆ optionsTable()

void o2::framework::gui::optionsTable	(	const char *	label,
		std::vector< ConfigParamSpec > const &	options,
		const DeviceControl &	control
	)

Definition at line 150 of file FrameworkGUIDeviceInspector.cxx.

◆ popWindowColorDueToStatus()

void o2::framework::gui::popWindowColorDueToStatus ( )

Definition at line 1003 of file FrameworkGUIDebugger.cxx.

◆ pushWindowColorDueToStatus()

void o2::framework::gui::pushWindowColorDueToStatus ( const DeviceInfo & info )

Definition at line 969 of file FrameworkGUIDebugger.cxx.

◆ servicesTable()

void o2::framework::gui::servicesTable	(	const char *	label,
		std::vector< ServiceSpec > const &	services
	)

Definition at line 219 of file FrameworkGUIDeviceInspector.cxx.

◆ showTopologyNodeGraph()

void o2::framework::gui::showTopologyNodeGraph	(	WorkspaceGUIState &	state,
		std::vector< DeviceInfo > const &	infos,
		std::vector< DeviceSpec > const &	specs,
		std::vector< DataProcessingStates > const &	allStates,
		std::vector< DataProcessorInfo > const &	metadata,
		std::vector< DeviceControl > &	controls,
		std::vector< DeviceMetricsInfo > const &	metricsInfos
	)

We resort them again, this time with the added layer information

Paint the input labels

Definition at line 362 of file FrameworkGUIDevicesGraph.cxx.

◆ TextCenter()

void o2::framework::gui::TextCenter ( char const * text )

Definition at line 610 of file FrameworkGUIDebugger.cxx.

◆ updateMouseButton()

void o2::framework::gui::updateMouseButton ( bool clicked )

Definition at line 1218 of file FrameworkGUIDebugger.cxx.

◆ updateMousePos()

void o2::framework::gui::updateMousePos	(	float	x,
		float	y
	)

Definition at line 1212 of file FrameworkGUIDebugger.cxx.

◆ updateMouseWheel()

void o2::framework::gui::updateMouseWheel ( int direction )

Definition at line 1224 of file FrameworkGUIDebugger.cxx.

◆ updateWindowSize()

void o2::framework::gui::updateWindowSize	(	int	x,
		int	y
	)

Definition at line 1234 of file FrameworkGUIDebugger.cxx.

Variable Documentation

◆ MAX_INPUT_VALUE_SIZE

constexpr int o2::framework::gui::MAX_INPUT_VALUE_SIZE = 24

constexpr

Definition at line 173 of file FrameworkGUIDevicesGraph.cxx.

◆ MAX_SLOTS

constexpr int o2::framework::gui::MAX_SLOTS = 512