generalUtils::FileDisplay Class Reference

Inheritance diagram for generalUtils::FileDisplay:

[legend]

Collaboration diagram for generalUtils::FileDisplay:

[legend]

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
	logBaseName
	allowOverwrite
	logFilename
	logFile
	esp
	comp
	trunc
	verb
	offset
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 generalUtils.py.

---

Member Function Documentation

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

Definition at line 164 of file generalUtils.py.

def generalUtils::FileDisplay::__del__

(

self

)

Destructor shall release the resources.

Definition at line 230 of file generalUtils.py.

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 generalUtils.py.

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 generalUtils.py.

def generalUtils::Display::blankLine

(

self

)

[inherited]

Definition at line 155 of file generalUtils.py.

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

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

Definition at line 109 of file generalUtils.py.

def generalUtils::Display::desindent

(

self

)

[inherited]

Indents one fewer level for normal messages.

Definition at line 148 of file generalUtils.py.

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

Displays unconditionnally provided normal message.

Definition at line 92 of file generalUtils.py.

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

Displays provided error message.

Definition at line 127 of file generalUtils.py.

def generalUtils::Display::indent

(

self

)

[inherited]

Indents one more level for normal messages.

Definition at line 143 of file generalUtils.py.

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

Displays information message.

Definition at line 100 of file generalUtils.py.

def generalUtils::FileDisplay::innerDisplayError	(		self,
			message
	)

Definition at line 240 of file generalUtils.py.

def generalUtils::FileDisplay::innerDisplayStandard	(		self,
			message
	)

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 generalUtils.py.

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

Definition at line 175 of file generalUtils.py.

def generalUtils::Display::status

(

self

)

[inherited]

Definition at line 160 of file generalUtils.py.

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

Displays provided warning message.

Definition at line 119 of file generalUtils.py.

---

Member Data Documentation

generalUtils::FileDisplay::allowOverwrite

Definition at line 221 of file generalUtils.py.

generalUtils::Display::comp [inherited]

Definition at line 86 of file generalUtils.py.

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

Definition at line 67 of file generalUtils.py.

string generalUtils::FileDisplay::defaultExtension = "txt" [static]

Definition at line 207 of file generalUtils.py.

string generalUtils::FileDisplay::defaultLogBaseName = "Log" [static]

Definition at line 206 of file generalUtils.py.

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

Definition at line 71 of file generalUtils.py.

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

Definition at line 69 of file generalUtils.py.

generalUtils::Display::esp [inherited]

Definition at line 85 of file generalUtils.py.

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

Definition at line 66 of file generalUtils.py.

generalUtils::FileDisplay::logBaseName

Definition at line 220 of file generalUtils.py.

generalUtils::FileDisplay::logFile

Definition at line 224 of file generalUtils.py.

generalUtils::FileDisplay::logFilename

Definition at line 222 of file generalUtils.py.

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

Definition at line 65 of file generalUtils.py.

generalUtils::Display::offset [inherited]

Definition at line 89 of file generalUtils.py.

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

Definition at line 63 of file generalUtils.py.

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

Definition at line 62 of file generalUtils.py.

generalUtils::Display::trunc [inherited]

Definition at line 87 of file generalUtils.py.

generalUtils::Display::verb [inherited]

Definition at line 88 of file generalUtils.py.

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

Definition at line 68 of file generalUtils.py.

---

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

• generalUtils.py