Sfx::DbgLogger Class Reference

Helper utility that save result to a file to be used for debugging and visualizing. More...

#include <Sfx_DbgLogger.h>

Inheritance diagram for Sfx::DbgLogger:

Public Member Functions
	DbgLogger (const DbgLogger &)=delete
	denied copy
DbgLogger &	operator= (const DbgLogger &)=delete
	denied copy assignment
void	open (const std::string &aFilename="LoggerFile.txt")
	open file for writing (file name as default)
bool	isOpen ()
	check file is open
void	close ()
	close file
void	write2file (const std::string &aMsg="")=delete
	write a message to file
void	write2file (const std::string &aMsg, const int aVal)
	write a message to file and value
void	write2file_p (const tuplevec &aTuple)
	Write tuple of vector.
void	write2file (const tuplevec &aTuple)
	tuple of vector
void	writeField2File (const ::StateVector aStateVec)
	Write state vector.
void	writeField2File_p (const ::StateVector aStateVec)
	Write state vector.
void	write2file (const std::tuple< int32, float64, float64 > &aTuple)=delete
	write a tuple
std::string	name () const noexcept
	return the filename

Protected Member Functions
	DbgLogger ()
	logger creation (default ctor)

Private Types
using	tuplevec = std::tuple<uint32,std::vector<float64>,std::vector<float64>>

Private Attributes
bool	m_opened
FILE *	FichierDEBUG
char	NomFichierDEBUG [256]

Friends
class	Singleton< DbgLogger >
	Accessible by base class (call the logger default ctor).

Detailed Description

Helper utility that save result to a file to be used for debugging and visualizing.

Member Typedef Documentation

tuplevec

using Sfx::DbgLogger::tuplevec = std::tuple<uint32,std::vector<float64>,std::vector<float64>>

private

Constructor & Destructor Documentation

DbgLogger() [1/2]

Sfx::DbgLogger::DbgLogger ( const DbgLogger & )

delete

denied copy

Parameters

object

to copy from

DbgLogger() [2/2]

Sfx::DbgLogger::DbgLogger ( )

protected

logger creation (default ctor)

Member Function Documentation

close()

void Sfx::DbgLogger::close

(

)

close file

isOpen()

bool Sfx::DbgLogger::isOpen ( )

inline

check file is open

Returns

true/false

name()

std::string Sfx::DbgLogger::name ( ) const

inlinenoexcept

return the filename

Returns

string

open()

void Sfx::DbgLogger::open

(

const std::string &

aFilename = "LoggerFile.txt"

)

open file for writing (file name as default)

Parameters

aFilename

operator=()

DbgLogger & Sfx::DbgLogger::operator= ( const DbgLogger & )

delete

denied copy assignment

Parameters

object

to copy from

Returns

this

write2file() [1/4]

void Sfx::DbgLogger::write2file	(	const std::string &	aMsg,
		const int	aVal )

write a message to file and value

Parameters

aMsg	message
aVal	value to write

write2file() [2/4]

void Sfx::DbgLogger::write2file ( const std::string & aMsg = "" )

delete

write a message to file

Parameters

aMsg	text as string

write2file() [3/4]

void Sfx::DbgLogger::write2file ( const std::tuple< int32, float64, float64 > & aTuple )

delete

write a tuple

Parameters

aTuple

tuple

write2file() [4/4]

void Sfx::DbgLogger::write2file

(

const tuplevec &

aTuple

)

tuple of vector

Parameters

aTuple

tuple

write2file_p()

void Sfx::DbgLogger::write2file_p

(

const tuplevec &

aTuple

)

Write tuple of vector.

Parameters

aTuple

tuple

writeField2File()

void Sfx::DbgLogger::writeField2File

(

const ::StateVector

aStateVec

)

Write state vector.

Parameters

aStateVec

StateVector

writeField2File_p()

void Sfx::DbgLogger::writeField2File_p

(

const ::StateVector

aStateVec

)

Write state vector.

Parameters

aStateVec

StateVector

Friends And Related Symbol Documentation

Singleton< DbgLogger >

friend class Singleton< DbgLogger >

friend

Accessible by base class (call the logger default ctor).

Member Data Documentation

FichierDEBUG

FILE* Sfx::DbgLogger::FichierDEBUG

private

file pointer

m_opened

bool Sfx::DbgLogger::m_opened

private

open flag

NomFichierDEBUG

char Sfx::DbgLogger::NomFichierDEBUG[256]

private

file name

---

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

• DamBreakSimulator/SfxBase/Sfx_DbgLogger.h
• DamBreakSimulator/SfxBase/Sfx_DbgLogger.cpp