generalUtils::FileDisplay Class Reference

Inheritance diagram for generalUtils::FileDisplay:

Inheritance graph
Collaboration diagram for generalUtils::FileDisplay:

Collaboration graph

List of all members.

Public Member Functions

def __init__
def __del__
def innerDisplayStandard
def innerDisplayError
def __init__
def display
def info
def debug
def warning
def error
def indent
def desindent
def blankLine
def status
def __call__
def setVerbosity

Public Attributes


Static Public Attributes

string defaultLogBaseName = "Log"
string defaultExtension = "txt"
string prefixForKeyMessages = "--"
int offsetIncrement = 4
string normalPrefix = ''
string infoPrefix = 'Info: '
string debugPrefix = '--> Debug: '
string warningPrefix = 'Warning: '
string errorPrefix = '#### Error: '
 do_debug = true

Detailed Description

This is the Display implementation that uses files as display output device.

Definition at line 203 of file

Member Function Documentation

def generalUtils::Display::__call__ (   self,
  addReturn = true 
) [inherited]

Definition at line 164 of file

def generalUtils::FileDisplay::__del__ (   self  ) 

Destructor shall release the resources.

Definition at line 230 of file

def generalUtils::Display::__init__ (   self,
  spacing = 10,
  compression = true,
  truncate = false,
  verbosity = 2 
) [inherited]

Defines the options for this display to perform its tasks.
    - spacing: minimum size for a field,
    - compression: if true, a multi-lined field is displayed only on one line,
    - truncate: if true, truncates a field to the maximum length this values provides,
    - verbosity: sets the level of detail of the display, 
    + 0: totally silent,
    + 1: only most important messages are displayed, those which starts by prefixForKeyMessages,
    + 2: all messages are displayed.

Reimplemented in generalUtils::ScreenDisplay.

Definition at line 73 of file

def generalUtils::FileDisplay::__init__ (   self,
  logBaseName = defaultLogBaseName,
  allowOverwrite = true,
  spacing = 10,
  compression = true,
  truncate = false,
  verbosity = 2 

Implements the Display interface so that messages are output to a log file.
- logFilename: defines the file where messages should be stored,
- allowOverwrite: tells whether a previously existing log file could 
be overwritten,
- the other parameters have the same semantics as the Display ones.				

Definition at line 210 of file

def generalUtils::Display::blankLine (   self  )  [inherited]

Definition at line 155 of file

def generalUtils::Display::debug (   self,
  addReturn = true 
) [inherited]

Displays debug message if and only if we are in debug mode.

Definition at line 109 of file

def generalUtils::Display::desindent (   self  )  [inherited]

Indents one fewer level for normal messages.

Definition at line 148 of file

def generalUtils::Display::display (   self,
  addReturn = true 
) [inherited]

Displays unconditionnally provided normal message.

Definition at line 92 of file

def generalUtils::Display::error (   self,
  addReturn = true 
) [inherited]

Displays provided error message.

Definition at line 127 of file

def generalUtils::Display::indent (   self  )  [inherited]

Indents one more level for normal messages.

Definition at line 143 of file

def generalUtils::Display::info (   self,
  addReturn = true 
) [inherited]

Displays information message.

Definition at line 100 of file

def generalUtils::FileDisplay::innerDisplayError (   self,

Definition at line 240 of file

def generalUtils::FileDisplay::innerDisplayStandard (   self,

Pure virtual function, to be redefined by implementation classes.
It should have been private, if it could be overridden.

Reimplemented from generalUtils::Display.

Definition at line 236 of file

def generalUtils::Display::setVerbosity (   self,
  newVerbosity = 2 
) [inherited]

Definition at line 175 of file

def generalUtils::Display::status (   self  )  [inherited]

Definition at line 160 of file

def generalUtils::Display::warning (   self,
  addReturn = true 
) [inherited]

Displays provided warning message.

Definition at line 119 of file

Member Data Documentation

Definition at line 221 of file

Definition at line 86 of file

string generalUtils::Display::debugPrefix = '--> Debug: ' [static, inherited]

Definition at line 67 of file

Definition at line 207 of file

Definition at line 206 of file

generalUtils::Display::do_debug = true [static, inherited]

Definition at line 71 of file

string generalUtils::Display::errorPrefix = '#### Error: ' [static, inherited]

Definition at line 69 of file

Definition at line 85 of file

string generalUtils::Display::infoPrefix = 'Info: ' [static, inherited]

Definition at line 66 of file

Definition at line 220 of file

Definition at line 224 of file

Definition at line 222 of file

string generalUtils::Display::normalPrefix = '' [static, inherited]

Definition at line 65 of file

Definition at line 89 of file

int generalUtils::Display::offsetIncrement = 4 [static, inherited]

Definition at line 63 of file

string generalUtils::Display::prefixForKeyMessages = "--" [static, inherited]

Definition at line 62 of file

Definition at line 87 of file

Definition at line 88 of file

string generalUtils::Display::warningPrefix = 'Warning: ' [static, inherited]

Definition at line 68 of file

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

Generated on Thu Jun 4 20:41:14 2009 for Ceylan by  doxygen 1.5.8