GizmodDispatcher::GizmodDispatcher Class Reference

List of all members.

Public Member Functions

def getInitialized
def initialize
def onDeregisterDevice
def onEvent
def onQueryDeviceClass
def onRegisterDevice
def __init__

Public Attributes

 initialized
 userScripts


Detailed Description

Main class that handles all of the incoming events

The idea behind this class is to use it as nothing more than a dispatching
mechanism.  All the events get channeled from GizmoDaemon through here
and this class is intended merely to pass events off the appropriate
module.

Definition at line 41 of file GizmodDispatcher.py.


Member Function Documentation

def GizmodDispatcher::GizmodDispatcher::getInitialized (   self  ) 

Gets whether or not the object has been initialized 

Definition at line 55 of file GizmodDispatcher.py.

def GizmodDispatcher::GizmodDispatcher::initialize (   self  ) 

This python function gets called by GizmoDeamon and is intended to allow for
user specific initialization code to be executed during program startup.

Definition at line 60 of file GizmodDispatcher.py.

def GizmodDispatcher::GizmodDispatcher::onDeregisterDevice (   self,
  Device 
)

This method is triggered when a device has been deregistered (either at shutdown
or when Gizmo Daemon detects a device has been disconnected from the computer)

For information regarding the Device properties and methods see the API documention for
Gizmo* (GizmoStandard, GizmoPowermate, etc)

Definition at line 69 of file GizmodDispatcher.py.

def GizmodDispatcher::GizmodDispatcher::onEvent (   self,
  Event,
  Gizmo = None 
)

This method gets called whenever Gizmo Daemon detects an event from a device
 
The Event object passed in will be of the type associated with that event,
so for example if it's a Powermate event the Event class will be "GizmoPowermate"

Similarly the Gizmo object will of the class of the device that generated
the event. Ie, if it's a Powermate event the class will also be "Powermate".  If
there is no associated Gizmo (ie with WindowFocus events), this field will be
set to None.

All Event classes share the same base "GizmoEvent" class, and you can use the 
GizmoEvent class method "getClass" to figure out what type of event it 
is.  See the C++ API documention (http://gizmod.sourceforge.net/documentation/apidocs)
on the specific GizmoEvent* type for more details

All Gizmo classes share the same base "Gizmo" class, and you can use the Gizmo
class method "getType" to figure out what type of event it is.  See the C++ API 
documention on the specific Gizmo* type for more details

Definition at line 81 of file GizmodDispatcher.py.

def GizmodDispatcher::GizmodDispatcher::onQueryDeviceClass (   self,
  DeviceInformation 
)

This method is triggered when a new device is being registered (either at startup
or when Gizmo Daemon detects a new device has been plugged in to the computer)

For information regarding the DeviceInformation fields see the API documention for
H::DeviceInfo

This method should return the GizmoClass of the device

Definition at line 112 of file GizmodDispatcher.py.

def GizmodDispatcher::GizmodDispatcher::onRegisterDevice (   self,
  Device 
)

This method is triggered when a new device (of the type returned in onQueryDeviceType) 
has been registered (either at startup or when Gizmo Daemon detects a new device has 
been plugged in to the computer)

For information regarding the Device properties and methods see the API documention for
Gizmo* (GizmoStandard, GizmoPowermate, etc)

Definition at line 126 of file GizmodDispatcher.py.

def GizmodDispatcher::GizmodDispatcher::__init__ (   self  ) 

Default Constructor

Definition at line 143 of file GizmodDispatcher.py.


The documentation for this class was generated from the following file:
Generated on Wed Nov 7 10:07:09 2007 for gizmod by  doxygen 1.5.3