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 | |
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 |
This class provides abstract display services. It is intended to be subclassed.
Definition at line 59 of file generalUtils.py.
def generalUtils::Display::__call__ | ( | self, | ||
message, | ||||
addReturn = true | ||||
) |
Definition at line 164 of file generalUtils.py.
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 generalUtils.py.
def generalUtils::Display::blankLine | ( | self | ) |
Definition at line 155 of file generalUtils.py.
def generalUtils::Display::debug | ( | self, | ||
message, | ||||
addReturn = true | ||||
) |
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 | ) |
def generalUtils::Display::display | ( | self, | ||
message, | ||||
addReturn = true | ||||
) |
def generalUtils::Display::error | ( | self, | ||
message, | ||||
addReturn = true | ||||
) |
def generalUtils::Display::indent | ( | self | ) |
def generalUtils::Display::info | ( | self, | ||
message, | ||||
addReturn = true | ||||
) |
def generalUtils::Display::innerDisplayStandard | ( | self, | ||
message | ||||
) |
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 generalUtils.py.
def generalUtils::Display::setVerbosity | ( | self, | ||
newVerbosity = 2 | ||||
) |
Definition at line 175 of file generalUtils.py.
def generalUtils::Display::status | ( | self | ) |
Definition at line 160 of file generalUtils.py.
def generalUtils::Display::warning | ( | self, | ||
message, | ||||
addReturn = true | ||||
) |
Definition at line 86 of file generalUtils.py.
string generalUtils::Display::debugPrefix = '--> Debug: ' [static] |
Definition at line 67 of file generalUtils.py.
generalUtils::Display::do_debug = true [static] |
Definition at line 71 of file generalUtils.py.
string generalUtils::Display::errorPrefix = '#### Error: ' [static] |
Definition at line 69 of file generalUtils.py.
Definition at line 85 of file generalUtils.py.
string generalUtils::Display::infoPrefix = 'Info: ' [static] |
Definition at line 66 of file generalUtils.py.
string generalUtils::Display::normalPrefix = '' [static] |
Definition at line 65 of file generalUtils.py.
Definition at line 89 of file generalUtils.py.
int generalUtils::Display::offsetIncrement = 4 [static] |
Definition at line 63 of file generalUtils.py.
string generalUtils::Display::prefixForKeyMessages = "--" [static] |
Definition at line 62 of file generalUtils.py.
Definition at line 87 of file generalUtils.py.
Definition at line 88 of file generalUtils.py.
string generalUtils::Display::warningPrefix = 'Warning: ' [static] |
Definition at line 68 of file generalUtils.py.