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 const char *	getDecode () const =0
	Returns a textual description the decode for human consumption. More...
virtual bool	isValid () const
	Returns true if the decode was successful. More...
	operator bool () const
	Same as isValid(). More...
bool	printDecode (Stream &stream) const
	If valid, prints the decode to the stream. More...

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

Additional Inherited Members
Protected Member Functions inherited from IrDecoder
void	setValid (bool valid_)
Static Protected Member Functions inherited from IrDecoder
static bool	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 constexpr int	invalid = -1

Detailed Description

A decoder class for RC5 signals.

Definition at line 9 of file Rc5Decoder.h.

Constructor & Destructor Documentation

Rc5Decoder()

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 27 of file Rc5Decoder.cpp.

~Rc5Decoder()

virtual Rc5Decoder::~Rc5Decoder ( )

inlinevirtual

Definition at line 18 of file Rc5Decoder.h.

Member Function Documentation

getD()

int Rc5Decoder::getD ( ) const

inline

Returns the D parameter, or -1 if invalid.

Returns

int

Definition at line 33 of file Rc5Decoder.h.

getDecode()

const char * Rc5Decoder::getDecode ( ) const

virtual

Returns a textual description the decode for human consumption.

Returns

decode as text.

Implements IrDecoder.

Definition at line 55 of file Rc5Decoder.cpp.

getF()

int Rc5Decoder::getF ( ) const

inline

Returns the F parameter, or -1 if invalid.

Returns

int

Definition at line 25 of file Rc5Decoder.h.

getT()

int Rc5Decoder::getT ( ) const

inline

Returns the T parameter, or -1 if invalid.

Returns

int

Definition at line 41 of file Rc5Decoder.h.

tryDecode()

bool 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 22 of file Rc5Decoder.cpp.

---

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

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