NumeRe v1.1.4
NumeRe: Framework für Numerische Rechnungen
Output Class Reference

#include <output.hpp>

Inheritance diagram for Output:
Collaboration diagram for Output:

Public Member Functions

 Output ()
 
 Output (bool bStatus, std::string sFile)
 
 ~Output ()
 
void start ()
 
void end ()
 
void setStatus (bool bStatus)
 
bool isFile () const
 
void setFileName (std::string sFile)
 
std::string getFileName () const
 
void generateFileName ()
 
void setPluginName (std::string _sPluginName)
 
void setCommentLine (std::string _sCommentLine)
 
std::string getPluginName () const
 
std::string getCommentLine () const
 
void reset ()
 
void setPrefix (std::string _sPrefix)
 
std::string getPrefix () const
 
void print_legal ()
 
void setCompact (bool _bCompact)
 
bool isCompact () const
 
void format (std::string **_sMatrix, long long int _nCol, long long int _nLine, const Settings &_option, bool bDontAsk=false, int nHeadLineCount=1)
 
void print (std::string sOutput)
 
- Public Member Functions inherited from FileSystem
 FileSystem ()
 Default constructor. More...
 
FileSystemassign (const FileSystem &_fSys)
 Assignment member function to copy the settings from another FileSystem instance. More...
 
std::string ValidFileName (std::string _sFileName, const std::string sExtension=".dat", bool checkExtension=true, bool doCleanPath=true) const
 This member function evaluates, whether the passed filename is a valid filename. One may supply a preferred filename extension. More...
 
std::string ValidFolderName (std::string _sFileName, bool doCleanPath=true, bool appendTrailingSeparator=true) const
 This member function evaluates, whether the passed foldername is a valid foldername. More...
 
std::string ValidizeAndPrepareName (const std::string &_sFileName, const std::string &sExtension=".dat") const
 This member function validizes the passed file name and creates the needed folders on-the-fly. More...
 
int setPath (std::string _sPath, bool bMkDir, std::string _sExePath)
 This member function may be used to set the preferred file path of the current FileSystem instance. More...
 
void createRevisionsFolder ()
 This member function creates the hidden revisions folders for the version control system. More...
 
std::string getPath () const
 Returns the default path of this FileSystem instance. More...
 
std::vector< std::string > getFileParts (const std::string &sFilePath) const
 This member function separates all path parts into single strings: the drive letter, the path, the name and the extension. This function may also handle folder paths and network paths. More...
 
FileInfo getFileInfo (const std::string &sFilePath) const
 Return the file information about the passed file path. More...
 
void setTokens (std::string _sTokens)
 This member function may be used to update the path placeholders of the current FileSystem instance. More...
 
bool isFile (const std::string &_sPath) const
 This function determines, whether a path name indicates a file or a folder. More...
 
void initializeFromKernel ()
 Member function to remote-initialize the class from the kernel. Cannot be used during kernel start-up. More...
 
void setProgramPath (std::string _sExePath)
 
std::string getProgramPath () const
 
void declareFileType (const std::string &sFileType)
 

Private Member Functions

std::string getDate (bool bForFile)
 
std::string replaceTeXControls (const std::string &_sText)
 

Private Attributes

std::string sFileName
 
std::string sPluginName
 
std::string sCommentLine
 
std::string sPluginPrefix
 
bool bFile
 
bool bFileOpen
 
bool bCompact
 
bool bSumBar
 
bool bPrintTeX
 
bool bPrintCSV
 
std::ofstream file_out
 

Additional Inherited Members

- Protected Member Functions inherited from FileSystem
int createFolders (const std::string &_sPath) const
 This member function creates all missing directories in the passed path. More...
 
- Protected Attributes inherited from FileSystem
std::string sPath
 
std::string sExecutablePath
 
std::string sTokens [7][2]
 
std::string sValidExtensions
 

Detailed Description

Definition at line 38 of file output.hpp.

Constructor & Destructor Documentation

◆ Output() [1/2]

Output::Output ( )

Definition at line 30 of file output.cpp.

References reset().

Here is the call graph for this function:

◆ Output() [2/2]

Output::Output ( bool  bStatus,
std::string  sFile 
)

Definition at line 37 of file output.cpp.

References bFile, reset(), setFileName(), FileSystem::sPath, and start().

Here is the call graph for this function:

◆ ~Output()

Output::~Output ( )

Definition at line 54 of file output.cpp.

References bFile, bFileOpen, and end().

Here is the call graph for this function:

Member Function Documentation

◆ end()

void Output::end ( )

Definition at line 264 of file output.cpp.

References bFile, bFileOpen, and file_out.

Referenced by format(), print(), reset(), setFileName(), setStatus(), and ~Output().

◆ format()

void Output::format ( std::string **  _sMatrix,
long long int  _nCol,
long long int  _nLine,
const Settings _option,
bool  bDontAsk = false,
int  nHeadLineCount = 1 
)

◆ generateFileName()

void Output::generateFileName ( )

Definition at line 336 of file output.cpp.

References getDate(), sFileName, FileSystem::sPath, and sPluginPrefix.

Referenced by createOutputForHist1D(), createOutputForHist2D(), format(), reset(), and setFileName().

Here is the call graph for this function:

◆ getCommentLine()

string Output::getCommentLine ( ) const

Definition at line 224 of file output.cpp.

References sCommentLine.

◆ getDate()

string Output::getDate ( bool  bForFile)
private

Definition at line 356 of file output.cpp.

Referenced by generateFileName(), and print_legal().

