generalUtils::ScreenDisplay Class Reference

Inheritance diagram for generalUtils::ScreenDisplay:

[legend]

Collaboration diagram for generalUtils::ScreenDisplay:

[legend]

List of all members.

Public Member Functions
def	__init__
def	innerDisplayStandard
def	innerDisplayError
def	display
def	info
def	debug
def	warning
def	error
def	indent
def	desindent
def	blankLine
def	status
def	__call__
def	setVerbosity
Public Attributes
	esp
	comp
	trunc
	verb
	offset
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 is the Display implementation that uses screen as display output device.

Definition at line 180 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::ScreenDisplay::__init__	(		self,
			spacing = 10,
			compression = true,
			truncate = false,
			verbosity = 2
	)

Propagates back setting to ancestor class' constructor.

Reimplemented from generalUtils::Display.

Definition at line 185 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::ScreenDisplay::innerDisplayError	(		self,
			message
	)

Displays a message to error output file descriptor.

Definition at line 196 of file generalUtils.py.

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

Displays a message to standard output file descriptor.

Reimplemented from generalUtils::Display.

Definition at line 190 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::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.

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.

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