DataCollector3D< Tx, Ty, Tz > Class Template Reference

A class that can be used to collect 2D data. More...

#include <data_collector_3d.h>

Public Member Functions
	DataCollector3D (const std::string &_dataSetName, const std::string &_axisNameX, const std::string &_axisNameY, const std::string &_axisNameZ)
void	addData (Tx x, Ty y, Tz z)
void	clear ()
void	writeDataToFile (const std::string &filename="", DataExportFormat format=GNUPLOT, int tabLength=-1)

Detailed Description

template<typename Tx, typename Ty, typename Tz>
class DataCollector3D< Tx, Ty, Tz >

A class that can be used to collect 2D data.

This class is used to simplify the collection of three dimensional data. It stores the data internally in a multimap of pairs. It can then be outputted in various formats. In the current version it only supports outputting to a file readable by GnuPlot.

Constructor & Destructor Documentation

template<typename Tx , typename Ty , typename Tz >

DataCollector3D< Tx, Ty, Tz >::DataCollector3D	(	const std::string &	_dataSetName,
		const std::string &	_axisNameX,
		const std::string &	_axisNameY,
		const std::string &	_axisNameZ
	)

The constructor sets some names for the current dataset.

Parameters

_dataSetName	Name of the dataset.
_axisNameX	Name of the X axis data, or rather the first data.
_axisNameY	Name of the Y axis data, or the second data.
_axisNameZ	Name of the Z axis data, or the third data.

Member Function Documentation

template<typename Tx , typename Ty , typename Tz >

void DataCollector3D< Tx, Ty, Tz >::addData	(	Tx	x,
		Ty	y,
		Tz	z
	)

Adds a 3D data point to the dataset.

Parameters

x	x coordinate.
y	y coordinate.
z	z coordinate.

template<typename Tx , typename Ty , typename Tz >

void DataCollector3D< Tx, Ty, Tz >::clear

(

)

Clear the entire data set.

template<typename Tx , typename Ty , typename Tz >

void DataCollector3D< Tx, Ty, Tz >::writeDataToFile	(	const std::string &	filename = "",
		DataExportFormat	format = GNUPLOT,
		int	tabLength = -1
	)

Write the data to a file.

Parameters

filename	Filename of the data file to write to.
format	Format of the data. Currently only GNUPLOT.
tabLength	The spacing between columns.

---

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

• include_starpu/skepu/src/data_collector_3d.h