snWriteResultFile Class Reference

opens a HDF5 file for output. Every snBlock in the simulation chain can write simulation result data to that file with the write functions. More...

#include <snWriteResultFile.h>

Public Member Functions
	snWriteResultFile (std::string filename)
	constructor More...
virtual	~snWriteResultFile ()
void	createGroup (std::string name)
	creates a group in the result HDF5 file More...
void	write (std::string path, double data)
	writes a single double value More...
void	write (std::string path, double *data, unsigned long num)
	writes a double array More...
void	write (std::string path, std::string data)
	writes a std string More...
void	write (std::string path, std::vector< double > &data, unsigned long num)
	writes a std::vector &. More...
void	write (std::string path, std::vector< std::complex< double > > &data, unsigned long num)
	writes a std::complex vector. More...
void	write (std::string path, std::complex< double > *data, unsigned long num)
	writes an array of complex doubles More...

Private Attributes
H5::H5File *	f

Detailed Description

opens a HDF5 file for output. Every snBlock in the simulation chain can write simulation result data to that file with the write functions.

Constructor & Destructor Documentation

snWriteResultFile::snWriteResultFile

(

std::string

filename

)

constructor

Parameters

<std::string

filename> file name

snWriteResultFile::~snWriteResultFile ( )

virtual

Member Function Documentation

void snWriteResultFile::createGroup

(

std::string

name

)

creates a group in the result HDF5 file

void snWriteResultFile::write	(	std::string	path,
		double	data
	)

writes a single double value

Parameters

<std::string	path> the path inside the HDF5 file to write to
<double	data> the value to write

void snWriteResultFile::write	(	std::string	path,
		double *	data,
		unsigned long	num
	)

writes a double array

Parameters

<std::string	path> the path inside the HDF5 file to write to
<double	*data> pointer to double array
<unsigned	long num> number of elements to write

void snWriteResultFile::write	(	std::string	path,
		std::string	data
	)

writes a std string

Parameters

<std::string	path> the path inside the HDF5 file to write to
<std::string	*data> string

void snWriteResultFile::write	(	std::string	path,
		std::vector< double > &	data,
		unsigned long	num
	)

writes a std::vector &.

Parameters

<std::string	path> the path inside the HDF5 file to write to
<std::vector<double>	&data> reference to the vector

void snWriteResultFile::write	(	std::string	path,
		std::vector< std::complex< double > > &	data,
		unsigned long	num
	)

writes a std::complex vector.

Parameters

<std::string	path> the path inside the HDF5 file to write to
<std::vector<std::complex<double>	> &data> reference to the complex vector

void snWriteResultFile::write	(	std::string	path,
		std::complex< double > *	data,
		unsigned long	num
	)

writes an array of complex doubles

Parameters

<std::string	path> the path inside the HDF5 file to write to
<std::complex<double>	*data> pointer to the array
<unsigned	long num> amoun of elements to write

Member Data Documentation

H5::H5File* snWriteResultFile::f

private

---

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

• snWriteResultFile.h
• snWriteResultFile.cpp