Package org.harctoolbox.irp

Interface IrStreamItem

All Superinterfaces:

XmlExport

All Known Implementing Classes:

Assignment, BareIrStream, BitspecIrstream, Duration, Extent, FiniteBitField, Flash, Gap, IrStream, Variation

public interface IrStreamItem
extends XmlExport

This interface describes the things that make up an IRStream.

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> bitSpecStack, boolean isLast)
DurationType	endingDurationType(DurationType last, boolean gapFlashBitSpecs)
void	evaluate(RenderData renderData, List<BitSpec> bitSpecStack)
BareIrStream	extractPass(IrSignal.Pass pass, IrStream.PassExtractorState state)
Integer	guessParameterLength(String name)	Tries to infer the bit-length of the parameter with name as the argument.
boolean	hasExtent()
boolean	interleavingOk(DurationType last, boolean gapFlashBitSpecs)
boolean	interleavingOk(DurationType toCheck, DurationType last, boolean gapFlashBitSpecs)
boolean	isEmpty(NameEngine nameEngine)
Double	microSeconds(GeneralSpec generalSpec, NameEngine nameEngine)
static IrStreamItem	newIrStreamItem(String str)
static IrStreamItem	newIrStreamItem(IrpParser.Irstream_itemContext ctx)
static IrStreamItem	newIrStreamItem(ParserDriver parserDriver)
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(int noProperites)
Map<String,Object>	propertiesMap(GeneralSpec generalSpec, NameEngine nameEngine)
void	render(RenderData renderData, List<BitSpec> bitSpecs)
DurationType	startingDuratingType(DurationType last, boolean gapFlashBitSpecs)
IrStreamItem	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.
String	toIrpString(int radix)
void	updateStateWhenEntering(IrSignal.Pass pass, IrStream.PassExtractorState state)
void	updateStateWhenExiting(IrSignal.Pass pass, IrStream.PassExtractorState state)
int	weight()

Methods inherited from interface org.harctoolbox.xml.XmlExport

toDocument, toElement

Method Details

newIrStreamItem

static IrStreamItem newIrStreamItem(String str)

newIrStreamItem

static IrStreamItem newIrStreamItem(ParserDriver parserDriver)

newIrStreamItem

static IrStreamItem newIrStreamItem(IrpParser.Irstream_itemContext ctx)

isEmpty

boolean isEmpty(NameEngine nameEngine)
         throws NameUnassignedException,
IrpInvalidArgumentException

Throws:

NameUnassignedException

IrpInvalidArgumentException

interleavingOk

boolean interleavingOk(DurationType last,
 boolean gapFlashBitSpecs)

Parameters:

last -

gapFlashBitSpecs -

Returns:

interleavingOk

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

endingDurationType

DurationType endingDurationType(DurationType last,
 boolean gapFlashBitSpecs)

startingDuratingType

DurationType startingDuratingType(DurationType last,
 boolean gapFlashBitSpecs)

numberOfBits

Integer numberOfBits()

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

Returns:

numberOfBareDurations

Integer numberOfBareDurations()

numberOfDurations

Integer numberOfDurations()

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

Returns:

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

numberOfBitSpecs

Integer numberOfBitSpecs()

allDurationsInMicros

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

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.

Parameters:

generalSpec -

nameEngine -

Returns:

extractPass

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

updateStateWhenEntering

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

updateStateWhenExiting

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

render

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

Throws:

NameUnassignedException

hasExtent

boolean hasExtent()

assignmentVariables

Set<String> assignmentVariables()

propertiesMap

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

propertiesMap

Map<String,Object> propertiesMap(int noProperites)

microSeconds

Double microSeconds(GeneralSpec generalSpec,
 NameEngine nameEngine)

toIrpString

String toIrpString(int radix)

numberOfInfiniteRepeats

int numberOfInfiniteRepeats()

weight

int weight()

constant

boolean constant(NameEngine nameEngine)

evaluate

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

Throws:

NameUnassignedException

decode

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

Throws:

SignalRecognitionException

nonConstantBitFieldLength

boolean nonConstantBitFieldLength()

guessParameterLength

Integer guessParameterLength(String name)

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

Parameters:

name - Name of parameter sought.

Returns:

length if success, null if failure.

substituteConstantVariables

IrStreamItem 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. Does not change the containing object. May return the object itself, or share sub-objects with it.

Parameters:

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

Returns:

IrStreamItem of the same type.

createParameterSpecs

void createParameterSpecs(ParameterSpecs parameterSpecs)
                   throws InvalidNameException

Throws:

InvalidNameException