Gizmod::GizmoEvent Class Reference

Base class of all GizmoEvents. More...

#include <GizmoEvent.hpp>

Inheritance diagram for Gizmod::GizmoEvent:

[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

Definition at line 96 of file GizmoEvent.hpp.

---

Constructor & Destructor Documentation

GizmoEvent::GizmoEvent

(

)

Serialize Constructor.

GizmoEvent Serialize Constructor.

Definition at line 58 of file GizmoEvent.cpp.

References Gizmod::GIZMO_EVENTCLASS_STANDARD, mClass, and mIsRemote.

GizmoEvent::GizmoEvent	(	GizmoEventClass	Class,
		bool	IsRemote
	)

Default Constructor.

GizmoEvent Default Constructor.

Definition at line 50 of file GizmoEvent.cpp.

References mClass, and mIsRemote.

GizmoEvent::~GizmoEvent

(

)

[virtual]

Destructor.

GizmoEvent Destructor.

Definition at line 66 of file GizmoEvent.cpp.

---

Member Function Documentation

GizmoEventClass GizmoEvent::getClass

(

)

Get the class of the Gizmo.

Get the class of 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"

Definition at line 80 of file GizmoEvent.cpp.

References mClass.

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"

Definition at line 91 of file GizmoEvent.cpp.

References mIsRemote.

void GizmoEvent::setIsRemote

(

bool

IsRemote

)

Set whether or not it's a remote event.

Parameters:

IsRemote

True if the remote is from afar

Definition at line 99 of file GizmoEvent.cpp.

References mIsRemote.

---

The documentation for this class was generated from the following files:

• libGizmod/GizmoEvent.hpp
• libGizmod/GizmoEvent.cpp

---