Package AccessEngine :: Package AEMonitor :: Module Base :: Class AEMonitor

Class AEMonitor

                     object --+    
                              |    
AEUserInterface.AEUserInterface --+
                                  |
                                 AEMonitor

Most abstract base class for all AEMonitor displays.

This class is abstract as most of its methods raise NotImplementedError and need to be overriden in subclasses.

Instance Methods

[hide private]

__init__(self)
Sets the is_init flag to False.

source code

boolean

isInitialized(self)
Gets if the monitor is initialized or not.

source code

init(self)
Sets the is_init flag to True.

source code

close(self)
Sets the is_init flag to False.

source code

class

getEventType(self)
Abstract method.

source code

list of string

getEventNames(self)
Abstract method.

source code

list of string

getEventDefaults(self)
Abstract method.

source code

show(self, **kwargs)
Abstract method.

source code

Inherited from AEUserInterface.AEUserInterface: getClassName, getDescription, getName, getPath

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Instance Variables

[hide private]

boolean

is_init
Is the monitor initialized via the init method?

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self)
(Constructor)

source code

Sets the is_init flag to False.

Overrides: object.__init__

isInitialized(self)

source code

Gets if the monitor is initialized or not.

Returns: boolean: Is the dialog initialized?

init(self)

source code

Sets the is_init flag to True. Subclasses should override this method to create and show their monitor's UI.

close(self)

source code

Sets the is_init flag to False. Subclasses should override this method to hide and destroy their monitor's UI.

getEventType(self)

source code

Abstract method. Gets the base class indicating the type of event of interest to this monitor.

Returns: class

Base type of the event this monitor should buffer

Raises:

NotImplementedError - When this method is not overidden in a subclass

getEventNames(self)

source code

Abstract method. Gets names identifying all possible kinds of events to be monitored. The names are used to determine which events are actually buffered once received by the monitor and which are ignored.

Returns: list of string

All event kinds to potentially buffer

Raises:

NotImplementedError - When this method is not overidden in a subclass

getEventDefaults(self)

source code

Abstract method. Gets the names of events returned by getEventNames that will be buffered by default.

Returns: list of string

Default event kinds to buffer

Raises:

NotImplementedError - When this method is not overidden in a subclass

show(self, **kwargs)

source code

Abstract method. Buffers the given key word arguments. It is up to the monitor that implements this method to decide how to interpret and show the given data.

Parameters:

kwargs (dictionary) - Information to buffer

Raises:

IOError - When the monitor is no longer accepting data to buffer
NotImplementedError - When this method is not overidden in a subclass

Class AEMonitor

__init__(self) (Constructor)

isInitialized(self)

init(self)

close(self)

getEventType(self)

getEventNames(self)

getEventDefaults(self)

show(self, **kwargs)

init(self)
(Constructor)