Tomographer  v5.4
Tomographer C++ Framework Documentation
Tomographer::Tools::StatusProvider< StatusableObject_ > Struct Template Reference

Template, specializable class to provide status reports for different objects. More...

#include <tomographer/tools/statusprovider.h>

Public Types

typedef StatusableObject_ StatusableObject
 

Static Public Member Functions

static std::string getStatusLine (const StatusableObject *)
 Prepare a short status message which reports the status of the given object. More...
 

Static Public Attributes

static constexpr bool CanProvideStatusLine = false
 

Detailed Description

template<typename StatusableObject_>
struct Tomographer::Tools::StatusProvider< StatusableObject_ >

Template, specializable class to provide status reports for different objects.

Specialize this class for your stats collector to be able to provide a short status report. Just provide 2-3 lines with the most important information enough to provide a very basic overview, not a full-length report.

This is used for stats collectors and for mhwalker params adjusters.

Definition at line 50 of file statusprovider.h.

Member Function Documentation

§ getStatusLine()

template<typename StatusableObject_ >
static std::string Tomographer::Tools::StatusProvider< StatusableObject_ >::getStatusLine ( const StatusableObject *  )
inlinestatic

Prepare a short status message which reports the status of the given object.

Don't end your string with a newline.

The message should be one line, or few lines at most. It should be suited for printing in a terminal in a brief status report.

Definition at line 63 of file statusprovider.h.


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