Package org.harctoolbox.irp

Class Gap

java.lang.Object

org.harctoolbox.irp.IrpObject

org.harctoolbox.irp.Duration

org.harctoolbox.irp.Gap

All Implemented Interfaces:

Serializable, Floatable, IrStreamItem, XmlExport

public final class Gap
extends Duration

This class implements Gap as per Chapter 3.

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.harctoolbox.irp.Duration

nameOrNumber, time_periods, time_units, unit, us

Constructor Summary

Constructors

Constructor	Description
Gap(double us)
Gap(double d, String unit)
Gap(String str)
Gap(NameOrNumber non, String unit)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
protected Gap	evaluatedDuration(GeneralSpec generalSpec, NameEngine nameEngine)	Deliver an "evaluated" Duration (variables resolved) of the same subclass.
double	evaluateWithSign(GeneralSpec generalSpec, NameEngine nameEngine, double elapsed)
int	hashCode()
protected boolean	isOn()
Integer	numberOfBitSpecs()
Map<String,Object>	propertiesMap(int noProperties)
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)	Returns a computed IRP (-segment) string representation of current IrpObject.

Methods inherited from class org.harctoolbox.irp.Duration

allDurationsInMicros, assignmentVariables, constant, decode, endingDurationType, evaluate, evaluate, evaluate, extractPass, getTimeInUnits, getUnit, guessParameterLength, hasExtent, interleavingOk, interleavingOk, isEmpty, isOn, microSeconds, newDuration, newDuration, newDuration, newDuration, nonConstantBitFieldLength, numberOfBareDurations, numberOfBits, numberOfDurations, propertiesMap, recognize, render, startingDuratingType, toElement, toFloat, weight

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, updateStateWhenEntering, updateStateWhenExiting

Methods inherited from interface org.harctoolbox.xml.XmlExport

toDocument

Constructor Details

Gap

public Gap(String str)

Gap

public Gap(double us)

Gap

public Gap(double d,
 String unit)

Gap

public Gap(NameOrNumber non,
 String unit)

Method Details

substituteConstantVariables

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

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 Duration

evaluateWithSign

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

Specified by:

evaluateWithSign in class Duration

Throws:

IrpInvalidArgumentException

NameUnassignedException

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

Overrides:

toIrpString in class Duration

Parameters:

radix - Radix for parameters.

Returns:

Formatted string.

isOn

protected boolean isOn()

Specified by:

isOn in class Duration

hashCode

public int hashCode()

Overrides:

hashCode in class Duration

evaluatedDuration

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

Description copied from class: Duration

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

Specified by:

evaluatedDuration in class Duration

Parameters:

generalSpec -

nameEngine -

Returns:

Throws:

NameUnassignedException

IrpInvalidArgumentException

numberOfBitSpecs

Integer numberOfBitSpecs()

propertiesMap

Map<String,Object> propertiesMap(int noProperties)