Package org.harctoolbox.irp

Class BitspecIrstream

java.lang.Object

org.harctoolbox.irp.IrpObject

org.harctoolbox.irp.BitspecIrstream

All Implemented Interfaces:

Serializable, IrStreamItem, XmlExport

public final class BitspecIrstream
extends IrpObject
implements IrStreamItem

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
BitspecIrstream()
BitspecIrstream(String str)
BitspecIrstream(BitSpec bitSpec, IrStream irStream)
BitspecIrstream(BitSpec bitSpec, IrStream irStream, IrpParser.Bitspec_irstreamContext ctx)
BitspecIrstream(IrpParser.Bitspec_irstreamContext ctx)
BitspecIrstream(IrpParser.ProtocolContext ctx)

Method Summary

Modifier and Type	Method	Description
TreeSet<Double>	allDurationsInMicros(GeneralSpec generalSpec, NameEngine nameEngine)	Delivers a set of all the contained durations in microseconds.
Set<String>	assignmentVariables()
boolean	constant(NameEngine nameEngine)
void	createParameterSpecs(ParameterSpecs parameterSpecs)
void	decode(RecognizeData recognizeData, List<BitSpec> inheritedBitSpecs, boolean isLast)
DurationType	endingDurationType(DurationType last, boolean gapFlashBitSpecs)
boolean	equals(Object obj)
void	evaluate(RenderData renderData, List<BitSpec> bitSpecStack)
BareIrStream	extractPass(IrSignal.Pass pass)
BareIrStream	extractPass(IrSignal.Pass pass, IrStream.PassExtractorState state)
BitSpec	getBitSpec()
IrStream	getIrStream()
Integer	guessParameterLength(String name)	Tries to infer the bit-length of the parameter with name as the argument.
boolean	hasExtent()
int	hashCode()
boolean	interleavingFlashOk()
boolean	interleavingGapOk()
boolean	interleavingOk()
boolean	interleavingOk(DurationType last)
boolean	interleavingOk(DurationType last, boolean gapFlashBitSpecsUnused)
boolean	interleavingOk(DurationType toCheck, DurationType last)
boolean	interleavingOk(DurationType toCheck, DurationType last, boolean gapFlashBitSpecs)
boolean	isEmpty(NameEngine nameEngine)
Double	microSeconds(GeneralSpec generalSpec, NameEngine nameEngine)
boolean	nonConstantBitFieldLength()
Integer	numberOfBareDurations()
Integer	numberOfBits()	Computes the number of encoded bits, which may differ from the number of payload bits, in the case of redundancy.
Integer	numberOfBitSpecs()
Integer	numberOfDurations()	Upper limit of the number of (interleaving) durations in the rendered signal.
int	numberOfInfiniteRepeats()
Map<String,Object>	propertiesMap(GeneralSpec generalSpec, NameEngine nameEngine)
void	render(RenderData renderData, List<BitSpec> inheritedBitSpecs)
DurationType	startingDuratingType(DurationType last, boolean gapFlashBitSpecs)
DurationType	startingDurationType(boolean gapFlashBitSpecs)
BitspecIrstream	substituteConstantVariables(Map<String,Long> constantVariables)	Returns an IrStreamItem of the same type with all occurrences of the variables in the dictionary replaced by their values in the dictionary.
Element	toElement(Document document)
String	toIrpString(int radix)	Returns a computed IRP (-segment) string representation of current IrpObject.
String	toIrpString(int radix, String separator)
void	updateStateWhenEntering(IrSignal.Pass pass, IrStream.PassExtractorState state)
void	updateStateWhenExiting(IrSignal.Pass pass, IrStream.PassExtractorState state)
int	weight()	Returns a (somewhat arbitrary) measure of the complexity of the object.

Methods inherited from class org.harctoolbox.irp.IrpObject

