Package org.harctoolbox.irp

Class NamedProtocol

java.lang.Object

org.harctoolbox.irp.IrpObject

org.harctoolbox.irp.Protocol

org.harctoolbox.irp.NamedProtocol

All Implemented Interfaces:

Serializable, Comparable<NamedProtocol>, AggregateLister, HasPreferOvers, XmlExport

public final class NamedProtocol
extends Protocol
implements HasPreferOvers, Comparable<NamedProtocol>

This class extends the Protocol class Protocol class with a few more properties, in particular a name. It corresponds to an entry in the protocol data base IrpProtocols.xml.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NamedProtocol.TooDeepPreferOversException

Nested classes/interfaces inherited from class org.harctoolbox.irp.Protocol

Protocol.ProtocolNotDecodableException, Protocol.ProtocolNotRenderableException

Constructor Summary

Constructors

Constructor	Description
NamedProtocol(String name, String irp, DocumentFragment documentation)
NamedProtocol(String name, String irp, DocumentFragment htmlDocumentation, String frequencyTolerance, String frequencyLower, String frequencyUpper, String absoluteTolerance, String relativeTolerance, String minimumLeadout, String decodable, String rejectRepeatless, List<String> preferOver, Map<String,List<String>> map)

Method Summary

Modifier and Type	Method	Description
protected void	checkFrequency(Double frequency, Decoder.DecoderParameters params)
int	compareTo(NamedProtocol namedProtocol)
void	dumpPreferOvers(PrintStream out)
void	dumpPreferOvers(PrintStream out, IrpDatabase irpDatabase)
void	dumpPreferOvers(PrintStream out, IrpDatabase irpDatabase, int level)
boolean	equals(Object obj)
Double	getAbsoluteTolerance()
double	getAbsoluteToleranceWithDefault()
DocumentFragment	getDocumentation()
Double	getFrequencyLower()
Double	getFrequencyTolerance()
double	getFrequencyToleranceWithDefault()
Double	getFrequencyUpper()
Double	getMinimumLeadout()
double	getMinimumLeadoutWithDefault()
String	getName()
Set<String>	getPreferOverNames()	Returns the prefer-overs.
Double	getRelativeTolerance()	Returns the parameters relativeTolerance, or null if not assigned.
double	getRelativeToleranceWithDefault()	Returns the parameters relativeTolerance, or the default value if not assigned.
int	hashCode()
boolean	isDecodeable()
boolean	isRejectRepeats()
Set<String>	preferredOvers()
Set<String>	preferredOvers(Map<String,Long> params)
Set<String>	preferredOvers(IrpDatabase irpDatabase)
Set<String>	preferredOvers(IrpDatabase irpDatabase, int level)
Map<String,Long>	recognize(IrSignal irSignal, boolean strict)	This version overrides a version in Protocol.
Map<String,Long>	recognize(IrSignal irSignal, Decoder.DecoderParameters params)
Decoder.Decode	recognize(ModulatedIrSequence irSequence, int beginPos, Decoder.DecoderParameters userSuppliedDecoderParameters)	Tries to match the ModulatedIrSequence in the argument, if match, return the matching parameters.
IrSignal	render(NameEngine nameEngine)
Document	toDocument()
static Document	toDocument(Iterable<NamedProtocol> protocols)
Element	toElement(Document document)
String	toString()
String	toString(int radix)
String	toString(int radix, String separator)
String	warningsString()	This is sort-of a version of classificationString, but for another audience.

Methods inherited from class org.harctoolbox.irp.Protocol

allDurationsInMicros, classificationString, constantNonEmptySequence, constantSequence, createParameterSpecsIfPossible, fillInDefaults, getBitDirection, getBitspecIrstream, getDecoderName, getDefinitions, getDutyCycle, getFrequency, getFrequencyWithDefault, getGeneralSpec, getIrp, getParameterDefault, getParameterMax, getParameterMin, getParameterSpecs, getUnit, guessParameterLength, hasExtent, hasNonStandardParameters, hasParameter, hasParameterDefault, hasParameterMemory, hasVariation, interleavingFlashOk, interleavingGapOk, interleavingOk, isBiphase, isEmpty, isPWM2, isPWM4, isRPlus, isSonyType, isTrivial, isTrivial, minDurationDiff, nonConstantBitFieldLength, nonEmptySequence, normalBareIrStream, normalForm, normalFormElement, normalFormIrpString, normalFormProtocol, numberOfBits, numberOfInfiniteRepeats, propertiesMap, randomParameters, randomParameters, recognize, recognize, recognize, recognize, removeDefaulteds, sort, startsWithFlash, substituteConstantVariables, toIrpString, toIrpString, toIrpString, toIrpString, toIrSignal, toIrSignal, toModulatedIrSequence, toStringTree, toTreeViewer, warningFrequency, warningNonConstantLengthBitFields, warningNoParameterSpecs, warningRepeatPlus, warningsInterleaving, warningStartsWithFlash, warningTrivialBitspec, weight

Methods inherited from class org.harctoolbox.irp.IrpObject

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

Methods inherited from class java.lang.Object

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

Constructor Details

NamedProtocol

public NamedProtocol(String name,
 String irp,
 DocumentFragment htmlDocumentation,
 String frequencyTolerance,
 String frequencyLower,
 String frequencyUpper,
 String absoluteTolerance,
 String relativeTolerance,
 String minimumLeadout,
 String decodable,
 String rejectRepeatless,
 List<String> preferOver,
 Map<String,List<String>> map)
              throws InvalidNameException,
UnsupportedRepeatException,
NameUnassignedException,
IrpInvalidArgumentException

Throws:

InvalidNameException

UnsupportedRepeatException

NameUnassignedException

