Package org.harctoolbox.irp

Class Protocol

java.lang.Object

org.harctoolbox.irp.IrpObject

org.harctoolbox.irp.Protocol

All Implemented Interfaces:

Serializable, AggregateLister, XmlExport

Direct Known Subclasses:

NamedProtocol

public class Protocol
extends IrpObject
implements AggregateLister

This class implements the Protocol, per Chapter 1.6--1.7. It essentially consists of the information in the IRP string. Name and other properties is found in the derived class NamedProtocol.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Protocol.ProtocolNotDecodableException	This exception is thrown when trying to decode with a Protocol that is not decodeable.
static class	Protocol.ProtocolNotRenderableException	This exception is thrown when trying to render with a Protocol that is not renderable.

Constructor Summary

Constructors

Constructor	Description
Protocol()	Generates an empty protocol.
Protocol(String irpString)	Parses the string given as argument and constructs a Protocol.
Protocol(GeneralSpec generalSpec, BitspecIrstream bitspecIrstream, NameEngine definitions, ParameterSpecs parameterSpecs)
Protocol(GeneralSpec generalSpec, BitspecIrstream bitspecIrstream, NameEngine definitions, ParameterSpecs parameterSpecs, IrpParser.ProtocolContext parseTree)
Protocol(GeneralSpec generalSpec, BitspecIrstream bitspecIrstream, NameEngine definitions, ParameterSpecs parameterSpecs, IrpParser.ProtocolContext parseTree, Class<? extends AbstractDecoder> decoderClass)	The general constructor for Protocol.
Protocol(IrpParser.ProtocolContext parseTree)

Method Summary

Modifier and Type	Method	Description
TreeSet<Double>	allDurationsInMicros()
protected void	checkFrequency(Double frequency, Decoder.DecoderParameters params)
String	classificationString()
boolean	constantNonEmptySequence(IrSignal.Pass pass)
boolean	constantSequence(IrSignal.Pass pass)
void	createParameterSpecsIfPossible()
boolean	equals(Object obj)
Map<String,Long>	fillInDefaults(Map<String,Long> parameters)	Add the missing (= defaulted) parameter in the argument Map.
BitDirection	getBitDirection()
BitspecIrstream	getBitspecIrstream()
String	getDecoderName()
NameEngine	getDefinitions()
Double	getDutyCycle()
Double	getFrequency()
protected double	getFrequencyWithDefault()
GeneralSpec	getGeneralSpec()
String	getIrp()	Returns the IRP as found in the configuration file, including whitespace, comments, and the author's selection of radix.
Expression	getParameterDefault(String parameterName)
long	getParameterMax(String parameterName)
long	getParameterMin(String parameterName)
ParameterSpecs	getParameterSpecs()
double	getUnit()
Integer	guessParameterLength(String name)
boolean	hasExtent()
int	hashCode()
boolean	hasNonStandardParameters()
boolean	hasParameter(String name)
boolean	hasParameterDefault(String name)
boolean	hasParameterMemory(String parameterName)
boolean	hasVariation(IrSignal.Pass pass)
boolean	interleavingFlashOk()
boolean	interleavingGapOk()
boolean	interleavingOk()
boolean	isBiphase()
boolean	isEmpty(IrSignal.Pass pass)
boolean	isPWM2()
boolean	isPWM4()
boolean	isRPlus()
boolean	isSonyType()	A protocol is Sonytype if it is PWM2 with different flashes, and has interleaving flashes.
boolean	isTrivial()
boolean	isTrivial(boolean inverted)
double	minDurationDiff()
boolean	nonConstantBitFieldLength()
boolean	nonEmptySequence(IrSignal.Pass pass)
BareIrStream	normalBareIrStream(IrSignal.Pass pass)
Protocol	normalForm(IrSignal.Pass pass)
Element	normalFormElement(Document document)
String	normalFormIrpString(int radix)
Protocol	normalFormProtocol()
Integer	numberOfBits()
int	numberOfInfiniteRepeats()
Map<String,Object>	propertiesMap(GeneralSpec generalSpec, NameEngine nameEngine)
Map<String,Long>	randomParameters()
Map<String,Long>	randomParameters(Random random)
Map<String,Long>	recognize(IrSignal irSignal)
Map<String,Long>	recognize(IrSignal irSignal, boolean strict)
Map<String,Long>	recognize(IrSignal irSignal, boolean strict, double frequencyTolerance, double absoluteTolerance, double relativeTolerance, double minimumLeadout)	Tries to match the IrSignal in the argument.If it matches, return the matching parametewith the found parameters with their actual values.If no match, throws a SignalRecognitionException.
Map<String,Long>	recognize(IrSignal irSignal, Decoder.DecoderParameters parameters)
Decoder.Decode	recognize(ModulatedIrSequence irSequence, boolean rejectNoRepeats, boolean strict)
Decoder.Decode	recognize(ModulatedIrSequence irSequence, int beginPos, boolean rejectNoRepeats, Decoder.DecoderParameters params)	Tries to match the ModulatedIrSequence in the argument, if match, return the matching parameters.
void	removeDefaulteds(Map<String,Long> params)
Map<String,Long>	sort(Map<String,Long> map)
boolean	startsWithFlash()
Protocol	substituteConstantVariables()	Returns a Protocol with all of the variables which are constant literals in the Definitions replaced by their values.
Element	toElement(Document document)
String	toIrpString(int radix)	Returns a computed IRP (-segment) string representation of current IrpObject.
String	toIrpString(int radix, boolean usePeriods)
String	toIrpString(int radix, boolean usePeriods, boolean tsvOptimized)
String	toIrpString(int radix, boolean usePeriods, String separator)
IrSignal	toIrSignal(Map<String,Long> params)
IrSignal	toIrSignal(NameEngine nameEngine)	Renders the protocol.
ModulatedIrSequence	toModulatedIrSequence(NameEngine nameEngine, IrSignal.Pass pass)	Renders the protocol, but only for the pass given as second argument.
String	toStringTree()
org.antlr.v4.gui.TreeViewer	toTreeViewer()
String	warningFrequency()
String	warningNonConstantLengthBitFields()
String	warningNoParameterSpecs()
String	warningRepeatPlus()
String	warningsInterleaving()
String	warningsString()	This is sort-of a version of classificationString, but for another audience.
String	warningStartsWithFlash()
String	warningTrivialBitspec()
int	weight()	Returns a (somewhat arbitrary) measure of the complexity of the object.

