GnuplotFileGenerator Class Reference

A class to store information on which data to plot and how to generate the plot. The class also contains methods to generate a file containing gnuplot commands and to invoke gnuplot on such a file. More...

#include <gnuplot.h>

List of all members.

Public Member Functions
	GnuplotFileGenerator ()
	Constructor.
void	addDataFile (string file, unsigned int index=0, string title="")
void	addFunction (string function)
void	setColumnsToPlot (int c1, int c2, int c3=0)
void	setLabels (string xl="", string yl="", string zl="")
	Set the labels of the x, y, and z axis.
void	setGnuplotFileName (string file)
void	setLinestyle (GnuplotLineStyleType style, string fileName="")
void	setPlot3d (bool set)
	Set whether the plot is a 3D plot or not.
void	setPlotTitle (string t)
	Set the title of the plot.
void	setXrange (int X1, int X2)
	Set the x range of the plot to be [X1, X2].
void	setYrange (int Y1, int Y2)
	Set the y range of the plot to be [Y1, Y2].
void	setTerminal (GnuplotTerminalType terminal)
void	setContour_base (void)
void	setContour_surface (void)
void	setContour_both (void)
void	setCntrparam_linear (void)
void	setCntrparam_cubicspline (void)
void	setCntrparam_bspline (void)
void	turnon_grid (void)
void	turnoff_grid (void)
void	turnon_dgrid3d (void)
void	turnoff_dgrid3d (void)
void	turnon_key (void)
void	turnoff_key (void)
void	turnon_border (void)
void	turnoff_border (void)
void	turnon_xtics (void)
void	turnoff_xtics (void)
void	turnon_ytics (void)
void	turnoff_ytics (void)
void	turnon_logscale (void)
void	turnoff_logscale (void)
void	turnon_time (void)
void	turnoff_time (void)
void	turnon_zeroaxis (void)
void	turnoff_zeroaxis (void)
void	turnon_Color (void)
void	turnoff_Color (void)
void	turnon_Solid (void)
void	turnoff_Solid (void)
void	generate ()
	Generate both the file containing gnuplot commands and the plot itself.
void	generateFile (void)
	Generate a file containing gnuplot commands.
void	generatePlot ()
	Generate the plot.

---

Detailed Description

A class to store information on which data to plot and how to generate the plot. The class also contains methods to generate a file containing gnuplot commands and to invoke gnuplot on such a file.

---

Member Function Documentation

void GnuplotFileGenerator::addDataFile	(	string	file,
		unsigned int	index = 0,
		string	title = ""
	)		[inline]

Add a data file.

Parameters:

[in]	file,the	name of the file to plot.
[in]	index,the	index in file to plot.
[in]	title,the	title to use for this file in the key/legend.

void GnuplotFileGenerator::setColumnsToPlot	(	int	c1,
		int	c2,
		int	c3 = 0
	)		[inline]

Set which columns in the data files to use.

void GnuplotFileGenerator::setGnuplotFileName

(

string

file

)

[inline]

Set the name of the file to write gnuplot commands to.

This method sets the name of the file that GnuplotFileGenerator::generateFile() writes Gnuplot commands to. GnuplotFileGenerator::generateFile() adds the extension ".gp". The file in which GnuplotFileGenerator::generatePlot() creates the image of the plot is be the basename of this file followed by an image format-specific extension.

Note:

When this method is not invoked, GnuplotFileGenerator::generateFile() tries to generate a file name from the names of the data files added using GnuplotFileGenerator::addDataFile(). However, this process may file if multiple data files are added and they contain directory paths.

void GnuplotFileGenerator::setLinestyle	(	GnuplotLineStyleType	style,
		string	fileName = ""
	)		[inline]

Set the line style for the plot.

Parameters:

[in]

fileName,the

name of the data file this style applies to.

---

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

• /home/poirel/src/c++/biorithm/libutil/gnuplot.h