Package org.harctoolbox.irp

Class GeneralSpec

java.lang.Object

org.harctoolbox.irp.IrpObject

org.harctoolbox.irp.GeneralSpec

All Implemented Interfaces:

Serializable, AggregateLister, XmlExport

public final class GeneralSpec
extends IrpObject
implements AggregateLister

This class implements GeneralSpec as given in Chapter 2 of Dixon: "Specification of IRP Notation", second draft. This class is immutable; can only be build by the constructor, and not altered.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final BitDirection	DEFAULT_BITDIRECTION
static final double	DEFAULT_FREQUENCY
static final double	DEFAULT_UNIT

Constructor Summary

Constructors

Constructor	Description
GeneralSpec()	This constructor is intended for debugging and testing only
GeneralSpec(String str)
GeneralSpec(BitDirection bitDirection, Double unit, Double frequency)
GeneralSpec(BitDirection bitDirection, Double unit, Double frequency, Double dutyCycle)	This constructor is intended for debugging and testing only.
GeneralSpec(GeneralSpec src)	Copy constructor.
GeneralSpec(IrpParser.Generalspec_listContext ctx)
GeneralSpec(IrpParser.GeneralspecContext ctx)
GeneralSpec(IrpParser.ProtocolContext ctx)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
BitDirection	getBitDirection()
Double	getDutyCycle()
Double	getFrequency()
double	getFrequencyWitDefault()
double	getUnit()
int	hashCode()
Map<String,Object>	propertiesMap(GeneralSpec generalSpec, NameEngine nameEngine)
Element	toElement(Document document)
String	toIrpString(boolean usePeriods)
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, 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

Field Details

DEFAULT_BITDIRECTION

public static final BitDirection DEFAULT_BITDIRECTION

DEFAULT_FREQUENCY

public static final double DEFAULT_FREQUENCY

See Also:

• Constant Field Values

DEFAULT_UNIT

public static final double DEFAULT_UNIT

See Also:

• Constant Field Values

Constructor Details

GeneralSpec

public GeneralSpec(BitDirection bitDirection,
 Double unit,
 Double frequency,
 Double dutyCycle)

This constructor is intended for debugging and testing only.

Parameters:

bitDirection -

unit -

frequency -

dutyCycle -

GeneralSpec

public GeneralSpec(BitDirection bitDirection,
 Double unit,
 Double frequency)

GeneralSpec

public GeneralSpec(GeneralSpec src)

Copy constructor.

Parameters:

src -

GeneralSpec

public GeneralSpec()

This constructor is intended for debugging and testing only

GeneralSpec

public GeneralSpec(String str)
            throws IrpInvalidArgumentException

Throws:

IrpInvalidArgumentException

GeneralSpec

public GeneralSpec(IrpParser.ProtocolContext ctx)
            throws IrpInvalidArgumentException

Throws:

IrpInvalidArgumentException

GeneralSpec

public GeneralSpec(IrpParser.GeneralspecContext ctx)
            throws IrpInvalidArgumentException

Throws:

IrpInvalidArgumentException

GeneralSpec

public GeneralSpec(IrpParser.Generalspec_listContext ctx)
            throws IrpInvalidArgumentException

Parameters:

ctx -

Throws:

IrpInvalidArgumentException

Method Details

equals

public boolean equals(Object obj)

Specified by:

equals in class IrpObject

hashCode

public int hashCode()

Specified by:

hashCode in class IrpObject

getBitDirection

public BitDirection getBitDirection()

getFrequency

public Double getFrequency()

getFrequencyWitDefault

public double getFrequencyWitDefault()

getUnit

public double getUnit()

getDutyCycle

public Double getDutyCycle()

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 class IrpObject

Parameters:

radix - Radix for parameters.

Returns:

Formatted string.

toIrpString

public String toIrpString(boolean usePeriods)

toElement

public Element toElement(Document document)

Specified by:

toElement in interface XmlExport

Overrides:

toElement in class IrpObject

Parameters:

document -

Returns:

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 class IrpObject

Returns:

non-negative integer.

propertiesMap

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

Specified by:

propertiesMap in interface AggregateLister