Fonctions membres publiques

# Référence de la classe USpeedGameEngine::Log

Classe permettant d'écrire des informations dans un fichier ou dans la console. Plus de détails...

Liste de tous les membres

## Fonctions membres publiques

| Log ()
| Constructeur par défaut.
| ~Log ()
| Destructeur par défaut.
void | log (char *format,...)
| Fonction de log dans la console ou dans un fichier (selon le paramétrage de la classe).
void | setTarget (bool writeToFile)
| Définition de la cible : console ou fichier.
void | setTarget (bool writeToFile, char *name)
| Définition de la cible : console ou fichier.
void | suspend ()
| Permet de suspendre le "logger" pour ne plus l'utiliser.
void | resume ()
| Permet de ré-activer le "logger" pour l'utiliser à nouveau.
void | finish ()
| Arrête l'utilisation du "logger".

## Description détaillée

Classe permettant d'écrire des informations dans un fichier ou dans la console.

Auteur:
  U.Speed

## Documentation des constructeurs et destructeur

Log::Log | ( |  | ) |

Constructeur par défaut.

Auteur:
  U.Speed

Log::~Log | ( |  | ) |

Destructeur par défaut.

Auteur:
  U.Speed

## Documentation des fonctions membres

void Log::finish | ( |  | ) |

Arrête l'utilisation du "logger".

- Remet le nom de fichier à "log.txt".
- Active le "logger".
- Passe le "logger" en mode fichier.
  Auteur:
    U.Speed

void Log::log | ( | char * | format,
|  |  | ... |
| ) |  |  |

Fonction de log dans la console ou dans un fichier (selon le paramétrage de la classe).

Cette fonction opère un "fflush" pour ne rien perdre en cas d'intéruption du programme. De ce fait, cela peut ralentir l'exécution. Les formats reconnus sont les suivants :

- "%%" : affichage du caractère "%".
- "%s" : chaîne de caractères
- "%c" : chaîne de caractères
- "%d" : nombre entier
- "%l" : nombre entier long non signé
- "%f" : nombre à virgule flotante
- "%x" : entier non signé au format hexadécimal sur 8 caractères "0x--------"
- "%3" : pointeur de USGE_Float3
- "%v" : pointeur de Math::Vector3D
- "%q" : pointeur de Math::Quaternion

Auteur:
  U.Speed

Paramètres:

  | format | char* : le format d'affichage
  | ... | : liste des paramètres

void Log::resume | ( |  | ) |

Permet de ré-activer le "logger" pour l'utiliser à nouveau.

Le "logger" est actif par défaut. C'est donc suite à un appel de "Log::suspend()".

Auteur:
  U.Speed

void Log::setTarget | ( | bool | writeToFile | ) |

Définition de la cible : console ou fichier.

Cela permet d'alterner fichier/console sous Win32.

Auteur:
  U.Speed

Voir également:
  void Log::setTarget(bool writeToFile, char *filename)

Paramètres:

  | writeToFile | bool : `true` pour écrire dans un fichier, sinon écriture en console (Win32 seulement)

void Log::setTarget | ( | bool | writeToFile,
|  | char * | name |
| ) |  |  |

Définition de la cible : console ou fichier.

Cela permet d'alterner fichier/console sous Win32.
Il n'est pas possible de redéfinir le nom du fichier si un fichier est déjà ouvert. Il faut faire un "Log::finish()" avant.

Auteur:
  U.Speed

Paramètres:

  | writeToFile | bool : `true` pour écrire dans un fichier, sinon écriture en console (Win32 seulement)
  | name | char* : le nom du fichier dans lequel écrire (ou "log.txt" par défaut)

void Log::suspend | ( |  | ) |

Permet de suspendre le "logger" pour ne plus l'utiliser.

Le "logger" est actif par défaut.

Auteur:
  U.Speed

La documentation de cette classe a été générée à partir des fichiers suivants :

- src/Log/Log.hpp
- src/Log/Log.cpp
- src/Log/Log_finish.cpp
- src/Log/Log_log.cpp
- src/Log/Log_resume.cpp
- src/Log/Log_setTarget.cpp
- src/Log/Log_suspend.cpp