org.harctoolbox.girr

Class Remote

java.lang.Object

org.harctoolbox.girr.Remote

All Implemented Interfaces:

Serializable

public class Remote
extends Object
implements Serializable

This class describes a remote in Girr. A Remote is essentially an abstraction of a hand-held "clicker" for controlling one device. It has a name for identification, and a number of comment-like text fields. Most importantly, it has a dictionary of Commands, indexed by their names.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Remote(Element element) XML import function.
Remote(IrSignal irSignal, String name, String comment, String deviceName) This constructor constructs a Remote from one single IrSignal.
Remote(String name, String manufacturer, String model, String deviceClass, String remoteName, String comment, String notes, HashMap<String,Command> commands, HashMap<String,HashMap<String,String>> applicationParameters) Convenience version of the general constructor, with default values.
Remote(String name, String manufacturer, String model, String deviceClass, String remoteName, String comment, String notes, HashMap<String,Command> commands, HashMap<String,HashMap<String,String>> applicationParameters, String protocol, HashMap<String,Long> parameters) Construct a Remote from its arguments, general case.

Method Summary

Modifier and Type	Method and Description
void	addFormat(Command.CommandTextFormat format, int repeatCount) Applies the format argument to all Command's in the Remote.
HashMap<String,HashMap<String,String>>	getApplicationParameters()
Command	getCommand(String commandName)
HashMap<String,Command>	getCommands()
String	getComment()
String	getDeviceClass()
String	getManufacturer()
String	getModel()
String	getName()
String	getNotes()
String	getRemoteName()
boolean	hasThisProtocol(String protocolName) Returns true if and only if all contained commands has the protocol in the argument.
Element	xmlExport(Document doc, boolean fatRaw, boolean generateRaw, boolean generateCcf, boolean generateParameters) XML export function.

Methods inherited from class java.lang.Object

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

Constructor Detail

Remote

public Remote(Element element)
       throws ParseException,
              IrpMasterException

XML import function.

Parameters:

element - Element to read from.

Throws:

ParseException

IrpMasterException

Remote

public Remote(String name,
              String manufacturer,
              String model,
              String deviceClass,
              String remoteName,
              String comment,
              String notes,
              HashMap<String,Command> commands,
              HashMap<String,HashMap<String,String>> applicationParameters,
              String protocol,
              HashMap<String,Long> parameters)

Construct a Remote from its arguments, general case.

Parameters:

name -

manufacturer -

model -

deviceClass -

remoteName -

comment -

notes -

commands -

applicationParameters -

protocol -

parameters -

Remote

public Remote(String name,
              String manufacturer,
              String model,
              String deviceClass,
              String remoteName,
              String comment,
              String notes,
              HashMap<String,Command> commands,
              HashMap<String,HashMap<String,String>> applicationParameters)

Convenience version of the general constructor, with default values.

Parameters:

name -

manufacturer -

model -

deviceClass -

remoteName -

comment -

notes -

commands -

applicationParameters -

Remote

public Remote(IrSignal irSignal,
              String name,
              String comment,
              String deviceName)

This constructor constructs a Remote from one single IrSignal.

Parameters:

irSignal -

name - Name of command to be constructed.

comment - Comment for command to be constructed.

deviceName -

Method Detail

xmlExport

public Element xmlExport(Document doc,
                         boolean fatRaw,
                         boolean generateRaw,
                         boolean generateCcf,
                         boolean generateParameters)
                  throws IrpMasterException

XML export function.

Parameters:

doc -

fatRaw -

generateRaw -

generateCcf -

generateParameters -

Returns:

XML Element of gid "remote",

Throws:

IrpMasterException

addFormat

public void addFormat(Command.CommandTextFormat format,
                      int repeatCount)
               throws IrpMasterException

Applies the format argument to all Command's in the Remote.

Parameters:

format -

repeatCount -

Throws:

IrpMasterException

hasThisProtocol

public boolean hasThisProtocol(String protocolName)

Returns true if and only if all contained commands has the protocol in the argument.

Parameters:

protocolName -

Returns:

getCommand

public Command getCommand(String commandName)

getName

public String getName()

Returns:

Name of the Remote.

getComment

public String getComment()

Returns:

the comment

getCommands

public HashMap<String,Command> getCommands()

Returns:

the commands

getApplicationParameters

public HashMap<String,HashMap<String,String>> getApplicationParameters()

Returns:

the applicationParameters

getManufacturer

public String getManufacturer()

Returns:

the manufacturer

getModel

public String getModel()

Returns:

the model

getDeviceClass

public String getDeviceClass()

Returns:

the deviceClass

getRemoteName

public String getRemoteName()

Returns:

the remoteName

getNotes

public String getNotes()

Returns:

the notes