org.harctoolbox.IrpMaster

Class ModulatedIrSequence

java.lang.Object

org.harctoolbox.IrpMaster.IrSequence

org.harctoolbox.IrpMaster.ModulatedIrSequence

All Implemented Interfaces:

Serializable, Cloneable

public class ModulatedIrSequence
extends IrSequence

A ModulatedIrSequence is an IrSequence with the additional properties of a modulation frequency and a duty cycle. The name is slightly misleading since the modulation frequency can be 0; it just needs to be present.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected double	dutyCycle Duty cycle of the modulation, a number between 0 and 1.
protected double	frequency Modulation frequency in Hz.

Fields inherited from class org.harctoolbox.IrpMaster.IrSequence

data

Constructor Summary

Constructors

Constructor and Description
ModulatedIrSequence(int[] durations, double frequency) Constructs a ModulatedIrSequence from its arguments.
ModulatedIrSequence(int[] durations, double frequency, double dutyCycle) Constructs a ModulatedIrSequence from its arguments.
ModulatedIrSequence(IrSequence irSequence, double frequency) Constructs a ModulatedIrSequence from its arguments.
ModulatedIrSequence(IrSequence irSequence, double frequency, double dutyCycle) Constructs a ModulatedIrSequence from its arguments.
ModulatedIrSequence(ModulatedIrSequence... seqs) Concatenates the IrSequences in the argument to a new sequence.

Method Summary

Modifier and Type	Method and Description
ModulatedIrSequence	append(double delay) Appends a delay to the end of the ModulatedIrSequence.
ModulatedIrSequence	append(ModulatedIrSequence tail)
ModulatedIrSequence[]	chop(double amount) Chops a IrSequence in parts.
static ModulatedIrSequence	concatenate(Collection<IrSequence> sequences, double frequency, double dutyCycle)
double	getDutyCycle()
double	getFrequency()
boolean	isEqual(ModulatedIrSequence irSequence, double absoluteTolerance, double relativeTolerance, double frequencyTolerance) Compares two ModulatedIrSequences for (approximate) equality.
boolean	isZeroModulated()
IrSignal	toIrSignal() Makes the current sequence into an IrSignal by considering the sequence as an intro sequence.
IrSignal	toIrSignal(int beginningLength, int repeatLength, int noRepeats) Constructs an IrSignal.
String	toPrintString() Formats IR signal as sequence of durations, by preserving signs.
String	toPrintString(boolean alternatingSigns) Formats IR signal as sequence of durations, with alternating signs or by preserving signs.
String	toPrintString(boolean alternatingSigns, boolean noSigns) Formats IR signal as sequence of durations, with alternating signs or by preserving signs.
String	toPrintString(boolean alternatingSigns, boolean noSigns, String separator) Formats IR signal as sequence of durations, with alternating signs, ignoring all signs, or by preserving signs.
String	toPrintString(boolean alternatingSigns, boolean noSigns, String separator, boolean includeFrequency) Formats IR signal as sequence of durations, with alternating signs, ignoring all signs, or by preserving signs.
String	toString() Generates a pretty string representing the object.

Methods inherited from class org.harctoolbox.IrpMaster.IrSequence

addToFlashes, addToGaps, append, append, clone, concatenate, containsZeros, flashExcess, get, getDuration, getDuration, getGap, getLength, getNumberBursts, iget, isEmpty, isEqual, isEqual, isEqual, isEqual, main, noisify, replaceZeros, subSequence, toDoubles, toInts, toInts, toPulses, toString, truncate

Methods inherited from class java.lang.Object

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

Field Detail

frequency

protected double frequency

Modulation frequency in Hz. Use 0 for no modulation, use -1 for no information.

dutyCycle

protected double dutyCycle

Duty cycle of the modulation, a number between 0 and 1. Use -1 for unassigned.

Constructor Detail

ModulatedIrSequence

public ModulatedIrSequence(IrSequence irSequence,
                           double frequency,
                           double dutyCycle)

Constructs a ModulatedIrSequence from its arguments.

Parameters:

irSequence - irSequence to be copied from

frequency -

dutyCycle -

ModulatedIrSequence

public ModulatedIrSequence(IrSequence irSequence,
                           double frequency)

Constructs a ModulatedIrSequence from its arguments.

Parameters:

irSequence - irSequence to be copied from

frequency -

ModulatedIrSequence

public ModulatedIrSequence(int[] durations,
                           double frequency,
                           double dutyCycle)
                    throws IncompatibleArgumentException

Constructs a ModulatedIrSequence from its arguments.

Parameters:

durations -

frequency -

dutyCycle -

Throws:

IncompatibleArgumentException

ModulatedIrSequence

public ModulatedIrSequence(int[] durations,
                           double frequency)
                    throws IncompatibleArgumentException