Methods inherited from class org.harctoolbox.irp.IrpObject

createParameterSpecs, getParseTree, numberOfBitSpecs, prerender, propertiesMap, toDocument, toIrpString, toString, toString, toStringTree, toStringTree, toTreeViewer, toTreeViewer, toTreeViewer, updateStateWhenEntering, updateStateWhenExiting

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Protocol

public Protocol(GeneralSpec generalSpec,
 BitspecIrstream bitspecIrstream,
 NameEngine definitions,
 ParameterSpecs parameterSpecs)

Protocol

public Protocol(GeneralSpec generalSpec,
 BitspecIrstream bitspecIrstream,
 NameEngine definitions,
 ParameterSpecs parameterSpecs,
 IrpParser.ProtocolContext parseTree)

Protocol

public Protocol(GeneralSpec generalSpec,
 BitspecIrstream bitspecIrstream,
 NameEngine definitions,
 ParameterSpecs parameterSpecs,
 IrpParser.ProtocolContext parseTree,
 Class<? extends AbstractDecoder> decoderClass)

The general constructor for Protocol.

Parameters:

generalSpec -

bitspecIrstream -

definitions -

parameterSpecs -

parseTree -

decoderClass -

Protocol

public Protocol()

Generates an empty protocol.

Protocol

public Protocol(String irpString)
         throws UnsupportedRepeatException,
NameUnassignedException,
InvalidNameException,
IrpInvalidArgumentException

Parses the string given as argument and constructs a Protocol.

Parameters:

irpString -

Throws:

InvalidNameException

NameUnassignedException

UnsupportedRepeatException

IrpInvalidArgumentException

Protocol

public Protocol(IrpParser.ProtocolContext parseTree)
         throws UnsupportedRepeatException,
NameUnassignedException,
InvalidNameException,
IrpInvalidArgumentException

Throws:

UnsupportedRepeatException

NameUnassignedException

InvalidNameException

IrpInvalidArgumentException

Method Details

getDecoderName

public String getDecoderName()

toStringTree

public String toStringTree()

toTreeViewer

public org.antlr.v4.gui.TreeViewer toTreeViewer()

constantSequence

public boolean constantSequence(IrSignal.Pass pass)

nonEmptySequence

public boolean nonEmptySequence(IrSignal.Pass pass)

constantNonEmptySequence

public boolean constantNonEmptySequence(IrSignal.Pass pass)

equals

public boolean equals(Object obj)

Specified by:

equals in class IrpObject

hashCode

public int hashCode()

Specified by:

hashCode in class IrpObject

substituteConstantVariables

public Protocol substituteConstantVariables()

Returns a Protocol with all of the variables which are constant literals in the Definitions replaced by their values. Does not change the containing object, but the returned protocol may share some objects with the original protocol.

Returns:

Protocol.

normalFormProtocol

public Protocol normalFormProtocol()

normalForm

public Protocol normalForm(IrSignal.Pass pass)

normalBareIrStream

public BareIrStream normalBareIrStream(IrSignal.Pass pass)

isEmpty

