Logger dialog allowing the user to set logging options
Purpose: This class is a window which allows the user to specify
logging options including an interface, interval, file to
log to, duration of log and fields to log.
Used by: MainWindow
Uses: CustomError, ErrorHandler, Field, gtk, libglade, Selector
Attributes: None
SRS Refs: 3.2.1.9, 5.2.3
Author: lljy
Date: 4/8/02
|
Methods
|
|
|
|
|
|
__init__
|
__init__ ( self )
Purpose: Initialises a new instance of the
Logger class. Used by: MainWindow
Uses: None
Input: None
Output: None
Preconditions: None
Postconditions: None
SRS Refs: 3.2.1.9
Author: lljy
Date: 4/8/02
|
|
|
begin
|
begin ( self, *args )
Purpose: Handles the user clicking on the Begin logging
button. Gets the logging done. Used by: Logger
Uses: None
Input: *args : unused arguments
Output: None
Preconditions: None
Postconditions: None
SRS refs: 3.2.1.9a, 3.2.1.9b, 3.2.1.9c, 3.2.1.9d, 3.2.1.9e
Author: lljy
Date: 4/8/02
|
|
|
end
|
end ( self, *args )
Purpose: Ends any logging currently being performed.
Used by: Logger
Uses: None
Input: *args: unused input arguments
Output: None
Preconditions: None
Postconditions: No logging thread is still running.
SRS refs: 3.2.1.9e
Author: lljy
Date: 23/10/02
|
|
|
getDuration
|
getDuration ( self )
Purpose: Returns the duration for the logging, as entered
by the user in the three text boxes. Used by: Logger
Uses: None
Input: None
Output: duration : Integer
Preconditions: None
Postconditions: None
SRS refs: 3.2.1.9e
Author: caedwa
Date: 28/9/02
|
|
|
getInterval
|
getInterval ( self )
Purpose: Returns the integer value of the interval entry
box on the screen. Used by: Logger
Uses: None
Input: None
Output: interval : Integer
Preconditions: None
Postconditions: None
SRS refs: 3.2.1.9d
Author: caedw a
Date: 28/9/02
|
|
|
handleFieldButtons
|
handleFieldButtons (
self,
obj,
*args,
)
Purpose: To select or deselect all fields upon button click
Used by: Logger
Uses: Selector
Input: obj : GtkObject
Output: None
Preconditions: None
Postconditions: Either none or all of the fields in the field
selector are selected
SRS Refs: 5.2.3
Author: caedwa
Date: 28/10/02
|
|
|
handleSelected
|
handleSelected (
self,
obj,
*args,
)
Purpose: Handles the user clicking on either of the 2 lists.
Checks which object has caused the event, then
changes its Selector's selected items (by calling
Selector's changeSelected method). Used by: Logger
Uses: ErrorHandler, Field, Selector
Input: obj : GtkList,
*args : unused arguments
Output: None
Preconditions: The GtkList is named "field_list"
Postconditions: None
SRS refs: 3.2.1.9a
Author: lljy
Date: 4/8/02
|
|
|
hide
|
hide ( self, *args )
Purpose: Hides the logger window.
Used by: Logger
Uses: gtk
Input: None
Output: None
Preconditions: A gtk.mainloop() must have been entered
Postconditions: None
SRS refs: 3.2.1.9
Author: lljy
Date: 4/8/02
|
|
|
intervalToggle
|
intervalToggle ( self, *args )
Purpose: Changes the behaviour of the interval GtkSpinButton
as the radiobutton selection changes. Used by: Logger
Uses: None
Input: *args: unused input arguments
Output: None
Preconditions: None
Postconditions: No logging thread is still running.
SRS refs: 3.2.1.9d
Author: lljy
Date: 23/10/02
|
|
|
show
|
show ( self )
Purpose: Displays the window represented by this class
instance. Used by: MainWindow
Uses: Field, Selector, CustomError, libglade
Input: None
Output: None
Preconditions: None
Postconditions: None
SRS Refs: 3.2.1.9a, 3.2.1.9b, 3.2.1.9c, 3.2.1.9d, 3.2.1.9e
Author: lljy
Date: 4/8/02
|
|