generalUtils::Display Class Reference

Inheritance diagram for generalUtils::Display:

Inheritance graph

List of all members.

Public Member Functions

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

Public Attributes


Static Public Attributes

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 class provides abstract display services. It is intended to be subclassed.

Definition at line 59 of file

Member Function Documentation

def generalUtils::Display::__call__ (   self,
  addReturn = true 

Definition at line 164 of file

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

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::Display::blankLine (   self  ) 

Definition at line 155 of file

def generalUtils::Display::debug (   self,
  addReturn = true 

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

Definition at line 109 of file

def generalUtils::Display::desindent (   self  ) 

Indents one fewer level for normal messages.

Definition at line 148 of file

def generalUtils::Display::display (   self,
  addReturn = true 

Displays unconditionnally provided normal message.

Definition at line 92 of file

def generalUtils::Display::error (   self,
  addReturn = true 

Displays provided error message.

Definition at line 127 of file

def generalUtils::Display::indent (   self  ) 

Indents one more level for normal messages.

Definition at line 143 of file

def generalUtils::Display::info (   self,
  addReturn = true 

Displays information message.

Definition at line 100 of file

def generalUtils::Display::innerDisplayStandard (   self,

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

Reimplemented in generalUtils::ScreenDisplay, and generalUtils::FileDisplay.

Definition at line 135 of file

def generalUtils::Display::setVerbosity (   self,
  newVerbosity = 2 

Definition at line 175 of file

def generalUtils::Display::status (   self  ) 

Definition at line 160 of file

def generalUtils::Display::warning (   self,
  addReturn = true 

Displays provided warning message.

Definition at line 119 of file

Member Data Documentation

Definition at line 86 of file

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

Definition at line 67 of file

Definition at line 71 of file

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

Definition at line 69 of file

Definition at line 85 of file

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

Definition at line 66 of file

Definition at line 65 of file

Definition at line 89 of file

Definition at line 63 of file

Definition at line 62 of file

Definition at line 87 of file

Definition at line 88 of file

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

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