org.harctoolbox.girr

Class Command

java.lang.Object

org.harctoolbox.girr.Command

All Implemented Interfaces:

Serializable

public class Command
extends Object
implements Serializable

This class models the command in Girr. A command is essentially an IR signal, given either by protocol/parameters or timing data, and a name.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Command.CommandTextFormat An implementation of this interface describes a way to format an IrSignal to a text string.
static class	Command.MasterType This describes which representation of a Command constitutes the master.

Constructor Summary

Constructors

Constructor and Description
Command(Element element, String inheritProtocol, HashMap<String,Long> inheritParameters) This constructor is for importing from the Element as first argument.
Command(String name, String comment, IrSignal irSignal)
Command(String name, String comment, IrSignal irSignal, boolean generateCcf, boolean decode) Construct a Command from an IrSignal, i.e.
Command(String name, String comment, String ccf, boolean generateRaw, boolean decode) Construct a Command from CCF form.
Command(String name, String comment, String protocol, HashMap<String,Long> parameters) Construct a Command from protocol and parameters.
Command(String name, String comment, String protocol, HashMap<String,Long> parameters, IrpMaster irpMaster, boolean generateRaw, boolean generateCcf) Construct a Command from protocol and parameters.
Command(String name, String comment, String protocol, HashMap<String,Long> parameters, String protocolIniPath, boolean generateRaw, boolean generateCcf) Convenience version of the constructor with IrpMaster.

Method Summary

Modifier and Type	Method and Description
void	addFormat(Command.CommandTextFormat format, int repeatCount) Add an extra format to the Command.
void	addFormat(String name, String value)
static ModulatedIrSequence	appendAsSequence(Collection<Command> commands)
void	checkForCcf()
void	checkForParameters() Tries to decode the signals, unless parameters already are present.
void	checkForRaw()
String	getCcf()
String	getComment()
double	getDutyCycle()
String	getEnding()
String	getFormat(String name) Returns an "other" format, identified by its name.
int	getFrequency()
String	getIntro()
Command.MasterType	getMasterType()
String	getName()
String	getNotes()
Collection<String>	getOtherFormats()
HashMap<String,Long>	getParameters()
String	getProtocol()
String	getRepeat()
static void	main(String[] args) Just for testing, not for deployment.
String	nameProtocolParameterString()
String	prettyValueString()
static void	setIrpMaster(IrpMaster newIrpMaster) Sets an IrpMaster instance, which will be used in subsequent transformations from parameter format.
static HashMap<String,Command>	toHashMap(Command command)
IrSignal	toIrSignal() Returns the IrSignal of the Command.
ModulatedIrSequence	toModulatedIrSequence(int noRepetitions)
String	toPrintString()
Element	xmlExport(Document doc, String title, boolean fatRaw, boolean generateRaw, boolean generateCcf, boolean generateParameters) XMLExport of the Command.

Methods inherited from class java.lang.Object

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

Constructor Detail

Command

public Command(Element element,
               String inheritProtocol,
               HashMap<String,Long> inheritParameters)
        throws ParseException,
               IrpMasterException

This constructor is for importing from the Element as first argument.

Parameters:

element -

inheritProtocol -

inheritParameters -

Throws:

ParseException

IrpMasterException

Command

public Command(String name,
               String comment,
               IrSignal irSignal)

Command

public Command(String name,
               String comment,
               IrSignal irSignal,
               boolean generateCcf,
               boolean decode)

Construct a Command from an IrSignal, i.e. timing data.

Parameters:

name - Name of command

comment - textual comment

irSignal - IrSignal

generateCcf - generate the CCF form, if not already present.

decode - invoke decoding.

Command

public Command(String name,
               String comment,
               String protocol,
               HashMap<String,Long> parameters)
        throws IrpMasterException

Construct a Command from protocol and parameters.

Parameters:

name -

comment -

protocol -

parameters -

Throws:

IrpMasterException

Command

