/**
********************************************************************************
\file   EventLog.h

\brief  Header file for event logger class

This file contains the definitions of the event logger class.
*******************************************************************************/

/*------------------------------------------------------------------------------
Copyright (c) 2017, Bernecker+Rainer Industrie-Elektronik Ges.m.b.H. (B&R)
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 the copyright holders 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 COPYRIGHT HOLDERS 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.
------------------------------------------------------------------------------*/
#ifndef _INC_demo_EventLog_H_
#define _INC_demo_EventLog_H_

//------------------------------------------------------------------------------
// includes
//------------------------------------------------------------------------------
#include <QObject>
#include <QString>

#include <oplk/oplk.h>
#include <eventlog/eventlogstring.h>

//------------------------------------------------------------------------------
// class definitions
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
/**
\brief  EventLog class

The class implements an event logger.
*/
//------------------------------------------------------------------------------
class EventLog : public QObject
{
    Q_OBJECT

public:
    EventLog(tEventlogLevel filterLevel_p = 0xFFFFFFFFUL,
             tEventlogCategory filterCategory_p = 0xFFFFFFFFUL,
             tEventlogFormat logFormat_p = kEventlogFormatParsable);

    void printEvent(const tOplkApiEventNode& nodeEvent_p);
    void printEvent(const tErrHistoryEntry& history_p);
    void printEvent(const tEventError& error_p);
    void printEvent(const tEventNmtStateChange& nmtStateChange_p);
    void printEvent(const tOplkApiEventPdoChange& pdoChange_p);
    void printEvent(const tCfmEventCnProgress& cfmProgress_p);
    void printEvent(UINT nodeId_p,
                    tNmtNodeCommand nodeCommand_p);
    void printMessage(tEventlogLevel level_p,
                      tEventlogCategory category_p,
                      const char* fmt_p,
                      ...);
    void printPdoMap(UINT16 mapObject_p,
                     UINT8 subIndex_p,
                     UINT64 mapping_p);

signals:
    void printLog(const QString& logMessage_p);

private:
    static const size_t     EVENTLOG_MAX_LENGTH;

    const tEventlogLevel    filterLevel;        ///< The level filter. It contains a bitmask with all
                                                ///< levels to be printed.
    const tEventlogCategory filterCategory;     ///< The category filter. It contains a bitmask with all
                                                ///< categories to be printed.
    const tEventlogFormat   logFormat;
};

#endif /* _INC_demo_EventLog_H_ */
