Gizmod::GizmoEvent Class Reference

Base class of all GizmoEvents. More...

#include <GizmoEvent.hpp>

Inheritance diagram for Gizmod::GizmoEvent:

Inheritance graph
[legend]
List of all members.

Public Member Functions

GizmoEventClass getClass ()
 Get the class of the Gizmo.
bool isRemote ()
 Get whether or not it's a remote event.
void setIsRemote (bool IsRemote)
 Set whether or not it's a remote event.
 GizmoEvent ()
 Serialize Constructor.
 GizmoEvent (GizmoEventClass Class, bool IsRemote)
 Default Constructor.
virtual ~GizmoEvent ()
 Destructor.

Protected Attributes

GizmoEventClass mClass
 Class of the Gizmo.
bool mIsRemote
 True if the event is a remote event.

Friends

class boost::serialization::access

Detailed Description

Base class of all GizmoEvents.

This class is the base of all GizmoEvents attached to the system. Each gizmo must inherit this class


Member Function Documentation

GizmoEventClass GizmoEvent::getClass (  ) 

Get the class of the Gizmo.

Returns:
GizmoClass of the Gizmo
Note that this is also implemented in Python as a property so it can be accessed as a variable by referencing ".GizmoClass"

bool GizmoEvent::isRemote (  ) 

Get whether or not it's a remote event.

Returns:
True if the remote is from afar
Note that this is also implemented in Python as a property so it can be accessed as a variable by referencing ".RemoteEvent"

void GizmoEvent::setIsRemote ( bool  IsRemote  ) 

Set whether or not it's a remote event.

Parameters:
IsRemote True if the remote is from afar


The documentation for this class was generated from the following files:
Generated on Wed Jun 27 12:43:46 2007 for gizmod by  doxygen 1.4.7