NullProgressReporter Class Reference

ProgressReporter that discards everything reported to it. More...

#include <progressreporter.h>

Inheritance diagram for NullProgressReporter:

Collaboration diagram for NullProgressReporter:

Public Member Functions
void	AppendPoint (const double &, const double &, int) override
	Adds a point to one of the progress charts.
void	SetProgress (const double &) override
	Sets the primary progress fraction.
void	SetProgress2 (const double &) override
	Sets the secondary progress fraction, where one is displayed.
void	SetLabel (const QString &) override
	Sets the free-text status label.
void	SetYRange (const double &, const double &, int) override
	Sets the vertical range of a chart.
void	SetXRange (const double &, const double &, int) override
	Sets the horizontal range of a chart.
void	SetTitle (const QString &, int) override
	Sets the title of a chart.
void	SetXAxisTitle (const QString &, int) override
	Sets the horizontal axis title of a chart.
void	SetYAxisTitle (const QString &, int) override
	Sets the vertical axis title of a chart.
void	ClearGraph (int) override
	Discards the points accumulated in a chart.
void	SetChartTitle (int, const QString &) override
	Sets the title of chart i.
Public Member Functions inherited from ProgressReporter
virtual	~ProgressReporter ()=default
virtual void	Start ()
	Makes the reporter visible or otherwise begins reporting.
virtual void	Finish ()
	Ends reporting.

Detailed Description

ProgressReporter that discards everything reported to it.

Used where an analysis is run without any progress display, so that the analysis code can report unconditionally instead of testing the reporter against nullptr at every call site.

Definition at line 105 of file progressreporter.h.

Member Function Documentation

AppendPoint()

void NullProgressReporter::AppendPoint ( const double &  x, const double &  y, int  chart  )

inlineoverridevirtual

Adds a point to one of the progress charts.

Parameters

x	Horizontal coordinate, typically an iteration or generation number
y	Vertical coordinate, typically a fitness or likelihood value
chart	Index of the chart to append to

Implements ProgressReporter.

Definition at line 108 of file progressreporter.h.

ClearGraph()

void NullProgressReporter::ClearGraph ( int  chart )

inlineoverridevirtual

Discards the points accumulated in a chart.

Implements ProgressReporter.

Definition at line 117 of file progressreporter.h.

SetChartTitle()

void NullProgressReporter::SetChartTitle ( int  i, const QString &  title  )

inlineoverridevirtual

Sets the title of chart i.

Implements ProgressReporter.

Definition at line 118 of file progressreporter.h.

SetLabel()

void NullProgressReporter::SetLabel ( const QString &  label )

inlineoverridevirtual

Sets the free-text status label.

Implements ProgressReporter.

Definition at line 111 of file progressreporter.h.

SetProgress()

void NullProgressReporter::SetProgress ( const double &  prog )

inlineoverridevirtual

Sets the primary progress fraction.

Parameters

prog	Progress in the range [0,1]

Implements ProgressReporter.

Definition at line 109 of file progressreporter.h.

SetProgress2()

void NullProgressReporter::SetProgress2 ( const double &  prog )

inlineoverridevirtual

Sets the secondary progress fraction, where one is displayed.

Parameters

prog	Progress in the range [0,1]

Implements ProgressReporter.

Definition at line 110 of file progressreporter.h.

SetTitle()

void NullProgressReporter::SetTitle ( const QString &  title, int  chart  )

inlineoverridevirtual

Sets the title of a chart.

Implements ProgressReporter.

Definition at line 114 of file progressreporter.h.

SetXAxisTitle()

void NullProgressReporter::SetXAxisTitle ( const QString &  title, int  chart  )

inlineoverridevirtual

Sets the horizontal axis title of a chart.

Implements ProgressReporter.

Definition at line 115 of file progressreporter.h.

SetXRange()

void NullProgressReporter::SetXRange ( const double &  x0, const double &  x1, int  chart  )

inlineoverridevirtual

Sets the horizontal range of a chart.

Implements ProgressReporter.

Definition at line 113 of file progressreporter.h.

SetYAxisTitle()

void NullProgressReporter::SetYAxisTitle ( const QString &  title, int  chart  )

inlineoverridevirtual

Sets the vertical axis title of a chart.

Implements ProgressReporter.

Definition at line 116 of file progressreporter.h.

SetYRange()

void NullProgressReporter::SetYRange ( const double &  y0, const double &  y1, int  chart  )

inlineoverridevirtual

Sets the vertical range of a chart.

Implements ProgressReporter.

Definition at line 112 of file progressreporter.h.

---

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

• progressreporter.h