Constructs a ModulatedIrSequence from its arguments.

Parameters:

durations -

frequency -

Throws:

IncompatibleArgumentException - if duration has odd length.

ModulatedIrSequence

public ModulatedIrSequence(ModulatedIrSequence... seqs)

Concatenates the IrSequences in the argument to a new sequence. Frequency and duty cycle are set to the average between minimum and maximum values by the components, if it makes sense.

Parameters:

seqs - One or more ModulatedIrSequences

Method Detail

getFrequency

public final double getFrequency()

Returns:

modulation frequency in Hz.

getDutyCycle

public final double getDutyCycle()

Returns:

Duty cycle.

toString

public String toString()

Description copied from class: IrSequence

Generates a pretty string representing the object. Signs in the data are preserved.

Overrides:

toString in class IrSequence

Returns:

nice string.

toPrintString

public String toPrintString(boolean alternatingSigns,
                            boolean noSigns,
                            String separator)

Formats IR signal as sequence of durations, with alternating signs, ignoring all signs, or by preserving signs.

Overrides:

toPrintString in class IrSequence

Parameters:

alternatingSigns - if true, generate alternating signs (ignoring original signs).

noSigns - remove all signs.

separator -

Returns:

Printable string.

toPrintString

public String toPrintString(boolean alternatingSigns,
                            boolean noSigns,
                            String separator,
                            boolean includeFrequency)

Formats IR signal as sequence of durations, with alternating signs, ignoring all signs, or by preserving signs.

Parameters:

alternatingSigns - if true, generate alternating signs (ignoring original signs).

noSigns - remove all signs.

separator -

includeFrequency - If true, include frequency information

Returns:

Printable string.

toPrintString

public String toPrintString(boolean alternatingSigns,
                            boolean noSigns)

Formats IR signal as sequence of durations, with alternating signs or by preserving signs.

Overrides:

toPrintString in class IrSequence

Parameters:

alternatingSigns - if true, generate alternating signs (ignoring original signs), otherwise preserve signs.

noSigns -

Returns:

Printable string.

toPrintString

public String toPrintString(boolean alternatingSigns)

Formats IR signal as sequence of durations, with alternating signs or by preserving signs.

Overrides:

toPrintString in class IrSequence

Parameters:

alternatingSigns - if true, generate alternating signs (ignoring original signs), otherwise preserve signs.

Returns:

Printable string.

toPrintString

public String toPrintString()

Formats IR signal as sequence of durations, by preserving signs.

Overrides:

toPrintString in class IrSequence

Returns:

Printable string.

toIrSignal

public final IrSignal toIrSignal()

Makes the current sequence into an IrSignal by considering the sequence as an intro sequence.

Returns:

IrSignal

toIrSignal

public IrSignal toIrSignal(int beginningLength,
                           int repeatLength,
                           int noRepeats)
                    throws IncompatibleArgumentException

Constructs an IrSignal.

Parameters:

beginningLength - Length of the intro sequence

repeatLength - Length of the repeat sequence

noRepeats - Number of occurrences of the repeat sequence

Returns:

IrSignal

Throws:

IncompatibleArgumentException

isEqual

public boolean isEqual(ModulatedIrSequence irSequence,
                       double absoluteTolerance,
                       double relativeTolerance,
                       double frequencyTolerance)

Compares two ModulatedIrSequences for (approximate) equality.

Parameters:

irSequence - to be compared against this.

absoluteTolerance - tolerance threshold in microseconds.

relativeTolerance - relative threshold, between 0 and 1.

frequencyTolerance - tolerance (absolute) for frequency in Hz.

Returns:

equality within tolerance.

isZeroModulated

public final boolean isZeroModulated()

Returns:

true if and only iff the modulation frequency is zero (in numerical sense).

append

public ModulatedIrSequence append(double delay)
                           throws IncompatibleArgumentException

Appends a delay to the end of the ModulatedIrSequence. Original is left untouched.

Overrides:

append in class IrSequence

Parameters:

delay - microseconds of silence to be appended to the IrSequence.

Returns:

Copy of object with additional delay at end.

Throws:

IncompatibleArgumentException

append

public ModulatedIrSequence append(ModulatedIrSequence tail)
                           throws IncompatibleArgumentException

Throws:

IncompatibleArgumentException

concatenate

public static ModulatedIrSequence concatenate(Collection<IrSequence> sequences,
                                              double frequency,
                                              double dutyCycle)

chop

public final ModulatedIrSequence[] chop(double amount)

Description copied from class: IrSequence

Chops a IrSequence in parts. Every gap of length ≥ threshold cause a cut.

Overrides:

chop in class IrSequence

Parameters:

amount - minimal gap in microseconds to cause a cut.

Returns:

Array of IrSequences