getParseTree, prerender, propertiesMap, toDocument, toIrpString, toString, toString, toStringTree, toStringTree, toTreeViewer, toTreeViewer, toTreeViewer

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.harctoolbox.irp.IrStreamItem

propertiesMap

Methods inherited from interface org.harctoolbox.xml.XmlExport

toDocument

Constructor Details

BitspecIrstream

public BitspecIrstream(IrpParser.ProtocolContext ctx)

BitspecIrstream

public BitspecIrstream(BitSpec bitSpec,
 IrStream irStream,
 IrpParser.Bitspec_irstreamContext ctx)

BitspecIrstream

public BitspecIrstream(BitSpec bitSpec,
 IrStream irStream)

BitspecIrstream

public BitspecIrstream(IrpParser.Bitspec_irstreamContext ctx)

BitspecIrstream

public BitspecIrstream(String str)

BitspecIrstream

public BitspecIrstream()

Method Details

equals

public boolean equals(Object obj)

Specified by:

equals in class IrpObject

hashCode

public int hashCode()

Specified by:

hashCode in class IrpObject

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 interface IrStreamItem

Specified by:

toIrpString in class IrpObject

Parameters:

radix - Radix for parameters.

Returns:

Formatted string.

toIrpString

public String toIrpString(int radix,
 String separator)

toElement

public Element toElement(Document document)

Specified by:

toElement in interface XmlExport

Overrides:

toElement in class IrpObject

Parameters:

document -

Returns:

isEmpty

public boolean isEmpty(NameEngine nameEngine)

Specified by:

isEmpty in interface IrStreamItem

numberOfBitSpecs

public Integer numberOfBitSpecs()

Specified by:

numberOfBitSpecs in interface IrStreamItem

Overrides:

numberOfBitSpecs in class IrpObject

numberOfBits

public Integer numberOfBits()

Description copied from interface: IrStreamItem

Computes the number of encoded bits, which may differ from the number of payload bits, in the case of redundancy.

Specified by:

numberOfBits in interface IrStreamItem

Overrides:

numberOfBits in class IrpObject

Returns:

numberOfBareDurations

public Integer numberOfBareDurations()

Specified by:

numberOfBareDurations in interface IrStreamItem

numberOfInfiniteRepeats

public int numberOfInfiniteRepeats()

Specified by:

numberOfInfiniteRepeats in interface IrStreamItem

Overrides:

numberOfInfiniteRepeats in class IrpObject

decode

public void decode(RecognizeData recognizeData,
 List<BitSpec> inheritedBitSpecs,
 boolean isLast)
            throws SignalRecognitionException

Specified by:

decode in interface IrStreamItem

Throws:

SignalRecognitionException

render

public void render(RenderData renderData,
 List<BitSpec> inheritedBitSpecs)
            throws NameUnassignedException

Specified by:

render in interface IrStreamItem

Throws:

NameUnassignedException

updateStateWhenEntering

public void updateStateWhenEntering(IrSignal.Pass pass,
 IrStream.PassExtractorState state)

Specified by:

updateStateWhenEntering in interface IrStreamItem

Overrides:

updateStateWhenEntering in class IrpObject

updateStateWhenExiting

public void updateStateWhenExiting(IrSignal.Pass pass,
 IrStream.PassExtractorState state)

Specified by:

updateStateWhenExiting in interface IrStreamItem

Overrides:

updateStateWhenExiting in class IrpObject

extractPass

public BareIrStream extractPass(IrSignal.Pass pass,
 IrStream.PassExtractorState state)

Specified by:

extractPass in interface IrStreamItem

extractPass

public BareIrStream extractPass(IrSignal.Pass pass)

interleavingOk

public boolean interleavingOk(DurationType last,
 boolean gapFlashBitSpecsUnused)

Specified by:

interleavingOk in interface IrStreamItem

Parameters:

last -

gapFlashBitSpecsUnused -

Returns:

interleavingOk

public boolean interleavingOk(DurationType last)

interleavingOk