public Command(String name,
               String comment,
               String protocol,
               HashMap<String,Long> parameters,
               IrpMaster irpMaster,
               boolean generateRaw,
               boolean generateCcf)
        throws IrpMasterException

Construct a Command from protocol and parameters.

Parameters:

name -

comment -

protocol -

parameters -

irpMaster -

generateRaw -

generateCcf -

Throws:

IrpMasterException

Command

public Command(String name,
               String comment,
               String protocol,
               HashMap<String,Long> parameters,
               String protocolIniPath,
               boolean generateRaw,
               boolean generateCcf)
        throws FileNotFoundException,
               IrpMasterException

Convenience version of the constructor with IrpMaster.

Parameters:

name -

comment -

protocol -

parameters -

protocolIniPath -

generateRaw -

generateCcf -

Throws:

FileNotFoundException

IrpMasterException

Command

public Command(String name,
               String comment,
               String ccf,
               boolean generateRaw,
               boolean decode)
        throws IrpMasterException

Construct a Command from CCF form.

Parameters:

name -

comment -

ccf -

generateRaw -

decode -

Throws:

IrpMasterException

Method Detail

setIrpMaster

public static void setIrpMaster(IrpMaster newIrpMaster)

Sets an IrpMaster instance, which will be used in subsequent transformations from parameter format.

Parameters:

newIrpMaster -

getDutyCycle

public double getDutyCycle()

Returns:

duty cycle, a number between 0 and 1.

getComment

public String getComment()

Returns:

the comment

getNotes

public String getNotes()

Returns:

the notes

getMasterType

public Command.MasterType getMasterType()

Returns:

the masterType

getName

public String getName()

Returns:

the name

getProtocol

public String getProtocol()

Returns:

the protocol

getParameters

public HashMap<String,Long> getParameters()

Returns:

the parameters

getFrequency

public int getFrequency()

Returns:

the frequency

getIntro

public String getIntro()

Returns:

the intro

getRepeat

public String getRepeat()

Returns:

the repeat

getEnding

public String getEnding()

Returns:

the ending

getCcf

public String getCcf()

Returns:

the ccf

getOtherFormats

public Collection<String> getOtherFormats()

Returns:

List of the otherFormats

getFormat

public String getFormat(String name)

Returns an "other" format, identified by its name.

Parameters:

name -

Returns:

test string of the format.

toIrSignal

public IrSignal toIrSignal()
                    throws IrpMasterException

Returns the IrSignal of the Command.

Returns:

IrSignal corresponding to the Command.

Throws:

IrpMasterException

toModulatedIrSequence

public ModulatedIrSequence toModulatedIrSequence(int noRepetitions)
                                          throws IrpMasterException

Throws:

IrpMasterException

appendAsSequence

public static ModulatedIrSequence appendAsSequence(Collection<Command> commands)
                                            throws IrpMasterException

Throws:

IrpMasterException

nameProtocolParameterString

public String nameProtocolParameterString()

prettyValueString

public String prettyValueString()

Returns:

Nicely formatted string the way the user would like to see it if truncated to "small" length.

toPrintString

public String toPrintString()
                     throws IrpMasterException

Throws:

IrpMasterException

toHashMap

public static HashMap<String,Command> toHashMap(Command command)

checkForParameters

public void checkForParameters()
                        throws IrpMasterException

Tries to decode the signals, unless parameters already are present.

Throws:

IrpMasterException

checkForRaw

public void checkForRaw()
                 throws IrpMasterException

Throws:

IrpMasterException

checkForCcf

public void checkForCcf()
                 throws IrpMasterException

Throws:

IrpMasterException

addFormat

public void addFormat(String name,
                      String value)

addFormat

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

Add an extra format to the Command.

Parameters:

format -

repeatCount -

Throws:

IrpMasterException

xmlExport

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

XMLExport of the Command.

Parameters:

doc -

title -

fatRaw -

generateRaw -

generateCcf -

generateParameters -

Returns:

XML Element of gid "command".

Throws:

IrpMasterException

main

public static void main(String[] args)

Just for testing, not for deployment.

Parameters:

args -