Package org.harctoolbox.irp

Class ParameterSpec

java.lang.Object

org.harctoolbox.irp.IrpObject

org.harctoolbox.irp.ParameterSpec

All Implemented Interfaces:

Serializable, XmlExport

public final class ParameterSpec
extends IrpObject

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ParameterSpec(String str)
ParameterSpec(String name, boolean memory, int length)
ParameterSpec(String name, boolean memory, long min, long max)
ParameterSpec(String name, boolean memory, long min, long max, Expression deflt)
ParameterSpec(IrpParser.NameContext name, boolean hasMemory, IrpParser.NumberContext min, IrpParser.NumberContext max, IrpParser.ExpressionContext deflt)
ParameterSpec(IrpParser.Parameter_specContext ctx)

Method Summary

Modifier and Type	Method	Description
void	check(NameEngine nameEngine)
void	checkDomain(long value)
String	domainAsString()
boolean	equals(Object obj)
Expression	getDefault()
long	getMax()
long	getMin()
String	getName()
boolean	hasDefault()
int	hashCode()
boolean	hasMemory()
static void	initRandom(long seed)
static boolean	isStandardName(String name)
boolean	isWithinDomain(long x)
long	random()
long	random(Random rng)
Element	toElement(Document document)
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

Constructor Details

ParameterSpec

public ParameterSpec(String str)

ParameterSpec

public ParameterSpec(IrpParser.Parameter_specContext ctx)

ParameterSpec

public ParameterSpec(IrpParser.NameContext name,
 boolean hasMemory,
 IrpParser.NumberContext min,
 IrpParser.NumberContext max,
 IrpParser.ExpressionContext deflt)

ParameterSpec

public ParameterSpec(String name,
 boolean memory,
 long min,
 long max,
 Expression deflt)
              throws InvalidNameException

Throws:

InvalidNameException

ParameterSpec

public ParameterSpec(String name,
 boolean memory,
 long min,
 long max)
              throws InvalidNameException

Throws:

InvalidNameException

ParameterSpec

public ParameterSpec(String name,
 boolean memory,
 int length)
              throws InvalidNameException

Throws:

InvalidNameException

Method Details

isStandardName

public static boolean isStandardName(String name)

initRandom

public static void initRandom(long seed)

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.

check

public void check(NameEngine nameEngine)
           throws InvalidNameException,
DomainViolationException,
NameUnassignedException

Throws:

InvalidNameException

DomainViolationException

NameUnassignedException

checkDomain

public void checkDomain(long value)
                 throws DomainViolationException

Throws:

DomainViolationException

isWithinDomain

public boolean isWithinDomain(long x)

toElement

public Element toElement(Document document)

Specified by:

toElement in interface XmlExport

Overrides:

toElement in class IrpObject

Parameters:

document -

Returns:

domainAsString

public String domainAsString()

getName

public String getName()

getDefault

public Expression getDefault()

hasDefault

public boolean hasDefault()

getMin

public long getMin()

getMax

public long getMax()

hasMemory

public boolean hasMemory()

random

public long random()

random

public long random(Random rng)

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.

equals

public boolean equals(Object obj)

Specified by:

equals in class IrpObject

hashCode

public int hashCode()

Specified by:

hashCode in class IrpObject