public boolean isEmpty(IrSignal.Pass pass)

normalFormIrpString

public String normalFormIrpString(int radix)

toIrSignal

public IrSignal toIrSignal(NameEngine nameEngine)
                    throws DomainViolationException,
NameUnassignedException,
IrpInvalidArgumentException,
InvalidNameException,
OddSequenceLengthException

Renders the protocol. Parameter values that are free in the protocol are taken from the NameEngine given as argument.

Parameters:

nameEngine - containing free names; may be changed in the call

Returns:

rendered signal

Throws:

ArithmeticException

NameUnassignedException

IrpInvalidArgumentException

InvalidNameException

OddSequenceLengthException

DomainViolationException

toIrSignal

public IrSignal toIrSignal(Map<String,Long> params)
                    throws DomainViolationException,
NameUnassignedException,
IrpInvalidArgumentException,
InvalidNameException,
OddSequenceLengthException

Throws:

DomainViolationException

NameUnassignedException

IrpInvalidArgumentException

InvalidNameException

OddSequenceLengthException

toModulatedIrSequence

public ModulatedIrSequence toModulatedIrSequence(NameEngine nameEngine,
 IrSignal.Pass pass)
                                          throws NameUnassignedException,
IrpInvalidArgumentException,
OddSequenceLengthException

Renders the protocol, but only for the pass given as second argument.

Parameters:

nameEngine - , NameEngine, may be altered.

pass - intro, repeat, or ending

Returns:

rendered ModulatedIrSequence

Throws:

NameUnassignedException

IrpInvalidArgumentException

OddSequenceLengthException

numberOfInfiniteRepeats

public int numberOfInfiniteRepeats()

Overrides:

numberOfInfiniteRepeats in class IrpObject

getIrp

public String getIrp()

Returns the IRP as found in the configuration file, including whitespace, comments, and the author's selection of radix.

Returns:

IRP string, as formatted iun the configuration file.

See Also:

• IrpObject.toIrpString()

getBitDirection

public BitDirection getBitDirection()

getFrequency

public Double getFrequency()

getFrequencyWithDefault

protected double getFrequencyWithDefault()

getUnit

public double getUnit()

getDutyCycle

public Double getDutyCycle()

isPWM2

public boolean isPWM2()

isPWM4

public boolean isPWM4()

isBiphase

public boolean isBiphase()

isTrivial

public boolean isTrivial(boolean inverted)

isTrivial

public boolean isTrivial()

interleavingOk

public boolean interleavingOk()

interleavingFlashOk

public boolean interleavingFlashOk()

interleavingGapOk

public boolean interleavingGapOk()

isSonyType

public boolean isSonyType()

A protocol is Sonytype if it is PWM2 with different flashes, and has interleaving flashes.

Returns:

isRPlus

public boolean isRPlus()

startsWithFlash

public boolean startsWithFlash()

hasVariation

public boolean hasVariation(IrSignal.Pass pass)

hasExtent

public boolean hasExtent()

getBitspecIrstream

public BitspecIrstream getBitspecIrstream()

toElement

public Element toElement(Document document)

Specified by:

toElement in interface XmlExport

Overrides:

toElement in class IrpObject

Returns:

normalFormElement

public Element normalFormElement(Document document)

toIrpString

public String toIrpString(int radix)

Description copied from class: IrpObject

Returns a computed IRP (-segment) string representation of current IrpObject. Numerical parameters, but not durations etc, will be printed using the radix in the argument.

Specified by:

toIrpString in class IrpObject

Parameters:

radix - Radix for parameters.

Returns:

Formatted string.

toIrpString

public String toIrpString(int radix,
 boolean usePeriods)

toIrpString

public String toIrpString(int radix,
 boolean usePeriods,
 String separator)

toIrpString

public String toIrpString(int radix,
 boolean usePeriods,
 boolean tsvOptimized)

randomParameters

public Map<String,Long> randomParameters()

randomParameters

public Map<String,Long> randomParameters(Random random)

recognize

public Map<String,Long> recognize(IrSignal irSignal)
                           throws SignalRecognitionException,
Protocol.ProtocolNotDecodableException

Throws:

SignalRecognitionException

Protocol.ProtocolNotDecodableException

recognize

public Map<String,Long> recognize(IrSignal irSignal,
 boolean strict)
                           throws SignalRecognitionException,
Protocol.ProtocolNotDecodableException

Throws:

SignalRecognitionException

Protocol.ProtocolNotDecodableException

recognize

public Map<String,Long> recognize(IrSignal irSignal,
 boolean strict,
 double frequencyTolerance,
 double absoluteTolerance,
 double relativeTolerance,
 double minimumLeadout)
                           throws SignalRecognitionException,
Protocol.ProtocolNotDecodableException

