util::plot::GnuPlot Class Reference

Simple wrapper around the gnuplot application that do plotting. More...

#include "util/gnuplot."

Public Member Functions
	GnuPlot ()
	Constructor.
virtual	~GnuPlot ()=default
	Destructor.
const std::string &	ExePath () const
	Returns the full path to the gnuplot application.
const std::string &	Name () const
	Name of the gnuplot report.
void	Name (const std::string &name)
	Name of the gnuplot report If the plot report shall be saved, this defines the name of the gnuplot file and its CSV file. The name shall be without any path and extension. The Path property defines where these reports are saved.
const std::string &	Path () const
	Path where reports are saved.
void	Path (const std::string &path)
	Path where report are saved.
std::string	FileName () const
	Returns the full path to the gnuplot script file.
std::string	CsvFileName () const
	Returns the full path of the CSV file.
std::string	CreateScript () const
	Creates a script string.
void	SaveScript ()
	Creates and saves the gnuplot script in a file.
void	Show ()
	Shows the plot on the screen.
CsvWriter &	CsvFile ()
	Returns a reference to a CSV writer object.

Detailed Description

Simple wrapper around the gnuplot application. The gnuplot do basic plotting and fetch its values from a CSV file, so the trick is to do the CSV file.

Constructor & Destructor Documentation

GnuPlot()

util::plot::GnuPlot::GnuPlot

(

)

The constructor search for the GnuPlot application on the computer. If the application not in its default path, it needs to be in the computer path environment. There is a checkbox for this when installing gnuplot.

Member Function Documentation

CreateScript()

std::string util::plot::GnuPlot::CreateScript ( ) const

nodiscard

Creates a script string for temporary plotting and viewing.

Returns

Gnuplot script as a string.

CsvFile()

CsvWriter & util::plot::GnuPlot::CsvFile ( )

inline

Returns a reference to a CSV writer object.

Returns

CsvFileName()

std::string util::plot::GnuPlot::CsvFileName ( ) const

nodiscard

Returns the full path of the CSV file with all data.

Returns

CSV data file.

ExePath()

const std::string & util::plot::GnuPlot::ExePath ( ) const

inlinenodiscard

Full path to the gnuplot application.

Returns

Full path to the gnuplot application.

FileName()

std::string util::plot::GnuPlot::FileName ( ) const

nodiscard

Returns the full name of the gnuplot script file.

Returns

Gnuplot script file.

Name() [1/2]

const std::string & util::plot::GnuPlot::Name ( ) const

inlinenodiscard

This name is used to name the gnuplot and CSV files if they are saved.

Returns

Name of the report.

Name() [2/2]

void util::plot::GnuPlot::Name ( const std::string & name )

inline

Parameters

name	Name of report without path or extension.

Path() [1/2]

const std::string & util::plot::GnuPlot::Path ( ) const

inlinenodiscard

Directory path where reports are saved.

Returns

Path() [2/2]

void util::plot::GnuPlot::Path ( const std::string & path )

inline

Directory path where reports are saved.

Parameters

path

SaveScript()

void util::plot::GnuPlot::SaveScript

(

)

Create and saves the gnuplot script in a file.

Show()

void util::plot::GnuPlot::Show

(

)

Shows the gnuplot on the screen.

---

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

• include/util/gnuplot.h