Rc5Decoder Class Reference

A decoder class for RC5 signals. More...

#include <Rc5Decoder.h>

Inheritance diagram for Rc5Decoder:

Collaboration diagram for Rc5Decoder:

Public Member Functions
	Rc5Decoder (const IrReader &irReader)
	Constructs a Rc5Decoder from an IrReader, containing data. More...
virtual	~Rc5Decoder ()
int	getF () const
	Returns the F parameter, or -1 if invalid. More...
int	getD () const
	Returns the D parameter, or -1 if invalid. More...
int	getT () const
	Returns the T parameter, or -1 if invalid. More...
const char *	getDecode () const
	Returns a textual description the decode for human consumption. More...
Public Member Functions inherited from IrDecoder
	IrDecoder ()
virtual	~IrDecoder ()
virtual boolean	isValid () const
	Returns true if the decode was successful. More...
boolean	printDecode (Stream &stream) const
	If valid, prints the decode to the stream. More...

Static Public Member Functions
static boolean	tryDecode (const IrReader &irReader, Stream &stream)
	Convenience function; constructs an Rc5Decoder and calls its printDecode. More...

Static Public Attributes
static const char *	format = "RC5 %d %d %d"

Additional Inherited Members
Protected Member Functions inherited from IrDecoder
void	setValid (bool valid_)
Static Protected Member Functions inherited from IrDecoder
static boolean	isEnding (microseconds_t duration)
	Tests if the argument is large enough to be considered an ending of a decodable signal. More...
Static Protected Attributes inherited from IrDecoder
static const int	invalid = -1

Detailed Description

A decoder class for RC5 signals.

Definition at line 10 of file Rc5Decoder.h.

Constructor & Destructor Documentation

Rc5Decoder::Rc5Decoder

(

const IrReader &

irReader

)

Constructs a Rc5Decoder from an IrReader, containing data.

Parameters

irReader

IrReader with data, i.e. with isReady() true.

Definition at line 29 of file Rc5Decoder.cpp.

virtual Rc5Decoder::~Rc5Decoder ( )

inlinevirtual

Definition at line 20 of file Rc5Decoder.h.

Member Function Documentation

int Rc5Decoder::getD ( ) const

inline

Returns the D parameter, or -1 if invalid.

Returns

int

Definition at line 35 of file Rc5Decoder.h.

const char * Rc5Decoder::getDecode ( ) const

virtual

Returns a textual description the decode for human consumption.

Returns

decode as text.

Implements IrDecoder.

Definition at line 57 of file Rc5Decoder.cpp.

int Rc5Decoder::getF ( ) const

inline

Returns the F parameter, or -1 if invalid.

Returns

int

Definition at line 27 of file Rc5Decoder.h.

int Rc5Decoder::getT ( ) const

inline

Returns the T parameter, or -1 if invalid.

Returns

int

Definition at line 43 of file Rc5Decoder.h.

boolean Rc5Decoder::tryDecode ( const IrReader &  irReader, Stream &  stream  )

static

Convenience function; constructs an Rc5Decoder and calls its printDecode.

Parameters

irReader	IrReader to use
stream	Stream

Returns

success of operation

Definition at line 24 of file Rc5Decoder.cpp.

Member Data Documentation

const char * Rc5Decoder::format = "RC5 %d %d %d"

static

Definition at line 12 of file Rc5Decoder.h.

---

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

• src/Rc5Decoder.h
• src/Rc5Decoder.cpp