◆ getFileName()

string Output::getFileName ( ) const

Definition at line 184 of file output.cpp.

References sFileName.

Referenced by createPlotForHist1D(), and createPlotsForHist2D().

◆ getPluginName()

string Output::getPluginName ( ) const

Definition at line 218 of file output.cpp.

References sPluginName.

◆ getPrefix()

string Output::getPrefix ( ) const

Definition at line 904 of file output.cpp.

References sPluginPrefix.

◆ isCompact()

bool Output::isCompact ( ) const
inline

Definition at line 79 of file output.hpp.

References bCompact.

Referenced by make_stringmatrix().

◆ isFile()

bool Output::isFile ( ) const

◆ print()

void Output::print ( std::string  sOutput)

Definition at line 277 of file output.cpp.

References _lang, bFile, bFileOpen, bPrintCSV, bPrintTeX, bSumBar, end(), file_out, Language::get(), print(), NumeReKernel::printPreFmt(), sFileName, start(), and toSystemCodePage().

Referenced by format(), print(), and print_legal().

Here is the call graph for this function:

◆ print_legal()

void Output::print_legal ( )

Definition at line 230 of file output.cpp.

References _lang, bPrintCSV, bPrintTeX, AutoVersion::DATE, Language::get(), getDate(), AutoVersion::MONTH, print(), sVersion, and AutoVersion::YEAR.

Referenced by start().

Here is the call graph for this function:

◆ replaceTeXControls()

string Output::replaceTeXControls ( const std::string &  _sText)
private

Definition at line 94 of file output.cpp.

Referenced by format().

◆ reset()

void Output::reset ( )

Definition at line 75 of file output.cpp.

References bCompact, bFile, bFileOpen, bPrintCSV, bPrintTeX, bSumBar, end(), generateFileName(), sCommentLine, sFileName, sPluginName, and sPluginPrefix.

Referenced by createHist2D(), createPlotForHist1D(), createStatsFile(), createStatsOutput(), Output(), and show_data().

Here is the call graph for this function:

◆ setCommentLine()

void Output::setCommentLine ( std::string  _sCommentLine)

◆ setCompact()

void Output::setCompact ( bool  _bCompact)

◆ setFileName()

void Output::setFileName ( std::string  sFile)

Definition at line 153 of file output.cpp.

References bFileOpen, bPrintCSV, bPrintTeX, end(), generateFileName(), sFileName, and FileSystem::ValidFileName().

Referenced by createOutputForHist1D(), createOutputForHist2D(), createStatsFile(), format(), and Output().

Here is the call graph for this function:

◆ setPluginName()

void Output::setPluginName ( std::string  _sPluginName)

Definition at line 204 of file output.cpp.

References sPluginName.

Referenced by createOutputForHist1D(), createOutputForHist2D(), createStatsFile(), and show_data().

◆ setPrefix()

void Output::setPrefix ( std::string  _sPrefix)

Definition at line 897 of file output.cpp.

References sPluginPrefix.

Referenced by createOutputForHist1D(), createOutputForHist2D(), createStatsFile(), and show_data().

◆ setStatus()

void Output::setStatus ( bool  bStatus)

Definition at line 65 of file output.cpp.

References bFile, bFileOpen, and end().

Referenced by createOutputForHist1D(), createOutputForHist2D(), plugin_histogram(), and plugin_statistics().

Here is the call graph for this function:

◆ start()

void Output::start ( )

Definition at line 190 of file output.cpp.

References bFile, bFileOpen, file_out, print_legal(), sFileName, and date::detail::trunc().

Referenced by Output(), and print().

Here is the call graph for this function:

Member Data Documentation

◆ bCompact

bool Output::bCompact
private

Definition at line 47 of file output.hpp.

Referenced by format(), isCompact(), reset(), and setCompact().

◆ bFile

bool Output::bFile
private

Definition at line 45 of file output.hpp.

Referenced by end(), format(), isFile(), Output(), print(), reset(), setStatus(), start(), and ~Output().

◆ bFileOpen

bool Output::bFileOpen
private

Definition at line 46 of file output.hpp.

Referenced by end(), print(), reset(), setFileName(), setStatus(), start(), and ~Output().

◆ bPrintCSV

bool Output::bPrintCSV
private

Definition at line 50 of file output.hpp.

Referenced by format(), print(), print_legal(), reset(), and setFileName().

◆ bPrintTeX

bool Output::bPrintTeX
private

Definition at line 49 of file output.hpp.

Referenced by format(), print(), print_legal(), reset(), and setFileName().

◆ bSumBar

bool Output::bSumBar
private

Definition at line 48 of file output.hpp.

Referenced by format(), print(), and reset().

◆ file_out

std::ofstream Output::file_out
private

Definition at line 51 of file output.hpp.

Referenced by end(), print(), and start().

◆ sCommentLine

std::string Output::sCommentLine
private

Definition at line 43 of file output.hpp.

Referenced by format(), getCommentLine(), reset(), and setCommentLine().

◆ sFileName

std::string Output::sFileName
private

Definition at line 41 of file output.hpp.

Referenced by format(), generateFileName(), getFileName(), print(), reset(), setFileName(), and start().

◆ sPluginName

std::string Output::sPluginName
private

Definition at line 42 of file output.hpp.

Referenced by format(), getPluginName(), reset(), and setPluginName().

◆ sPluginPrefix

std::string Output::sPluginPrefix
private

Definition at line 44 of file output.hpp.

Referenced by generateFileName(), getPrefix(), reset(), and setPrefix().


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