Dokumentacja klasy Logger

#include <Logger.h>

Lista wszystkich składowych.


Opis szczegółowy

Prosty logger dziedziczący z wxTextOutputStream.

Logger można utworzyć samemu, bądź zdać się na gotowe makra:

LOGGER(level) - Tworzy obiekt logujący od poziomu [level] przekazujący dane na stderr.

Aby przeprowadzić logowanie do pliku lub do okna, należy w pliku Logger.h odkomentować odpowiednio linijki: //define FILE_LOGGING lub //define WINDOW_LOGGING

LOG(level,message) - Loguje wiadomość o treści zawartej w [message] z poziomem [level].

Poziomy logowania w kolejności od najniższego do najwyższego to: DEBUG, INFO, MESSAGE, WARNING, ERROR.


Typy publiczne

enum  LevelType {
  DEBUG, INFO, WARNING, ERROR,
  FATAL
}
 Poziomy logowania.

Metody publiczne

 Logger (wxOutputStream &targetOutputStream, const wxString &unitName=wxString(__TFILE__), const LevelType displayLevel=DEBUG)
 Konstruktor.
 ~Logger ()
 Destruktor.
void WriteString (const wxString &string)
 Podziel tekst na linie i zapisz do strumienia wyjściowego.
void MessageLevel (const LevelType messageLevel)
 Ustaw poziom logowania następnej wiadomości.
void DisplayLevel (const LevelType displayLevel)
 Ustaw poziom logowania.

Statyczne metody publiczne

static wxFFileOutputStream & CommonFfos ()
 Zwróć strumień wyjściowy wspólny dla wszystkich Loggerów.
static wxFFileOutputStream & CommonStderrOs ()
 Zwróć strumień wyjściowy (do stderr) wspólny dla wszystkich Loggerów.


Dokumentacja konstruktora i destruktora

Logger::Logger wxOutputStream &  targetOutputStream,
const wxString &  unitName = wxString(__TFILE__),
const LevelType  displayLevel = DEBUG
 

Konstruktor.

Parametry:
unitName nazwa programu tworzącego logger.
displayLevel Poziom logowania (domyślnie DEBUG).
targetOutputStream Strumień docelowy (domyślnie NULL).


Dokumentacja funkcji składowych

wxFFileOutputStream & Logger::CommonFfos  )  [static]
 

Zwróć strumień wyjściowy wspólny dla wszystkich Loggerów.

Metoda zwraca referencję na obiekt klasy wxFFileOutputStream wspólny dla wszystkich Loggerów.

Zwraca:
referencja na wspólny strumień wyjściowy Loggerów.

wxFFileOutputStream & Logger::CommonStderrOs  )  [static]
 

Zwróć strumień wyjściowy (do stderr) wspólny dla wszystkich Loggerów.

Metoda zwraca referencję na obiekt klasy wxFFileOutputStream wspólny dla wszystkich Loggerów, a przekazujący dane do stderr.

Zwraca:
referencja na wspólny strumień wyjściowy Loggerów.

void Logger::DisplayLevel const LevelType  displayLevel  ) 
 

Ustaw poziom logowania.

Parametry:
displayLevel Nowy poziom logowania.

void Logger::MessageLevel const LevelType  messageLevel  ) 
 

Ustaw poziom logowania następnej wiadomości.

Parametry:
messageLevel Poziom logowania następnej wiadomości.

void Logger::WriteString const wxString &  string  ) 
 

Podziel tekst na linie i zapisz do strumienia wyjściowego.

Metoda dzieli otrzymany tekst na pojedyncze linie i przekazuje je do stumienia docelowego poprzedzając prefiksem o formacie: "<nazwa modułu> : <poziom wiadomości> : ".

Parametry:
string Tekst do przekazania do stumienia docelowego.


Dokumentacja dla tej klasy została wygenerowana z plików:
Wygenerowano Fri Sep 29 21:04:52 2006 dla EduOptim2 programem  doxygen 1.4.6