//=============================================================================================================
/**
 * @file     info.h
 * @author   Christoph Dinh <chdinh@nmr.mgh.harvard.edu>
 * @since    0.1.0
 * @date     February, 2013
 *
 * @section  LICENSE
 *
 * Copyright (C) 2013, Christoph Dinh. All rights reserved.
 *
 * 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 MNE-CPP authors 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.
 *
 *
 * @brief    Contains general application information like: application name and  version number.
 *
 */

#ifndef INFO_H
#define INFO_H

//=============================================================================================================
// QT INCLUDES
//=============================================================================================================

#include <QString>
#include <QObject>

//=============================================================================================================
// DEFINE NAMESPACE MNESCAN
//=============================================================================================================

namespace MNESCAN
{

//=============================================================================================================
// ENUMERATIONS
//=============================================================================================================

//=============================================================================================================
/**
 * Log level
 */
enum LogLevel
{
    _LogLvMin,      /**< Minimal log information. */
    _LogLvNormal,   /**< Normal amount of log information. */
    _LogLvMax       /**< Accurate logging. */
};

//=============================================================================================================
/**
 * Log kind
 */
enum LogKind
{
    _LogKndMessage,     /**< Normal log message. */
    _LogKndWarning,     /**< Warning log message. */
    _LogKndError        /**< Error log message. */
};

//=============================================================================================================
/**
 * DECLARE CLASS CInfo
 *
 * @brief The CInfo class provides application information.
 */
class CInfo
{
public:

    //=========================================================================================================
    /**
     * Returns the short form of the application name.
     *
     * @return a string containing the short application name.
     */
    const static QString AppNameShort()
    {
        return QObject::tr("MNE Scan");
    }

    //=========================================================================================================
    /**
     * Returns the application name.
     *
     * @return a string containing application name.
     */
    const static QString AppName()
    {
        return QObject::tr("Acquisition & Real-Time Processing");
    }

    //=========================================================================================================
    /**
     *
     */
    const static QString OrganizationName()
    {
        return QObject::tr("MNE-CPP");
    }

    //=========================================================================================================
    /**
     * Returns the major version number of the application which indicates larger changes of the application.
     *
     * @return the major version number.
     */
    static int MajorVersion()
    {
        return 0;
    }

    //=========================================================================================================
    /**
     * Returns the minor version number of the application which indicates smaller changes of the application.
     *
     * @return the minor version number.
     */
    static int MinorVersion()
    {
        return 1;
    }

    //=========================================================================================================
    /**
     * Returns the revision number which indicates the bug fix level.
     *
     * @return the revision number.
     */
    static int RevisionVersion()
    {
        return 9;
    }

    //=========================================================================================================
    /**
     * Returns the build number which corresponds to the SVN revision control number.
     *
     * @return the build number.
     */
    static int BuildVersion()
    {
        return 224;
    }

    //=========================================================================================================
    /**
     * Returns the version number (major.minor.build-revision) of the application.
     *
     * @return the full version number.
     */
    const static QString AppVersion()
    {
        //return QString("%1.%2.%3-%4").arg(MajorVersion()).arg(MinorVersion()).arg(RevisionVersion()).arg(BuildVersion());
        return QString("%1.%2.%3").arg(MajorVersion()).arg(MinorVersion()).arg(RevisionVersion());
    }
};
} //NAMESPACE

#endif // INFO_H
