Module TaskMonitor :: Class TaskMonitor
[hide private]
[frames] | no frames]

Class TaskMonitor

source code

AccessEngine.AEMonitor.AEMonitor --+    
                                   |    
       GTKEventDialog.GTKEventDialog --+
                                       |
                                      TaskMonitor

Logs information about Tasks running in SUE Scripts to a GUI window.

Instance Methods [hide private]
 
init(self)
Creates and shows the monitor window and its components.
source code
string
getName(self)
Gets the localized name of this monitor.
source code
list of string
getEventNames(self)
Gets the event categories to be displayed in the View menu for filtering.
source code
list of string
getEventDefaults(self)
Gets the default event categories to check in the View menu.
source code
AEEvent.Base.AEEvent class
getEventType(self)
Gets the AEEvent.Base.AEEvent base class to indicate the type of events this monitor wants to buffer.
source code
 
show(self, event=None, task_name=None, chain_type=None, propagate=None, **kwargs)
Buffers additional details about how the AEEvent was handled by various AEScripts and tasks.
source code
 
_addViewMenuItems(self, menu)
Adds menu items to menu.
source code
 
_showEvent(self, event, tier_name)
Buffer information about the current event.
source code
 
_showChain(self, chain_type, anchor_ident)
Buffer information about a script task chained to an anchor.
source code
 
_showTask(self, task_name, script)
Buffer information about a script task executing.
source code
 
_showReturn(self, propagate)
Buffer information about the return value of a script task.
source code
 
_onTimeStamp(self, widget, event_name) source code

Inherited from GTKEventDialog.GTKEventDialog: __init__, close

Class Variables [hide private]

Inherited from GTKEventDialog.GTKEventDialog: num_windows

Instance Variables [hide private]
boolean filter_tasks
Should logging information about tasks be inhibited?
string tabs
Stack of tab characters indenting logged events and tasks to appropriate levels

Inherited from GTKEventDialog.GTKEventDialog: logging, queue, scroll, shown, text_buffer, text_view, timer, window

Method Details [hide private]

init(self)

source code 
Creates and shows the monitor window and its components. Calls the parent implementation to set the AccessEngine.AEMonitor.Base.AEMonitor.is_init flag to True.
Overrides: GTKEventDialog.GTKEventDialog.init
(inherited documentation)

getName(self)

source code 
Gets the localized name of this monitor.
Returns: string
Monitor name

getEventNames(self)

source code 
Gets the event categories to be displayed in the View menu for filtering.
Returns: list of string
Event categories

getEventDefaults(self)

source code 
Gets the default event categories to check in the View menu.
Returns: list of string
Event categories

getEventType(self)

source code 
Gets the AEEvent.Base.AEEvent base class to indicate the type of events this monitor wants to buffer.
Returns: AEEvent.Base.AEEvent class
Base type of the event this monitor should buffer

show(self, event=None, task_name=None, chain_type=None, propagate=None, **kwargs)

source code 
Buffers additional details about how the AEEvent was handled by various AEScripts and tasks.
Parameters:
  • event (object) - Event to filter on
  • task_name (string) - name of the task executing
  • chain_type (integer) - One of the AEConstants CHAIN_* constants
  • propagate (boolean) - Is the event allowed to propagate to other script tasks?
Raises:
  • IOError - When the monitor is no longer accepting data to buffer

_addViewMenuItems(self, menu)

source code 
Adds menu items to menu.
Parameters:
  • menu (gtk.Menu) - Menu on which to append
Overrides: GTKEventDialog.GTKEventDialog._addViewMenuItems

_showEvent(self, event, tier_name)

source code 
Buffer information about the current event.
Parameters:
  • event (object) - Event to filter on
  • tier_name (string) - Name of the AETier that handled the event

_showChain(self, chain_type, anchor_ident)

source code 
Buffer information about a script task chained to an anchor.
Parameters:
  • chain_type (integer) - One of the AEConstants CHAIN_* constants
  • anchor_ident (string) - Identifier of the anchor task

_showTask(self, task_name, script)

source code 
Buffer information about a script task executing.
Parameters:
  • task_name (string) - name of the executing Task
  • script (AEScript) - Script in which the task resides

_showReturn(self, propagate)

source code 
Buffer information about the return value of a script task.
Parameters:
  • propagate (boolean) - Are tasks later in a chain or deeper in the AEScript stack allowed to execute (True) or update (False)?