Code_TYMPAN  4.4.0
Industrial site acoustic simulation
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Private Attributes | List of all members
OMessageManager Class Reference

#include <logging.h>

Inheritance diagram for OMessageManager:
Inheritance graph
[legend]
Collaboration diagram for OMessageManager:
Collaboration graph
[legend]

Public Member Functions

 OMessageManager ()
 
virtual ~OMessageManager ()
 
bool setAsSingleton ()
 
virtual void warning (const char *message,...)
 
virtual void error (const char *message,...)
 
virtual void fatal (const char *message,...)
 
virtual void info (const char *message,...)
 
virtual void debug (const char *message,...)
 
virtual void missingFile (const char *nomFic)
 
virtual void toDo (const char *message)
 
virtual void trace (const char *message,...)
 
virtual void warning (const QString &message,...)
 
virtual void error (const QString &message,...)
 
virtual void fatal (const QString &message,...)
 
virtual void info (const QString &message,...)
 
virtual void debug (const QString &message,...)
 
virtual void missingFile (const QString &nomFic)
 
virtual void toDo (const QString &message)
 
virtual void trace (const QString &message,...)
 
virtual void format (int level, const char *message,...)
 
void vformat (int level, const char *message, va_list args)
 Variable argument list version of format. More...
 
virtual void output (const char *message, int level)
 
- Public Member Functions inherited from IRefCount
 IRefCount ()
 
virtual ~IRefCount ()
 
virtual int incRef ()
 
virtual int decRef ()
 
int getRefCount () const
 

Static Public Member Functions

static OMessageManagerget ()
 
static char * getStrDate ()
 
static void checkFile (const char *c_file, time_t theTime)
 

Protected Member Functions

virtual int initTrace ()
 

Protected Attributes

FILE * _ficTrace
 Le fichier de trace. More...
 
- Protected Attributes inherited from IRefCount
int m_refCount
 The reference counter. More...
 

Static Private Attributes

static LPOMessageManager _pInstance = 0
 Instance unique du singleton. More...
 

Detailed Description

Classe utilitaire pour la gestion des messages. Les messages sont formates et affiches selon leur type (info, toDo...) ou niveau d'erreur (warning, error, fatal). Cette classe peut etre derivee afin de surcharger notamment les methodes format() et output(), pour respectivement modifier le formatage des messages et les rediriger. Reprise du code C de Pascal Mobuchon.

Definition at line 45 of file logging.h.

Constructor & Destructor Documentation

◆ OMessageManager()

OMessageManager::OMessageManager ( )

Constructeur.

Definition at line 92 of file logging.cpp.

Here is the caller graph for this function:

◆ ~OMessageManager()

OMessageManager::~OMessageManager ( )
virtual

Destructeur.

Definition at line 97 of file logging.cpp.

Member Function Documentation

◆ checkFile()

void OMessageManager::checkFile ( const char *  c_file,
time_t  theTime 
)
static

Test la validite dans le temps d'un fichier de trace.

Definition at line 465 of file logging.cpp.

Here is the caller graph for this function:

◆ debug() [1/2]

void OMessageManager::debug ( const char *  message,
  ... 
)
virtual

Message de type debug.

Definition at line 151 of file logging.cpp.

Here is the caller graph for this function:

◆ debug() [2/2]

void OMessageManager::debug ( const QString &  message,
  ... 
)
virtual

Message de type debug.

Definition at line 260 of file logging.cpp.

Here is the call graph for this function:

◆ error() [1/2]

void OMessageManager::error ( const char *  message,
  ... 
)
virtual

Message de type erreur.

Definition at line 127 of file logging.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ error() [2/2]

void OMessageManager::error ( const QString &  message,
  ... 
)
virtual

Message de type erreur.

Definition at line 206 of file logging.cpp.

Here is the call graph for this function:

◆ fatal() [1/2]

void OMessageManager::fatal ( const char *  message,
  ... 
)
virtual

Message de type erreur.

Definition at line 135 of file logging.cpp.

Here is the call graph for this function:

◆ fatal() [2/2]

void OMessageManager::fatal ( const QString &  message,
  ... 
)
virtual

Message de type erreur.

Definition at line 224 of file logging.cpp.

Here is the call graph for this function:

◆ format()

void OMessageManager::format ( int  level,
const char *  message,
  ... 
)
virtual

