Package org.harctoolbox.irp

Class Decoder

java.lang.Object

org.harctoolbox.irp.Decoder

public final class Decoder
extends Object

This class makes a decoder of an IrpDatabase, or optionally a subset thereof. (The subset is essentially to make debugging more comfortable.) There are essentially two member functions, called decode, operating on IrSignal or ModulatedIrSequence respectively. These have slightly different semantics.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Decoder.AbstractDecodesCollection<T extends ElementaryDecode>
static final class	Decoder.Decode
static final class	Decoder.DecoderParameters
static final class	Decoder.DecodeTree
static final class	Decoder.SimpleDecodesSet
static final class	Decoder.TrunkDecodeTree

Constructor Summary

Constructors

Constructor	Description
Decoder()
Decoder(String... names)	Mainly for testing and debugging.
Decoder(IrpDatabase irpDatabase)
Decoder(IrpDatabase irpDatabase, List<String> names)	This is the main constructor.

Method Summary

Modifier and Type	Method	Description
Decoder.DecodeTree	decode(ModulatedIrSequence irSequence, Decoder.DecoderParameters userSuppliedDecoderParameters)	Delivers a List of Map of Decodes from a ModulatedIrSequence.
Decoder.SimpleDecodesSet	decodeIrSignal(IrSignal irSignal)
Decoder.SimpleDecodesSet	decodeIrSignal(IrSignal irSignal, Decoder.DecoderParameters parameters)	Delivers a Map of Decodes from an IrSignal.
Decoder.AbstractDecodesCollection<? extends ElementaryDecode>	decodeIrSignalWithFallback(IrSignal irSignal, Decoder.DecoderParameters decoderParams)
Decoder.AbstractDecodesCollection<? extends ElementaryDecode>	decodeLoose(IrSignal irSignal, Decoder.DecoderParameters decoderParams)
static String	getDebugProtocolRegExp()
static void	main(String[] args)	Allows to invoke the decoding from the command line.
static void	setDebugProtocolRegExp(String regexp)	For debugging only.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Decoder

public Decoder(IrpDatabase irpDatabase)
        throws IrpParseException

Throws:

IrpParseException

Decoder

public Decoder()
        throws IrpParseException,
IOException,
SAXException

Throws:

IrpParseException

IOException

SAXException

Decoder

public Decoder(String... names)
        throws IOException,
IrpParseException,
SAXException

Mainly for testing and debugging.

Parameters:

names -

Throws:

IOException

IrpParseException

SAXException

Decoder

public Decoder(IrpDatabase irpDatabase,
 List<String> names)
        throws IrpParseException

This is the main constructor.

Parameters:

irpDatabase - will be expanded.

names - If non-null and non-empty, include only the protocols with these names.

Throws:

IrpParseException

Method Details

setDebugProtocolRegExp

public static void setDebugProtocolRegExp(String regexp)

For debugging only.

Parameters:

regexp -

getDebugProtocolRegExp

public static String getDebugProtocolRegExp()

main

public static void main(String[] args)

Allows to invoke the decoding from the command line.

Parameters:

args - Pronto hex type IR signal.

decode

public Decoder.DecodeTree decode(ModulatedIrSequence irSequence,
 Decoder.DecoderParameters userSuppliedDecoderParameters)

Delivers a List of Map of Decodes from a ModulatedIrSequence.

Parameters:

irSequence -

userSuppliedDecoderParameters -

Returns:

List of decodes.

decodeIrSignal

public Decoder.SimpleDecodesSet decodeIrSignal(IrSignal irSignal,
 Decoder.DecoderParameters parameters)

Delivers a Map of Decodes from an IrSignal. If strict == true, the intro, repeat, and ending sequences are required to match exactly. Otherwise, the irSignal's intro may match a Protocol's repeat, and a missing ending sequence is considered to match a Protocol's non-empty ending. on return, a dictionary (Map) is returned, containing all possible decodes of the given input signal. Unless allDecodes == true, decodes are eliminated from this list according to the NamedProtocol's prefer-over property.

Parameters:

irSignal - Input data

parameters -

Returns:

Map of decodes with protocol name as key.

decodeIrSignal

public Decoder.SimpleDecodesSet decodeIrSignal(IrSignal irSignal)

decodeLoose

public Decoder.AbstractDecodesCollection<? extends ElementaryDecode> decodeLoose(IrSignal irSignal,
 Decoder.DecoderParameters decoderParams)

decodeIrSignalWithFallback

public Decoder.AbstractDecodesCollection<? extends ElementaryDecode> decodeIrSignalWithFallback(IrSignal irSignal,
 Decoder.DecoderParameters decoderParams)