org.harctoolbox.IrpMaster

Class IrpMaster

java.lang.Object

org.harctoolbox.IrpMaster.IrpMaster

All Implemented Interfaces:

Serializable

public class IrpMaster
extends Object
implements Serializable

This class is a data bases manager for the data base of IRP protocols. It reads a configuration file containing definitions for IR format in the IRP-Notation.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IrpMaster(InputStream inputStream) Like the other version, but reads from an InputStream instead.
IrpMaster(Reader reader) Like the other version, but reads from a Reader instead.
IrpMaster(String datafile) Sets up a new IrpMaster from its first argument.

Method Summary

Modifier and Type	Method and Description
String	getDocumentation(String name)
String	getEfcTranslation(String name)
String	getIrp(String name)
static String	getIrp(String configFilename, String protocolName) Static version of getIrp.
Set<String>	getNames()
ArrayList<Short>	getUeiProtocol(String name)
boolean	isKnown(String protocol)
static boolean	isKnown(String protocolsPath, String protocol)
static void	main(String[] args)
static int	makeHex(String outFile, boolean append, String configFileName, String preamble, String protocolName, String device, String OBC) This function closely mimics the API of the MakeHex dll entry function.
static String	makeHex(String configFileName, String protocolName, int device, int subdevice, int obc) Returns the Pronto form of the IR signal.
static int	makeHexIRP(String outFile, boolean append, String irp, String preamble, String protocolName, int device, int subdevice, int obc)
static int	makeHexIRP(String outFile, boolean append, String irp, String preamble, String protocolName, String device, String OBC)
static String	makeHexIRP(String irp, int device, int subdevice, int obc)
Protocol	newProtocol(String name) Constructs a new Protocol with requested name, taken from the configuration file/data base within the current IrpMaster.
Protocol	newProtocolOrNull(String name)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IrpMaster

public IrpMaster(InputStream inputStream)
          throws IncompatibleArgumentException

Like the other version, but reads from an InputStream instead.

Parameters:

inputStream -

Throws:

IncompatibleArgumentException

IrpMaster

public IrpMaster(Reader reader)
          throws IncompatibleArgumentException

Like the other version, but reads from a Reader instead.

Parameters:

reader -

Throws:

IncompatibleArgumentException

IrpMaster

public IrpMaster(String datafile)
          throws FileNotFoundException,
                 IncompatibleArgumentException

Sets up a new IrpMaster from its first argument.

Parameters:

datafile - Configuration file for IRP protocols.

Throws:

FileNotFoundException

IncompatibleArgumentException

Method Detail

isKnown

public boolean isKnown(String protocol)

isKnown

public static boolean isKnown(String protocolsPath,
                              String protocol)
                       throws FileNotFoundException,
                              IncompatibleArgumentException

Throws:

FileNotFoundException

IncompatibleArgumentException

getIrp

public String getIrp(String name)

getNames

public Set<String> getNames()

getDocumentation

public String getDocumentation(String name)

getEfcTranslation

public String getEfcTranslation(String name)

getUeiProtocol

public ArrayList<Short> getUeiProtocol(String name)

newProtocol

public Protocol newProtocol(String name)
                     throws UnassignedException,
                            ParseException,
                            UnknownProtocolException

Constructs a new Protocol with requested name, taken from the configuration file/data base within the current IrpMaster.

Parameters:

name - protocol name in the configuration file/data base

Returns:

newly parsed protocol

Throws:

UnassignedException

ParseException

UnknownProtocolException

newProtocolOrNull

public Protocol newProtocolOrNull(String name)
                           throws UnassignedException,
                                  ParseException,
                                  UnknownProtocolException

Throws:

UnassignedException

ParseException

UnknownProtocolException

main

public static void main(String[] args)

Parameters:

args - See the usage message.

getIrp

public static String getIrp(String configFilename,
                            String protocolName)

Static version of getIrp.

Parameters:

configFilename -

protocolName -

Returns:

String with IRP representation

makeHex

public static int makeHex(String outFile,
                          boolean append,
                          String configFileName,
                          String preamble,
                          String protocolName,
                          String device,
                          String OBC)

This function closely mimics the API of the MakeHex dll entry function. It returns its payload contained in the file given as first argument.

Parameters:

outFile - Path to the file to which the Pronto form is to be exported.

append - True iff appending to Outfile, otherwise it is truncated.

configFileName - Pathname to configuration file, typically IrpProtocols.ini.

preamble - If non-null, a header string that is prefixed (followed by newline) to the Pronto export. If null, no header is prefixed.

protocolName - Name of protocol

device - The device and subdevice as a string, with a dot separating the two.

OBC - The OBC value as a string.

Returns:

return code: 1: Success, 0: Unable to open output file, -1: Unable to open configuration file, -2: Error in IRP processing, -3: Other error

makeHex

public static String makeHex(String configFileName,
                             String protocolName,
                             int device,
                             int subdevice,
                             int obc)

Returns the Pronto form of the IR signal.

Parameters:

configFileName -

protocolName -

device -

subdevice -

obc -

Returns:

String in Pronto format representing the IR signal.

makeHexIRP

public static int makeHexIRP(String outFile,
                             boolean append,
                             String irp,
                             String preamble,
                             String protocolName,
                             String device,
                             String OBC)

Parameters:

outFile -

append -

irp -

preamble -

protocolName -

device -

OBC -

Returns:

return code: 1: Success, 0: Unable to open output file, -1: Unable to open configuration file, -2: Error in IRP processing, -3: Other error

makeHexIRP

public static int makeHexIRP(String outFile,
                             boolean append,
                             String irp,
                             String preamble,
                             String protocolName,
                             int device,
                             int subdevice,
                             int obc)

Parameters:

outFile -

append -

irp -

preamble -

protocolName -

device -

subdevice -

obc -

Returns:

return code: 1: Success, 0: Unable to open output file, -1: Unable to open configuration file, -2: Error in IRP processing, -3: Other error

makeHexIRP

public static String makeHexIRP(String irp,
                                int device,
                                int subdevice,
                                int obc)

Parameters:

irp -

device -

subdevice -

obc -

Returns:

return code: 1: Success, 0: Unable to open output file, -1: Unable to open configuration file, -2: Error in IRP processing, -3: Other error