Package org.harctoolbox.irp

Class Name

java.lang.Object

org.harctoolbox.irp.IrpObject

org.harctoolbox.irp.PrimaryItem

org.harctoolbox.irp.Name

All Implemented Interfaces:

Serializable, EquationSolving, Floatable, Numerical, XmlExport

public final class Name
extends PrimaryItem
implements Floatable

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Name(String name)
Name(IrpParser.NameContext ctx)

Method Summary

Modifier and Type	Method	Description
static void	checkName(String candidate)	Check the syntactical correctness of the name.
boolean	constant(NameEngine nameEngine)
boolean	equals(Object obj)
int	hashCode()
BitwiseParameter	invert(BitwiseParameter rhs, RecognizeData nameEngine)	Default implementation, for non-invertible expressions.
PrimaryItem	leftHandSide()	Default implementation.
Map<String,Object>	propertiesMap(boolean eval, GeneralSpec generalSpec, NameEngine nameEngine)	Generate a map of the properties in the very object.
PrimaryItem	substituteConstantVariables(Map<String,Long> constantVariables)	Returns a PrimaryItem of the same type with all occurrences of the variables in the dictionary replaced by their values in the dictionary.
BitwiseParameter	toBitwiseParameter(RecognizeData recognizeData)
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.
long	toLong()
static long	toLong(IrpParser.NameContext ctx, NameEngine nameEngine)
long	toLong(NameEngine nameEngine)	Produces a numerical result.
String	toString()
static String	toString(IrpParser.NameContext ctx)
static boolean	validName(String name)	Check the syntactical correctness of the name.
int	weight()	Returns a (somewhat arbitrary) measure of the complexity of the object.

Methods inherited from class org.harctoolbox.irp.PrimaryItem

newPrimaryItem, newPrimaryItem, newPrimaryItem

Methods inherited from class org.harctoolbox.irp.IrpObject

createParameterSpecs, getParseTree, numberOfBits, numberOfBitSpecs, numberOfInfiniteRepeats, prerender, propertiesMap, toDocument, toIrpString, 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

Name

public Name(IrpParser.NameContext ctx)

Name

public Name(String name)
     throws InvalidNameException

Throws:

InvalidNameException

Method Details

validName

public static boolean validName(String name)

Check the syntactical correctness of the name. This invokes a newly constructed parser, i.e. is comparatively expensive.

Parameters:

name - Name to be checked

Returns:

true iff the name is syntactically valid.

toLong

public static long toLong(IrpParser.NameContext ctx,
 NameEngine nameEngine)
                   throws NameUnassignedException

Throws:

NameUnassignedException

toString

public static String toString(IrpParser.NameContext ctx)

checkName

public static void checkName(String candidate)
                      throws InvalidNameException

Check the syntactical correctness of the name. This invokes a newly constructed parser, i.e. is comparatively expensive.

Parameters:

candidate - Name to be checked

Throws:

InvalidNameException

substituteConstantVariables

public PrimaryItem substituteConstantVariables(Map<String,Long> constantVariables)

Description copied from class: PrimaryItem

Returns a PrimaryItem 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 class PrimaryItem

Parameters:

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

Returns:

PrimaryItem of the same type.

equals

public boolean equals(Object obj)

Specified by:

equals in class IrpObject

hashCode

public int hashCode()

Specified by:

hashCode in class IrpObject

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

Parameters:

radix - Radix for parameters.

Returns:

Formatted string.

toLong

public long toLong(NameEngine nameEngine)
            throws NameUnassignedException

Description copied from interface: Numerical

Produces a numerical result.

Specified by:

toLong in interface Numerical

Parameters:

nameEngine - used to resolve names in expressions.

Returns:

result, long.

Throws:

NameUnassignedException

toLong

public long toLong()
            throws NameUnassignedException

Specified by:

toLong in interface Numerical

Throws:

NameUnassignedException

toElement

public Element toElement(Document document)

Specified by:

toElement in interface Floatable

Specified by:

toElement in interface XmlExport

Overrides:

toElement in class IrpObject

Returns:

toFloat

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

Description copied from interface: Floatable

Produces a floating result.

Specified by:

toFloat in interface Floatable

Returns:

Floating representation of class.

Throws:

NameUnassignedException

constant

public boolean constant(NameEngine nameEngine)

Specified by:

constant in interface Floatable

Specified by:

constant in class PrimaryItem

toString

public String toString()

Overrides:

toString in class IrpObject

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(boolean eval,
 GeneralSpec generalSpec,
 NameEngine nameEngine)

Description copied from class: PrimaryItem

Generate a map of the properties in the very object.

Specified by:

propertiesMap in class PrimaryItem

Parameters:

eval - If true, evaluate names.

Returns:

invert

public BitwiseParameter invert(BitwiseParameter rhs,
 RecognizeData nameEngine)

Description copied from class: PrimaryItem

Default implementation, for non-invertible expressions.

Specified by:

invert in interface EquationSolving

Overrides:

invert in class PrimaryItem

Returns:

null

leftHandSide

public PrimaryItem leftHandSide()

Description copied from class: PrimaryItem

Default implementation.

Specified by:

leftHandSide in interface EquationSolving

Overrides:

leftHandSide in class PrimaryItem

Returns:

this

toBitwiseParameter

public BitwiseParameter toBitwiseParameter(RecognizeData recognizeData)

Specified by:

toBitwiseParameter in interface Numerical