Package org.harctoolbox.irp

Class Assignment

java.lang.Object

org.harctoolbox.irp.IrpObject

org.harctoolbox.irp.Assignment

All Implemented Interfaces:

Serializable, IrStreamItem, Numerical, XmlExport

public final class Assignment
extends IrpObject
implements IrStreamItem, Numerical

This class models assignments as defined in Chapter 11.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Assignment(String str)
Assignment(IrpParser.AssignmentContext assignment)
Assignment(IrpParser.NameContext name, IrpParser.ExpressionContext be)
Assignment(Name name, Expression expression)

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	decode(RecognizeData recognizeData, List<BitSpec> bitSpecStack, boolean isLast)
DurationType	endingDurationType(DurationType last, boolean gapFlashBitSpecs)
boolean	equals(Object obj)
void	evaluate(RenderData renderData, List<BitSpec> bitSpecStack)
BareIrStream	extractPass(IrSignal.Pass pass, IrStream.PassExtractorState state)
String	getName()
Integer	guessParameterLength(String name)	Tries to infer the bit-length of the parameter with name as the argument.
boolean	hasExtent()
int	hashCode()
boolean	interleavingOk(DurationType last, boolean gapFlashBitSpecs)
boolean	interleavingOk(DurationType toCheck, DurationType last, boolean gapFlashBitSpecs)
boolean	isEmpty(NameEngine nameEngine)
Double	microSeconds(GeneralSpec generalSpec, NameEngine nameEngine)
boolean	nonConstantBitFieldLength()
Integer	numberOfBareDurations()
Integer	numberOfDurations()	Upper limit of the number of (interleaving) durations in the rendered signal.
static long	parse(String str, NameEngine nameEngine)
Map<String,Object>	propertiesMap(GeneralSpec generalSpec, NameEngine nameEngine)
void	render(RenderData renderData, List<BitSpec> bitSpecs)
DurationType	startingDuratingType(DurationType last, boolean gapFlashBitSpecs)
Assignment	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.
BitwiseParameter	toBitwiseParameter(RecognizeData recognizeData)
Element	toElement(Document document)
String	toIrpString(int radix)	Returns a computed IRP (-segment) string representation of current IrpObject.
long	toLong()
long	toLong(NameEngine nameEngine)	Produces a numerical result.
int	weight()	Returns a (somewhat arbitrary) measure of the complexity of the object.

Methods inherited from class org.harctoolbox.irp.IrpObject

createParameterSpecs, getParseTree, numberOfBits, numberOfBitSpecs, numberOfInfiniteRepeats, 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

Methods inherited from interface org.harctoolbox.irp.IrStreamItem

createParameterSpecs, numberOfBits, numberOfBitSpecs, numberOfInfiniteRepeats, propertiesMap, updateStateWhenEntering, updateStateWhenExiting

Methods inherited from interface org.harctoolbox.xml.XmlExport

toDocument

Constructor Details

Assignment

public Assignment(String str)

Assignment

public Assignment(IrpParser.AssignmentContext assignment)

Assignment

public Assignment(IrpParser.NameContext name,
 IrpParser.ExpressionContext be)

Assignment

public Assignment(Name name,
 Expression expression)

Method Details

parse

public static long parse(String str,
 NameEngine nameEngine)
                  throws NameUnassignedException

Throws:

NameUnassignedException

substituteConstantVariables

public Assignment 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.

hashCode

public int hashCode()

Specified by:

hashCode in class IrpObject

equals

public boolean equals(Object obj)

Specified by:

equals in class IrpObject

isEmpty

public boolean isEmpty(NameEngine nameEngine)

Specified by:

isEmpty in interface IrStreamItem

toLong

public long toLong(NameEngine nameEngine)
            throws NameUnassignedException

Description copied from interface: Numerical

Produces a numerical result.

Specified by:

toLong in interface Numerical

Parameters:

nameEngine - used to resolve names in expressions.

Returns:

result, long.

Throws:

NameUnassignedException

toBitwiseParameter

public BitwiseParameter toBitwiseParameter(RecognizeData recognizeData)

Specified by:

toBitwiseParameter in interface Numerical

toLong

public long toLong()
            throws NameUnassignedException

Specified by:

toLong in interface Numerical

Throws:

NameUnassignedException

getName

public String getName()

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.

render

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

Specified by:

render in interface IrStreamItem

Throws:

NameUnassignedException

evaluate

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

Specified by:

evaluate in interface IrStreamItem

Throws:

NameUnassignedException

extractPass

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

Specified by:

extractPass in interface IrStreamItem

toElement

public Element toElement(Document document)

Specified by:

toElement in interface XmlExport

Overrides:

toElement in class IrpObject

Parameters:

document -

Returns:

numberOfBareDurations

public Integer numberOfBareDurations()

Specified by:

numberOfBareDurations 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.

decode

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

Specified by:

decode in interface IrStreamItem

Throws:

SignalRecognitionException

interleavingOk

public boolean interleavingOk(DurationType last,
 boolean gapFlashBitSpecs)

Specified by:

interleavingOk in interface IrStreamItem

Parameters:

last -

gapFlashBitSpecs -

Returns:

interleavingOk

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

Specified by:

interleavingOk in interface IrStreamItem

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

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

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

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.

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