org.harctoolbox.irscrutinizer.capturinghardware

Class CapturingHardware<T extends ICapture & IHarcHardware>

java.lang.Object

org.harctoolbox.irscrutinizer.capturinghardware.CapturingHardware<T>

Type Parameters:

T -

All Implemented Interfaces:

Closeable, AutoCloseable, IHarcHardware, ICapture, IIrReader

Direct Known Subclasses:

CapturingGlobalCache, CapturingLircMode2, CapturingSendingHardware, CapturingSerial

public abstract class CapturingHardware<T extends ICapture & IHarcHardware>
extends Object
implements ICapture

Field Summary

Fields

Modifier and Type	Field and Description
protected GuiUtils	guiUtils
protected org.harctoolbox.irscrutinizer.Props	properties
protected boolean	verbose

Fields inherited from interface org.harctoolbox.harchardware.ir.IIrReader

defaultBeginTimeout, defaultCaptureMaxSize, defaultEndTimeout

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CapturingHardware(JPanel panel, org.harctoolbox.irscrutinizer.Props properties, GuiUtils guiUtils, CapturingHardwareManager capturingHardwareManager)

Method Summary

Modifier and Type	Method and Description
ModulatedIrSequence	capture() Listens to the device and returns a sequence.
void	close()
abstract T	getCapturer()
abstract String	getName()
JPanel	getPanel()
String	getVersion() Returns the hardware version (not the version of the driver software).
boolean	isValid() Tries to identify instances that are not valid.
protected void	selectMe()
void	setBeginTimeout(int beginTimeout)
void	setCaptureMaxSize(int captureMaxSize)
void	setDebug(int debug) Sets a debug parameter.
void	setEndTimeout(int endTimeout)
void	setTimeout(int i) Set timeout in milliseconds.
protected void	setupHardwareCommonEnd()
void	setVerbose(boolean verbose)
void	setVerbosity(boolean verbosity) Sets a verbosity flag, causing commands to be executed verbosely.
boolean	stopCapture() Signals the capturing device that it should stop capturing.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.harctoolbox.harchardware.IHarcHardware

open

Field Detail

properties

protected org.harctoolbox.irscrutinizer.Props properties

guiUtils

protected GuiUtils guiUtils

verbose

protected boolean verbose

Constructor Detail

CapturingHardware

protected CapturingHardware(JPanel panel,
                            org.harctoolbox.irscrutinizer.Props properties,
                            GuiUtils guiUtils,
                            CapturingHardwareManager capturingHardwareManager)

Method Detail

getPanel

public JPanel getPanel()

Returns:

the panel

getCapturer

public abstract T getCapturer()

Returns:

the hardware

setVerbose

public void setVerbose(boolean verbose)

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

setupHardwareCommonEnd

protected void setupHardwareCommonEnd()

selectMe

protected void selectMe()
                 throws IOException,
                        HarcHardwareException

Throws:

IOException

HarcHardwareException

capture

public ModulatedIrSequence capture()
                            throws HarcHardwareException,
                                   IOException,
                                   IrpMasterException

Description copied from interface: ICapture

Listens to the device and returns a sequence. Requires the device to be previously opened. Should itself neither open or close the device.

Specified by:

capture in interface ICapture

Returns:

Captured sequence, or null by timeout.

Throws:

HarcHardwareException - if the device is not in valid/open state.

IOException

IrpMasterException

stopCapture

public boolean stopCapture()

Description copied from interface: ICapture

Signals the capturing device that it should stop capturing. May not be implemented in all hardware.

Specified by:

stopCapture in interface ICapture

Returns:

status

getVersion

public String getVersion()
                  throws IOException

Description copied from interface: IHarcHardware

Returns the hardware version (not the version of the driver software). May be null if no relevant information available.

Specified by:

getVersion in interface IHarcHardware

Returns:

Version string. Semantics can vary.

Throws:

IOException

setVerbosity

public void setVerbosity(boolean verbosity)

Description copied from interface: IHarcHardware

Sets a verbosity flag, causing commands to be executed verbosely. Exact semantic depends on the implementation.

Specified by:

setVerbosity in interface IHarcHardware

Parameters:

verbosity - on or off

setTimeout

public void setTimeout(int i)
                throws IOException

Description copied from interface: IHarcHardware

Set timeout in milliseconds. Exact semantics may be dependent on the hardware.

Specified by:

setTimeout in interface IHarcHardware

Parameters:

i - Timeout in milliseconds.

Throws:

IOException

setDebug

public void setDebug(int debug)

Description copied from interface: IHarcHardware

Sets a debug parameter. Exact semantic depends on the implementation.

Specified by:

setDebug in interface IHarcHardware

setBeginTimeout

public void setBeginTimeout(int beginTimeout)
                     throws IOException

Specified by:

setBeginTimeout in interface IIrReader

Throws:

IOException

setCaptureMaxSize

public void setCaptureMaxSize(int captureMaxSize)

Specified by:

setCaptureMaxSize in interface IIrReader

setEndTimeout

public void setEndTimeout(int endTimeout)

Specified by:

setEndTimeout in interface IIrReader

isValid

public boolean isValid()

Description copied from interface: IHarcHardware

Tries to identify instances that are not valid. Exact meaning can vary.

Specified by:

isValid in interface IHarcHardware

Returns:

validity of the instance.

getName

public abstract String getName()