com.raspoid.additionalcomponents.ir

Class IRSignal

java.lang.Object

com.raspoid.additionalcomponents.ir.IRSignal

public class IRSignal
extends java.lang.Object

An infrared signal is a collection of pulses.

Each pulses of the signal are registered as OFF, ON contiguous periods.

Constructor Summary

Constructors

Constructor and Description
IRSignal(int[] signal) Constructor for a new signal, using the specific int[] signal data input corresponding to the raw composition of the signal.
IRSignal(java.lang.String name, int[] signal) Constructor for a new signal, using the specific int[] signal data input corresponding to the raw composition of the signal, and using a specific name.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Get the name corresponding to this signal.
int	getNbPulses() Get the number of pulses composing the signal.
int[]	getPulses() Get the complete array of OFF/ON periods.
boolean	matches(IRSignal signal, int tolerance) Returns true if the specific input signal corresponds to this signal, with a fuzziness of tolerance %.
java.lang.String	toJavaIntArrayRepresentation() This method is mainly a utils methods.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

IRSignal

public IRSignal(int[] signal)

Constructor for a new signal, using the specific int[] signal data input corresponding to the raw composition of the signal.

Parameters:

signal - the int[] data input corresponding to the raw composition of the signal (OFF/ON periods).

IRSignal

public IRSignal(java.lang.String name,
                int[] signal)

Constructor for a new signal, using the specific int[] signal data input corresponding to the raw composition of the signal, and using a specific name.

Parameters:

name - the name to link to this signal.

signal - the int[] data input corresponding to the raw composition of the signal (OFF/ON periods).

Method Detail

getNbPulses

public int getNbPulses()

Get the number of pulses composing the signal.

Returns:

the number of pulses composing the signal.

getPulses

public int[] getPulses()

Get the complete array of OFF/ON periods.

Only the 2 * nbPulses first elements of this array are composing the signal.

Returns:

the complete array of OFF/ON periods.

getName

public java.lang.String getName()

Get the name corresponding to this signal. "no_name" String if undefined.

Returns:

the name of this signal. "no_name" String if undefined.

matches

public boolean matches(IRSignal signal,
                       int tolerance)

Returns true if the specific input signal corresponds to this signal, with a fuzziness of tolerance %.

Parameters:

signal - the signal to compare with the current instance.

tolerance - the fuzziness to use for the comparison, in %.

Returns:

true if the input signal corresponds to this signal instance. False otherwise.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toJavaIntArrayRepresentation

public java.lang.String toJavaIntArrayRepresentation()

This method is mainly a utils methods.

It returns the String representation of the composition of the signal, in the Java int[] format: "int irSignal[] = {...};"

Returns:

the String representation of the composition of the signal, in the Java int[] format: "int irSignal[] = {...};".