Gizmod::GizmoLIRC Class Reference

LIRC Gizmos. More...

#include <GizmoLIRC.hpp>

Inheritance diagram for Gizmod::GizmoLIRC:

Inheritance graph
[legend]
Collaboration diagram for Gizmod::GizmoLIRC:

Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual std::string getType ()
 Get the type of the Gizmo.
virtual bool processEvent (GizmoEvent *pEvent)
 Process an event.
void setDisableFirstRepeats (int Repeats)
 Set the number of repeats to disable.
void setMinimumTimeBetweenEvents (float Seconds)
 Set the minimum time between events.
 GizmoLIRC ()
 Serialize Constructor.
 GizmoLIRC (const H::DeviceInfo &deviceInfo, int DeviceID, int DeviceClassID)
 Default Constructor.
virtual ~GizmoLIRC ()
 Destructor.

Protected Attributes

int mDisabledRepeats
 Number of disabled repeats.
long mLastEventTime
 Time of last event.
float mMinTimeBetweenEvents
 Minimum time between events (smooth out trigger happy controllers).

Friends

class boost::serialization::access


Detailed Description

LIRC Gizmos.

This class contains all of the helper functions for making use of LIRC devices

Definition at line 61 of file GizmoLIRC.hpp.


Constructor & Destructor Documentation

GizmoLIRC::GizmoLIRC (  ) 

Serialize Constructor.

GizmoLIRC Serialize Constructor.

Definition at line 71 of file GizmoLIRC.cpp.

References mDisabledRepeats, mLastEventTime, and mMinTimeBetweenEvents.

GizmoLIRC::GizmoLIRC ( const H::DeviceInfo deviceInfo,
int  DeviceID,
int  DeviceClassID 
)

Default Constructor.

GizmoLIRC Default Constructor.

Definition at line 62 of file GizmoLIRC.cpp.

References mDisabledRepeats, mLastEventTime, and mMinTimeBetweenEvents.

GizmoLIRC::~GizmoLIRC (  )  [virtual]

Destructor.

GizmoLIRC Destructor.

Definition at line 80 of file GizmoLIRC.cpp.


Member Function Documentation

std::string GizmoLIRC::getType (  )  [virtual]

Get the type of the Gizmo.

Get the type of this Gizmo.

Returns:
Type of the Gizmo

Reimplemented from Gizmod::Gizmo.

Definition at line 91 of file GizmoLIRC.cpp.

References GIZMO_LIRC_TYPE.

bool GizmoLIRC::processEvent ( GizmoEvent pEvent  )  [virtual]

Process an event.

Parameters:
pEvent The event to process
Returns:
True on if the event should get passed on to the script

Reimplemented from Gizmod::Gizmo.

Definition at line 100 of file GizmoLIRC.cpp.

References cdbg5, mDisabledRepeats, mLastEventTime, mMinTimeBetweenEvents, and Gizmod::GizmoEventLIRC::Repeat.

void GizmoLIRC::setDisableFirstRepeats ( int  Repeats  ) 

Set the number of repeats to disable.

Parameters:
Repeats Number to disable
If repeats is 1 this will cancel the first repeat of a keypress This is intented to smooth out certain trigger happy remotes

Definition at line 119 of file GizmoLIRC.cpp.

References mDisabledRepeats.

void GizmoLIRC::setMinimumTimeBetweenEvents ( float  Seconds  ) 

Set the minimum time between events.

Parameters:
Seconds The time in seconds
This is for remotes that are a bit jittery, or trigger happy. Set this to an appropriate value (issue -V 5 to see the timings)

Definition at line 130 of file GizmoLIRC.cpp.

References mMinTimeBetweenEvents.


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