public boolean interleavingOk(DurationType toCheck,
 DurationType last,
 boolean gapFlashBitSpecs)

Specified by:

interleavingOk in interface IrStreamItem

interleavingOk

public boolean interleavingOk(DurationType toCheck,
 DurationType last)

interleavingOk

public boolean interleavingOk()

interleavingFlashOk

public boolean interleavingFlashOk()

interleavingGapOk

public boolean interleavingGapOk()

endingDurationType

public DurationType endingDurationType(DurationType last,
 boolean gapFlashBitSpecs)

Specified by:

endingDurationType in interface IrStreamItem

startingDuratingType

public DurationType startingDuratingType(DurationType last,
 boolean gapFlashBitSpecs)

Specified by:

startingDuratingType in interface IrStreamItem

startingDurationType

public DurationType startingDurationType(boolean gapFlashBitSpecs)

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 interface IrStreamItem

Specified by:

weight in class IrpObject

Returns:

non-negative integer.

hasExtent

public boolean hasExtent()

Specified by:

hasExtent in interface IrStreamItem

getBitSpec

public BitSpec getBitSpec()

getIrStream

public IrStream getIrStream()

assignmentVariables

public Set<String> assignmentVariables()

Specified by:

assignmentVariables in interface IrStreamItem

propertiesMap

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

Specified by:

propertiesMap in interface IrStreamItem

microSeconds

public Double microSeconds(GeneralSpec generalSpec,
 NameEngine nameEngine)

Specified by:

microSeconds in interface IrStreamItem

numberOfDurations

public Integer numberOfDurations()

Description copied from interface: IrStreamItem

Upper limit of the number of (interleaving) durations in the rendered signal. Only intended to be used on intro/repeat/ending IrStreams.

Specified by:

numberOfDurations in interface IrStreamItem

Returns:

number of durations (not necessarily interleaving), or null if not possible to determine.

evaluate

public void evaluate(RenderData renderData,
 List<BitSpec> bitSpecStack)

Specified by:

evaluate in interface IrStreamItem

nonConstantBitFieldLength

public boolean nonConstantBitFieldLength()

Specified by:

nonConstantBitFieldLength in interface IrStreamItem

guessParameterLength

public Integer guessParameterLength(String name)

Description copied from interface: IrStreamItem

Tries to infer the bit-length of the parameter with name as the argument.

Specified by:

guessParameterLength in interface IrStreamItem

Parameters:

name - Name of parameter sought.

Returns:

length if success, null if failure.

substituteConstantVariables

public BitspecIrstream substituteConstantVariables(Map<String,Long> constantVariables)

Description copied from interface: IrStreamItem

Returns an IrStreamItem of the same type with all occurrences of the variables in the dictionary replaced by their values in the dictionary. Does not change the containing object. May return the object itself, or share sub-objects with it.

Specified by:

substituteConstantVariables in interface IrStreamItem

Parameters:

constantVariables - Map<String, Long> of variables to replace.

Returns:

IrStreamItem of the same type.

allDurationsInMicros

public TreeSet<Double> allDurationsInMicros(GeneralSpec generalSpec,
 NameEngine nameEngine)

Description copied from interface: IrStreamItem

Delivers a set of all the contained durations in microseconds. Dumb, in that it does not consider consecutive flashes or consecutive gaps. Also, durations that cannot be statically computed may be omitted, as well as duration arising from extents.

Specified by:

allDurationsInMicros in interface IrStreamItem

Parameters:

generalSpec -

nameEngine -

Returns:

constant

public boolean constant(NameEngine nameEngine)

Specified by:

constant in interface IrStreamItem

createParameterSpecs

public void createParameterSpecs(ParameterSpecs parameterSpecs)
                          throws InvalidNameException

Specified by:

createParameterSpecs in interface IrStreamItem

Overrides:

createParameterSpecs in class IrpObject

Throws:

InvalidNameException