IrSignal.h

Go to the documentation of this file.

#pragma once

#include "InfraredTypes.h"
#include "IrSequence.h"

class IrSignal {
public:
    static const frequency_t defaultFrequency = 38000U;
    static const frequency_t invalidFrequency = (frequency_t) -1;

    IrSignal();
    IrSignal(const IrSignal& orig);

    virtual ~IrSignal();
    IrSignal(const microseconds_t *intro, size_t lengthIntro,
            const microseconds_t *repeat, size_t lengthRepeat,
            const microseconds_t *ending, size_t lengthEnding,
            frequency_t frequency = defaultFrequency,
            bool toBeFreed = false);

    IrSignal(const microseconds_t *intro, size_t lengthIntro,
            const microseconds_t *repeat, size_t lengthRepeat,
            frequency_t frequency = defaultFrequency,
            bool toBeFreed = false);

    IrSignal(const IrSequence& intro, const IrSequence& repeat, const IrSequence& ending,
            frequency_t frequency, bool toBeFreed);

    IrSignal(const IrSequence& intro, const IrSequence& repeat, const IrSequence& ending,
            frequency_t frequency = defaultFrequency);

private:
    const frequency_t frequency;
    const IrSequence intro;
    const IrSequence repeat;
    const IrSequence ending;

public:

    IrSignal *clone() const;

    frequency_t getFrequency() const {
        return frequency;
    }

    const IrSequence& getEnding() const {
        return ending;
    }

    const IrSequence& getRepeat() const {
        return repeat;
    }

    const IrSequence& getIntro() const {
        return intro;
    }

    void dump(Stream& stream, bool usingSigns = false) const;

    void dumpWithSigns(Stream& stream) const {
        dump(stream, true);
    };

    bool dumpFrequency(Stream& stream) const {
        return dumpFrequency(stream, frequency);
    };

    static bool dumpFrequency(Stream& stream, frequency_t frequency);

    unsigned int noRepetitions(unsigned int noSends) const {
        return noSends == 0 ? 0
                : getIntro().isEmpty() ? noSends : noSends - 1;
    }


};