Package org.harctoolbox.irp

Class Duration

java.lang.Object

org.harctoolbox.irp.IrpObject

org.harctoolbox.irp.Duration

All Implemented Interfaces:

Serializable, Floatable, IrStreamItem, XmlExport

Direct Known Subclasses:

Extent, Flash, Gap

public abstract class Duration
extends IrpObject
implements IrStreamItem, Floatable

This class implements Durations in Chapter 3 and 4. Depends on its Protocol (GeneralSpec and NameEngine), except for this, it is immutable.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected NameOrNumber	nameOrNumber
protected Double	time_periods
protected Double	time_units
protected String	unit
protected Double	us

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Duration(double us)
protected	Duration(double d, String unit)
protected	Duration(IrpParser.Name_or_numberContext ctx, String unit)
protected	Duration(NameOrNumber nameOrNumber, String unit)

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)
double	evaluate(GeneralSpec generalSpec, NameEngine nameEngine)
double	evaluate(GeneralSpec generalSpec, NameEngine nameEngine, double elapsed)
void	evaluate(RenderData renderData, List<BitSpec> bitSpecStack)
protected abstract Duration	evaluatedDuration(GeneralSpec generalSpec, NameEngine nameEngine)	Deliver an "evaluated" Duration (variables resolved) of the same subclass.
abstract double	evaluateWithSign(GeneralSpec generalSpec, NameEngine nameEngine, double elapsed)
BareIrStream	extractPass(IrSignal.Pass pass, IrStream.PassExtractorState state)
double	getTimeInUnits()
String	getUnit()
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)
final boolean	isEmpty(NameEngine nameEngine)
protected abstract boolean	isOn()
static boolean	isOn(int index)
Double	microSeconds(GeneralSpec generalSpec, NameEngine nameEngine)
static Duration	newDuration(String str)
static Duration	newDuration(IrpParser.DurationContext d)
static Duration	newDuration(IrpParser.ExtentContext e)
static Duration	newDuration(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.
Map<String,Object>	propertiesMap(int noProperties)
Map<String,Object>	propertiesMap(GeneralSpec generalSpec, NameEngine nameEngine)
protected void	recognize(RecognizeData recognizeData, double actual, double wanted, boolean isLast)
void	render(RenderData renderData, List<BitSpec> bitSpecs)
DurationType	startingDuratingType(DurationType last, boolean gapFlashBitSpecs)
Element	toElement(Document document)
double	toFloat(GeneralSpec generalSpec, NameEngine nameEngine)	Produces a floating result.
String	toIrpString(int radix)	Returns a computed IRP (-segment) string representation of current IrpObject.
int	weight()	Returns a (somewhat arbitrary) measure of the complexity of the object.

Methods inherited from class org.harctoolbox.irp.IrpObject

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

createParameterSpecs, numberOfBitSpecs, numberOfInfiniteRepeats, propertiesMap, substituteConstantVariables, updateStateWhenEntering, updateStateWhenExiting

Methods inherited from interface org.harctoolbox.xml.XmlExport

toDocument

Field Details

us

protected Double us

time_periods

protected Double time_periods

time_units

protected Double time_units

nameOrNumber

protected NameOrNumber nameOrNumber

unit

protected String unit

Constructor Details

Duration

protected Duration(double d,
 String unit)

Duration

protected Duration(double us)

Duration

protected Duration(IrpParser.Name_or_numberContext ctx,
 String unit)

Duration

protected Duration(NameOrNumber nameOrNumber,
 String unit)

Method Details

newDuration

public static Duration newDuration(String str)

newDuration

public static Duration newDuration(ParserDriver parserDriver)

newDuration

public static Duration newDuration(IrpParser.DurationContext d)

newDuration

public static Duration newDuration(IrpParser.ExtentContext e)

isOn

public static boolean isOn(int index)

constant

public boolean constant(NameEngine nameEngine)

Specified by:

constant in interface Floatable

Specified by:

constant in interface IrStreamItem

hashCode

public int hashCode()

Specified by:

hashCode in class IrpObject

equals

public boolean equals(Object obj)

Specified by:

equals in class IrpObject

evaluateWithSign

public abstract double evaluateWithSign(GeneralSpec generalSpec,
 NameEngine nameEngine,
 double elapsed)
                                 throws NameUnassignedException,
IrpInvalidArgumentException

Throws:

NameUnassignedException

IrpInvalidArgumentException

evaluate

public double evaluate(GeneralSpec generalSpec,
 NameEngine nameEngine,
 double elapsed)
                throws NameUnassignedException,
IrpInvalidArgumentException

Throws:

NameUnassignedException

IrpInvalidArgumentException

evaluate

public double evaluate(GeneralSpec generalSpec,
 NameEngine nameEngine)
                throws NameUnassignedException,
IrpInvalidArgumentException

Throws:

NameUnassignedException

IrpInvalidArgumentException

evaluatedDuration

protected abstract Duration evaluatedDuration(GeneralSpec generalSpec,
 NameEngine nameEngine)
                                       throws NameUnassignedException,
IrpInvalidArgumentException

Deliver an "evaluated" Duration (variables resolved) of the same subclass.

Parameters:

generalSpec -

nameEngine -

Returns:

Throws:

NameUnassignedException

IrpInvalidArgumentException

isEmpty

public final boolean isEmpty(NameEngine nameEngine)
                      throws NameUnassignedException,
IrpInvalidArgumentException

Specified by:

isEmpty in interface IrStreamItem

Throws:

NameUnassignedException

IrpInvalidArgumentException

toFloat

public double toFloat(GeneralSpec generalSpec,
 NameEngine nameEngine)
               throws NameUnassignedException,
IrpInvalidArgumentException

Description copied from interface: Floatable

Produces a floating result.

Specified by:

toFloat in interface Floatable

Parameters:

generalSpec -

nameEngine -

Returns:

Floating representation of class.

Throws:

NameUnassignedException

IrpInvalidArgumentException

render

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

Specified by:

render in interface IrStreamItem

Throws:

NameUnassignedException

decode

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

Specified by:

decode in interface IrStreamItem

Throws:

SignalRecognitionException

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 Floatable

Specified by:

toElement in interface XmlExport

Overrides:

toElement in class IrpObject

Parameters:

document -

Returns:

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 Floatable

Specified by:

toIrpString in interface IrStreamItem

Specified by:

toIrpString in class IrpObject

Parameters:

radix - Radix for parameters.

Returns:

Formatted string.

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.

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:

recognize

protected void recognize(RecognizeData recognizeData,
 double actual,
 double wanted,
 boolean isLast)
                  throws SignalRecognitionException

Throws:

SignalRecognitionException

isOn

protected abstract boolean isOn()

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.

getUnit

public String getUnit()

getTimeInUnits

public double getTimeInUnits()
                      throws InvalidArgumentException

Throws:

InvalidArgumentException

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:

numberOfBitSpecs

Integer numberOfBitSpecs()

propertiesMap

Map<String,Object> propertiesMap(int noProperties)