Formate les messages. Cette methode est utilisee par les methodes specifiques a chaque type de message (warning(), toDo(), etc.). Elle peut etre surchargee pour formater les messages d'une maniere differente.

Parameters
levelNiveau du message (MSG_DEBUG, MSG_INFO, MSG_WARNING, ...).
messageContenu du message (format printf).

Reimplemented in TYMessageManager.

Definition at line 305 of file logging.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ get()

OMessageManager * OMessageManager::get ( )
static

Retourne l'instance singleton.

Definition at line 108 of file logging.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getStrDate()

char * OMessageManager::getStrDate ( )
static

Convertit et formate la date en une chaine de caractere.

Definition at line 443 of file logging.cpp.

Here is the caller graph for this function:

◆ info() [1/2]

void OMessageManager::info ( const char *  message,
  ... 
)
virtual

Message de type information.

Definition at line 143 of file logging.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ info() [2/2]

void OMessageManager::info ( const QString &  message,
  ... 
)
virtual

Message de type information.

Definition at line 242 of file logging.cpp.

Here is the call graph for this function:

◆ initTrace()

int OMessageManager::initTrace ( )
protectedvirtual

Initialise le fichier de trace.

Definition at line 383 of file logging.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ missingFile() [1/2]

void OMessageManager::missingFile ( const char *  nomFic)
virtual

Message d'erreur general pour un fichier absent.

Definition at line 162 of file logging.cpp.

Here is the call graph for this function:

◆ missingFile() [2/2]

void OMessageManager::missingFile ( const QString &  nomFic)
virtual

Message d'erreur general pour un fichier absent.

Definition at line 277 of file logging.cpp.

Here is the call graph for this function:

◆ output()

void OMessageManager::output ( const char *  message,
int  level 
)
virtual

Affiche/ecrit le message final, le niveau du message est passe dans le cas ou la redirection des messages depend de celui-ci. Cette methode est appelee une fois que le message est ete formate. Elle peut etre surchargee pour rediriger les messages, par defaut ils sont envoyes vers stdout ou stderr selon le type.

Parameters
messageMessage final a afficher/ecrire.
levelNiveau du message (MSG_DEBUG, MSG_INFO, MSG_WARNING, ...).
See also
format()

Reimplemented in TYMessageManager.

Definition at line 356 of file logging.cpp.

Here is the caller graph for this function:

◆ setAsSingleton()

bool OMessageManager::setAsSingleton ( )

Definit cette instance comme singleton. Attention : cette instance doit absolument avoir ete creee sur la heap (operateur new).

Returns
Indique si un singleton etait deja defini ou pas.

Definition at line 99 of file logging.cpp.

Here is the caller graph for this function:

◆ toDo() [1/2]

void OMessageManager::toDo ( const char *  message)
virtual

Message informant que la fonctionnalite n'est pas encore implementee.

Definition at line 167 of file logging.cpp.

◆ toDo() [2/2]

void OMessageManager::toDo ( const QString &  message)
virtual

Message informant que la fonctionnalite n'est pas encore implementee.

Definition at line 282 of file logging.cpp.

◆ trace() [1/2]

void OMessageManager::trace ( const char *  message,
  ... 
)
virtual

Trace dans un fichier.

Definition at line 172 of file logging.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ trace() [2/2]

void OMessageManager::trace ( const QString &  message,
  ... 
)
virtual

Trace dans un fichier.

Definition at line 287 of file logging.cpp.

Here is the call graph for this function:

◆ vformat()

void OMessageManager::vformat ( int  level,
const char *  message,
va_list  args 
)

Variable argument list version of format.

Definition at line 313 of file logging.cpp.

Here is the caller graph for this function:

◆ warning() [1/2]

void OMessageManager::warning ( const char *  message,
  ... 
)
virtual

Message de type warning.

Definition at line 119 of file logging.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ warning() [2/2]

void OMessageManager::warning ( const QString &  message,
  ... 
)
virtual

Message de type warning.

Definition at line 188 of file logging.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ _ficTrace

FILE* OMessageManager::_ficTrace
protected

Le fichier de trace.

Definition at line 204 of file logging.h.

◆ _pInstance

LPOMessageManager OMessageManager::_pInstance = 0
staticprivate

Instance unique du singleton.

Definition at line 208 of file logging.h.


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