/****************************************************************************

**

** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the examples of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:BSD$

** You may use this file under the terms of the BSD license as follows:

**

** Redistribution and use in source and binary forms, with or without

** modification, are permitted provided that the following conditions are met:

** - Redistributions of source code must retain the above copyright notice,

**   this list of conditions and the following disclaimer.

** - Redistributions in binary form must reproduce the above copyright notice,

**   this list of conditions and the following disclaimer in the documentation

**   and/or other materials provided with the distribution.

** - Neither the name of Nokia Corporation and its Subsidiary(-ies) nor the

**   names of its contributors may be used to endorse or promote products

**   derived from this software without specific prior written permission.

**

** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"

** AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

** IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

** ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE

** LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR

** CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF

** SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS

** INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN

** CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)

** ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

** POSSIBILITY OF SUCH DAMAGE.

** $QT_END_LICENSE$

**

*****************************************************************************/

#ifndef FREQUENCYSPECTRUM_H

#define FREQUENCYSPECTRUM_H

#include <QtCore/QVector>

/**

 * Represents a frequency spectrum as a series of elements, each of which

 * consists of a frequency, an amplitude and a phase.

 */

class FrequencySpectrum {

public:

    FrequencySpectrum(int numPoints = 0);

    struct Element {

        Element()

        :   frequency(0.0), amplitude(0.0), phase(0.0), clipped(false)

        { }

        /**

         * Frequency in Hertz

         */

        qreal frequency;

        /**

         * Amplitude in range [0.0, 1.0]

         */

        qreal amplitude;

        /**

         * Phase in range [0.0, 2*PI]

         */

        qreal phase;

        /**

         * Indicates whether value has been clipped during spectrum analysis

         */

        bool clipped;

    };

    typedef QVector<Element>::iterator iterator;

    typedef QVector<Element>::const_iterator const_iterator;

    void reset();

    int count() const;

    Element& operator[](int index);

    const Element& operator[](int index) const;

    iterator begin();

    iterator end();

    const_iterator begin() const;

    const_iterator end() const;

private:

    QVector<Element> m_elements;

};

#endif // FREQUENCYSPECTRUM_H