olb::CSV< T > Class Template Reference

#include <CSVWriter.h>

Inheritance diagram for olb::CSV< T >:

Collaboration diagram for olb::CSV< T >:

Public Member Functions
	CSV (std::string name, char separator, std::vector< std::string > columnTags)
	Constructor with name for output file.
	CSV (std::string name="unnamed")
	CSV (std::string name, char separator)
	CSV (std::string name, std::vector< std::string > columnTags)
void	writeDataFile (T xValue, T yValue, const std::string &plotFileName, int precision=16)
	former datFileOut functions these functions create a datafile in the csv format in order to write in a separated datafile as the one named in the constructor, just put the name as the plotFileName parameter
void	writeDataFile (T xValue, const std::vector< T > &yValues, const std::string &plotFileName, int precision=16)
	writes the data file for one double and a vector of doubles with a specific filename
void	writeDataFile (T xValue, T yValue, int precision=16)
	writes the data file for two doubles (x and y)
void	writeDataFile (T xValue, const std::vector< T > &yValues, int precision=16)
	writes the data file for one double and a vector of doubles (x and y1,y2,...)
void	setColumnTags (const std::vector< std::string > columnTags, std::string &plotFileName)
	adds column tags at the beginning of the csv data file.
void	setColumnTags (const std::vector< std::string > columnTags)
void	clearFile (std::string filename)
	clears the file
void	clearFile ()

Detailed Description

template<typename T>
class olb::CSV< T >

Definition at line 34 of file CSVWriter.h.

Constructor & Destructor Documentation

CSV() [1/4]

template<typename T >

olb::CSV< T >::CSV	(	std::string	name,
		char	separator,
		std::vector< std::string >	columnTags )

Constructor with name for output file.

Constructor with name of outputFiles boolean true for real-time plotting //WARNING: experimental!

add (new) data file

Definition at line 39 of file CSVWriter.hh.

  : _name(name),
    _dataFile(singleton::directories().getGnuplotOutDir()+"data/"+_name+".dat"),
    _dir(singleton::directories().getGnuplotOutDir()),
    _separator(separator),
    _columnTags(columnTags)
{
  if (singleton::mpi().getRank() == _rank) {
    std::ofstream fout;
 
    fout.open(_dataFile.c_str(), std::ios::trunc);
    if(columnTags.size()>0)
    {
      setColumnTags(columnTags);
    }
    fout.close();
  }
}

CSV() [2/4]

template<typename T >

olb::CSV< T >::CSV ( std::string name = "unnamed" )

explicit

Definition at line 63 of file CSVWriter.hh.

: CSV(name, ' ', std::vector<std::string> {}){}

CSV() [3/4]

template<typename T >

olb::CSV< T >::CSV	(	std::string	name,
		char	separator )

Definition at line 66 of file CSVWriter.hh.

: CSV(name, separator, std::vector<std::string> {}){}

CSV() [4/4]

template<typename T >

olb::CSV< T >::CSV	(	std::string	name,
		std::vector< std::string >	columnTags )

Definition at line 60 of file CSVWriter.hh.

: CSV(name, ' ', columnTags){}

Member Function Documentation

clearFile() [1/2]

template<typename T >

void olb::CSV< T >::clearFile

(

)

Definition at line 153 of file CSVWriter.hh.

{
  clearFile(_name);
}

clearFile() [2/2]

template<typename T >

void olb::CSV< T >::clearFile

(

std::string

filename

)

clears the file

empty the file by opening an ofstream

Definition at line 145 of file CSVWriter.hh.

{
  std::ofstream fout(singleton::directories().getGnuplotOutDir() + "data/" + filename + ".dat",std::ios::out);
  fout.close();
}

References olb::singleton::directories().

Here is the call graph for this function:

setColumnTags() [1/2]

template<typename T >

void olb::CSV< T >::setColumnTags

(

const std::vector< std::string >

columnTags

)

Definition at line 139 of file CSVWriter.hh.

{
  setColumnTags(columnTags, _name);
}

setColumnTags() [2/2]

template<typename T >

void olb::CSV< T >::setColumnTags	(	const std::vector< std::string >	columnTags,
		std::string &	plotFileName )

adds column tags at the beginning of the csv data file.

saves the content of the file and rewrites it with the tags at the top and then inserting the content again

to prevent having a separator at the end

Definition at line 119 of file CSVWriter.hh.

{
  OstreamManager clout(std::cout,"setColumnTags");
 
  std::ofstream fout(singleton::directories().getGnuplotOutDir() + "data/" + plotFileName + ".dat",std::ios::out);
 
  if(fout.is_open())
  {
    unsigned int k = 0;
    for(;k < columnTags.size() -1; k++)
    {
      fout << columnTags.at(k) << _separator;
    }
    fout << columnTags.at(k) << std::endl;
  }
  fout.close();
}

References olb::singleton::directories().

Here is the call graph for this function:

writeDataFile() [1/4]

template<typename T >

void olb::CSV< T >::writeDataFile	(	T	xValue,
		const std::vector< T > &	yValues,
		const std::string &	plotFileName,
		int	precision = 16 )

writes the data file for one double and a vector of doubles with a specific filename

Definition at line 70 of file CSVWriter.hh.

{
  if (singleton::mpi().getRank() == _rank) {
    std::ofstream fout;
    std::string DATAF;
    DATAF = singleton::directories().getGnuplotOutDir()+"data/"+plotNameFile+".dat";
    fout.precision(precision);
    fout.open(DATAF.c_str(), std::ios::out | std::ios::app);
    fout << BaseType<T>(xValue);
    for (unsigned int i = 0; i < yValues.size(); i++) {
      fout << _separator << BaseType<T>(yValues[i]);
    }
    fout << std::endl;
    fout.close();
  }
  return;
}

References olb::singleton::directories(), olb::singleton::Directories::getGnuplotOutDir(), and olb::singleton::mpi().

Here is the call graph for this function:

writeDataFile() [2/4]

template<typename T >

void olb::CSV< T >::writeDataFile	(	T	xValue,
		const std::vector< T > &	yValues,
		int	precision = 16 )

writes the data file for one double and a vector of doubles (x and y1,y2,...)

Definition at line 101 of file CSVWriter.hh.

{
  writeDataFile(xValue, yValues, _name, precision);
  return;
}

writeDataFile() [3/4]

template<typename T >

void olb::CSV< T >::writeDataFile	(	T	xValue,
		T	yValue,
		const std::string &	plotFileName,
		int	precision = 16 )

former datFileOut functions these functions create a datafile in the csv format in order to write in a separated datafile as the one named in the constructor, just put the name as the plotFileName parameter

writes the data file for two doubles with a specific filename

Definition at line 91 of file CSVWriter.hh.

{
  std::vector<T> yValues{yValue};
  writeDataFile(xValue, yValues, plotNameFile, precision);
  return;
}

writeDataFile() [4/4]

template<typename T >

void olb::CSV< T >::writeDataFile	(	T	xValue,
		T	yValue,
		int	precision = 16 )

writes the data file for two doubles (x and y)

Definition at line 109 of file CSVWriter.hh.

{
  std::vector<T> yValues{yValue};
  writeDataFile(xValue, yValues, _name,precision);
  return;
}

---

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

• src/io/CSVWriter.h
• src/io/CSVWriter.hh