Tries to match the IrSignal in the argument.If it matches, return the matching parametewith the found parameters with their actual values.If no match, throws a SignalRecognitionException. If strict == false, allows matching the given intro part as a repeat of the protocol, but no other "creativeness" is used. For example, the IrSignal can not contain more than one rendering of the protocol, and the repeat portion cannot contain more than one rendering of the protocol's repeat.

Parameters:

irSignal - IrSignal to test against the present protocol.

strict - Do not allow matching intro as repeat.

frequencyTolerance -

absoluteTolerance -

relativeTolerance -

minimumLeadout -

Returns:

Directory of identified parameters. Never null.

Throws:

SignalRecognitionException - if the IrSignal did not match the present protocol.

Protocol.ProtocolNotDecodableException

recognize

public Map<String,Long> recognize(IrSignal irSignal,
 Decoder.DecoderParameters parameters)
                           throws SignalRecognitionException,
Protocol.ProtocolNotDecodableException

Throws:

SignalRecognitionException

Protocol.ProtocolNotDecodableException

recognize

public Decoder.Decode recognize(ModulatedIrSequence irSequence,
 boolean rejectNoRepeats,
 boolean strict)
                         throws SignalRecognitionException

Throws:

SignalRecognitionException

recognize

public Decoder.Decode recognize(ModulatedIrSequence irSequence,
 int beginPos,
 boolean rejectNoRepeats,
 Decoder.DecoderParameters params)
                         throws SignalRecognitionException

Tries to match the ModulatedIrSequence in the argument, if match, return the matching parameters. If no match, throws exception. The ModulatedIrSequence should contain intro or (one or many) repeat sequences, and possibly an ending sequence.

Parameters:

irSequence - ModulatedIrSequence to be matched

beginPos - Where the match is supposed to start, normally 0.

rejectNoRepeats - If true, at least one repeat sequence must be matched in the sequence given.

params -

Returns:

Decoder.Decode object, containing matching data.

Throws:

SignalRecognitionException

checkFrequency

protected void checkFrequency(Double frequency,
 Decoder.DecoderParameters params)
                       throws SignalRecognitionException

Throws:

SignalRecognitionException

weight

public int weight()

Description copied from class: IrpObject

Returns a (somewhat arbitrary) measure of the complexity of the object. Can be used for determining if a decode is "simpler" than another decode.

Specified by:

weight in class IrpObject

Returns:

non-negative integer.

getGeneralSpec

public GeneralSpec getGeneralSpec()

getParameterSpecs

public ParameterSpecs getParameterSpecs()

sort

public Map<String,Long> sort(Map<String,Long> map)

getDefinitions

public NameEngine getDefinitions()

Returns:

the definitions

classificationString

public String classificationString()

warningsString

public String warningsString()

This is sort-of a version of classificationString, but for another audience.

Returns:

warningFrequency

public String warningFrequency()

warningStartsWithFlash

public String warningStartsWithFlash()

warningTrivialBitspec

public String warningTrivialBitspec()

warningRepeatPlus

public String warningRepeatPlus()

warningsInterleaving

public String warningsInterleaving()

warningNonConstantLengthBitFields

public String warningNonConstantLengthBitFields()

warningNoParameterSpecs

public String warningNoParameterSpecs()

propertiesMap

public Map<String,Object> propertiesMap(GeneralSpec generalSpec,
 NameEngine nameEngine)

Specified by:

propertiesMap in interface AggregateLister

numberOfBits

public Integer numberOfBits()

Overrides:

numberOfBits in class IrpObject

nonConstantBitFieldLength

public boolean nonConstantBitFieldLength()

guessParameterLength

public Integer guessParameterLength(String name)

allDurationsInMicros

public TreeSet<Double> allDurationsInMicros()

minDurationDiff

public double minDurationDiff()

hasParameter

public boolean hasParameter(String name)

hasParameterDefault

public boolean hasParameterDefault(String name)

hasParameterMemory

public boolean hasParameterMemory(String parameterName)

getParameterDefault

public Expression getParameterDefault(String parameterName)

getParameterMax

public long getParameterMax(String parameterName)

getParameterMin

public long getParameterMin(String parameterName)

removeDefaulteds

public void removeDefaulteds(Map<String,Long> params)

hasNonStandardParameters

public boolean hasNonStandardParameters()

fillInDefaults

public Map<String,Long> fillInDefaults(Map<String,Long> parameters)
                                throws NameUnassignedException

Add the missing (= defaulted) parameter in the argument Map.

Parameters:

parameters -

Returns:

Map with missing parameters filled in with their defaults.

Throws:

NameUnassignedException - if the defaults cannot be computed due to missing parameters (for example D in NEC1).

createParameterSpecsIfPossible

public void createParameterSpecsIfPossible()