Package org.harctoolbox.irp

Class FiniteBitField

java.lang.Object

org.harctoolbox.irp.IrpObject

org.harctoolbox.irp.BitField

org.harctoolbox.irp.FiniteBitField

All Implemented Interfaces:

Serializable, EquationSolving, IrStreamItem, Numerical, XmlExport

public final class FiniteBitField
extends BitField
implements IrStreamItem

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAXWIDTH	Max length of a BitField in this implementation.

Constructor Summary

Constructors

Constructor	Description
FiniteBitField(long data, long width, long chop, boolean complement, boolean reverse)
FiniteBitField(String str)
FiniteBitField(String name, long width)
FiniteBitField(String name, long width, boolean complement)
FiniteBitField(IrpParser.Finite_bitfieldContext 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> 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)
long	getWidth(NameEngine nameEngine)
BitwiseParameter	getWidth(RecognizeData recognizeData)
Integer	guessParameterLength(String name)	Tries to infer the bit-length of the parameter with name as the argument.
int	hashCode()
boolean	interleavingOk(DurationType last, boolean gapFlashBitSpecs)
boolean	interleavingOk(DurationType toCheck, DurationType last, boolean gapFlashBitSpecs)
BitwiseParameter	invert(BitwiseParameter rhs, RecognizeData recognizeData)
static FiniteBitField	newFiniteBitField(IrpParser.Finite_bitfieldContext ctx)
boolean	nonConstantBitFieldLength()
Integer	numberOfBits()	Computes the number of encoded bits, which may differ from the number of payload bits, in the case of redundancy.
Integer	numberOfDurations()	Upper limit of the number of (interleaving) durations in the rendered signal.
Map<String,Object>	propertiesMap(boolean eval, GeneralSpec generalSpec, NameEngine nameEngine)
Map<String,Object>	propertiesMap(GeneralSpec generalSpec, NameEngine nameEngine)
void	render(RenderData renderData, List<BitSpec> bitSpecs)
static void	setAllowLargeBitfields(boolean aAllowLargeBitfields)
DurationType	startingDuratingType(DurationType last, boolean gapFlashBitSpecs)
FiniteBitField	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	toBinaryString(NameEngine nameEngine)
String	toBinaryString(NameEngine nameEngine, boolean reverse)
BitwiseParameter	toBitwiseParameter(RecognizeData nameResolver)
Element	toElement(Document document)
String	toIrpString(int radix)	Returns a computed IRP (-segment) string representation of current IrpObject.
static long	toLong(long data, long width, long chop, boolean complement, boolean reverse)
long	toLong(NameEngine nameResolver)	Produces a numerical result.
String	toString(NameEngine nameEngine)
int	weight()	Returns a (somewhat arbitrary) measure of the complexity of the object.

Methods inherited from class org.harctoolbox.irp.BitField

getChop, getChop, getData, hasChop, hasExtent, isComplement, isEmpty, leftHandSide, microSeconds, newBitField, newBitField, newBitField, numberOfBareDurations, parse, toLong

Methods inherited from class org.harctoolbox.irp.IrpObject

getParseTree, 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

hasExtent, isEmpty, microSeconds, numberOfBareDurations, numberOfBitSpecs, numberOfInfiniteRepeats, propertiesMap, updateStateWhenEntering, updateStateWhenExiting

Methods inherited from interface org.harctoolbox.xml.XmlExport

toDocument

Field Details

MAXWIDTH

public static final int MAXWIDTH

Max length of a BitField in this implementation.

See Also:

• Constant Field Values

Constructor Details

FiniteBitField

public FiniteBitField(String str)

FiniteBitField

public FiniteBitField(String name,
 long width)
               throws InvalidNameException

Throws:

InvalidNameException

FiniteBitField

public FiniteBitField(String name,
 long width,
 boolean complement)
               throws InvalidNameException

Throws:

InvalidNameException

FiniteBitField

public FiniteBitField(long data,
 long width,
 long chop,
 boolean complement,
 boolean reverse)
               throws InvalidNameException

Throws:

InvalidNameException

FiniteBitField

public FiniteBitField(IrpParser.Finite_bitfieldContext ctx)

Method Details

newFiniteBitField

public static FiniteBitField newFiniteBitField(IrpParser.Finite_bitfieldContext ctx)

setAllowLargeBitfields

public static void setAllowLargeBitfields(boolean aAllowLargeBitfields)

Parameters:

aAllowLargeBitfields - the allowLargeBitfields to set

toLong

public static long toLong(long data,
 long width,
 long chop,
 boolean complement,
 boolean reverse)

substituteConstantVariables

public FiniteBitField 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

Specified by:

substituteConstantVariables in class BitField

Parameters:

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

Returns:

IrStreamItem of the same type.

equals

public boolean equals(Object obj)

Overrides:

equals in class BitField

hashCode

public int hashCode()

Overrides:

hashCode in class BitField

toLong

public long toLong(NameEngine nameResolver)
            throws NameUnassignedException

Description copied from interface: Numerical

Produces a numerical result.

Specified by:

toLong in interface Numerical

Parameters:

nameResolver - used to resolve names in expressions.

Returns:

result, long.

Throws:

NameUnassignedException

toBitwiseParameter

public BitwiseParameter toBitwiseParameter(RecognizeData nameResolver)

Specified by:

toBitwiseParameter in interface Numerical

toBinaryString

public String toBinaryString(NameEngine nameEngine,
 boolean reverse)
                      throws NameUnassignedException

Throws:

NameUnassignedException

toBinaryString

public String toBinaryString(NameEngine nameEngine)
                      throws NameUnassignedException

Throws:

NameUnassignedException

getWidth

public long getWidth(NameEngine nameEngine)
              throws NameUnassignedException

Specified by:

getWidth in class BitField

Throws:

NameUnassignedException

getWidth

public BitwiseParameter getWidth(RecognizeData recognizeData)

Specified by:

getWidth in class BitField

toString

public String toString(NameEngine nameEngine)

Specified by:

toString in class BitField

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:

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:

decode

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

Specified by:

decode in interface IrStreamItem

Throws:

SignalRecognitionException

invert

public BitwiseParameter invert(BitwiseParameter rhs,
 RecognizeData recognizeData)
                        throws NameUnassignedException

Specified by:

invert in interface EquationSolving

Specified by:

invert in class BitField

Throws:

NameUnassignedException

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

Overrides:

weight in class BitField

Returns:

non-negative integer.

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

propertiesMap

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

Overrides:

propertiesMap in class BitField

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.

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

Overrides:

constant in class BitField

createParameterSpecs

public void createParameterSpecs(ParameterSpecs parameterSpecs)
                          throws InvalidNameException

Specified by:

createParameterSpecs in interface IrStreamItem

Overrides:

createParameterSpecs in class IrpObject

Throws:

InvalidNameException