IrpInvalidArgumentException

NamedProtocol

public NamedProtocol(String name,
 String irp,
 DocumentFragment documentation)
              throws InvalidNameException,
UnsupportedRepeatException,
NameUnassignedException,
IrpInvalidArgumentException

Throws:

InvalidNameException

UnsupportedRepeatException

NameUnassignedException

IrpInvalidArgumentException

Method Details

toDocument

public static Document toDocument(Iterable<NamedProtocol> protocols)

preferredOvers

public Set<String> preferredOvers()

preferredOvers

public Set<String> preferredOvers(Map<String,Long> params)

preferredOvers

public Set<String> preferredOvers(IrpDatabase irpDatabase)
                           throws InvalidNameException,
UnsupportedRepeatException,
IrpInvalidArgumentException,
NameUnassignedException,
NamedProtocol.TooDeepPreferOversException

Throws:

InvalidNameException

UnsupportedRepeatException

IrpInvalidArgumentException

NameUnassignedException

NamedProtocol.TooDeepPreferOversException

preferredOvers

public Set<String> preferredOvers(IrpDatabase irpDatabase,
 int level)
                           throws UnsupportedRepeatException,
IrpInvalidArgumentException,
NameUnassignedException,
NamedProtocol.TooDeepPreferOversException

Throws:

UnsupportedRepeatException

IrpInvalidArgumentException

NameUnassignedException

NamedProtocol.TooDeepPreferOversException

dumpPreferOvers

public void dumpPreferOvers(PrintStream out)

dumpPreferOvers

public void dumpPreferOvers(PrintStream out,
 IrpDatabase irpDatabase)
                     throws NamedProtocol.TooDeepPreferOversException

Throws:

NamedProtocol.TooDeepPreferOversException

dumpPreferOvers

public void dumpPreferOvers(PrintStream out,
 IrpDatabase irpDatabase,
 int level)
                     throws NamedProtocol.TooDeepPreferOversException

Throws:

NamedProtocol.TooDeepPreferOversException

recognize

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

This version overrides a version in Protocol. It uses protocol specific parameter values for frequencyTolerance, absoluteTolerance, relativeTolerance, and minimumLeadout, if defined.

Overrides:

recognize in class Protocol

Parameters:

irSignal -

strict -

Returns:

Throws:

SignalRecognitionException

Protocol.ProtocolNotDecodableException

recognize

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

Overrides:

recognize in class Protocol

Throws:

Protocol.ProtocolNotDecodableException

SignalRecognitionException

recognize

public Decoder.Decode recognize(ModulatedIrSequence irSequence,
 int beginPos,
 Decoder.DecoderParameters userSuppliedDecoderParameters)
                         throws SignalRecognitionException,
Protocol.ProtocolNotDecodableException

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 effectively started, normally 0.

userSuppliedDecoderParameters -

Returns:

Decoder.Decode object, containing matching data.

Throws:

SignalRecognitionException

Protocol.ProtocolNotDecodableException

checkFrequency

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

Overrides:

checkFrequency in class Protocol

Throws:

SignalRecognitionException

warningsString

public String warningsString()

Description copied from class: Protocol

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

Overrides:

warningsString in class Protocol

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class Protocol

equals

public boolean equals(Object obj)

Overrides:

equals in class Protocol

render

public IrSignal render(NameEngine nameEngine)
                throws DomainViolationException,
NameUnassignedException,
IrpInvalidArgumentException,
InvalidNameException,
Protocol.ProtocolNotRenderableException,
OddSequenceLengthException

Throws:

DomainViolationException

NameUnassignedException

IrpInvalidArgumentException

InvalidNameException

Protocol.ProtocolNotRenderableException

OddSequenceLengthException

toString

public String toString()

Overrides:

toString in class IrpObject

toString

public String toString(int radix)

Overrides:

toString in class IrpObject

toString

public String toString(int radix,
 String separator)

Specified by:

toString in interface HasPreferOvers

getName

public String getName()

Specified by:

getName in interface HasPreferOvers

Returns:

the name

getDocumentation

public DocumentFragment getDocumentation()

isDecodeable

public boolean isDecodeable()

isRejectRepeats

public boolean isRejectRepeats()

getRelativeTolerance

public Double getRelativeTolerance()

Returns the parameters relativeTolerance, or null if not assigned.

Returns:

getRelativeToleranceWithDefault

public double getRelativeToleranceWithDefault()

Returns the parameters relativeTolerance, or the default value if not assigned.

Returns:

getAbsoluteTolerance

public Double getAbsoluteTolerance()

getAbsoluteToleranceWithDefault

public double getAbsoluteToleranceWithDefault()

getFrequencyTolerance

public Double getFrequencyTolerance()

getFrequencyToleranceWithDefault

public double getFrequencyToleranceWithDefault()

getFrequencyUpper

public Double getFrequencyUpper()

getFrequencyLower

public Double getFrequencyLower()

getMinimumLeadout

public Double getMinimumLeadout()

getMinimumLeadoutWithDefault

public double getMinimumLeadoutWithDefault()

getPreferOverNames

public Set<String> getPreferOverNames()

Description copied from interface: HasPreferOvers

Returns the prefer-overs.

Specified by:

getPreferOverNames in interface HasPreferOvers

Returns:

Set<String> of the names of protocols that are prefer-overs.

toDocument

public Document toDocument()

Specified by:

toDocument in interface XmlExport

Overrides:

toDocument in class IrpObject

toElement

public Element toElement(Document document)

Specified by:

toElement in interface XmlExport

Overrides:

toElement in class Protocol

Returns:

compareTo

public int compareTo(NamedProtocol namedProtocol)

Specified by:

compareTo in interface Comparable<NamedProtocol>