//
// --------------------------------------------------------------------------
//  Gurux Ltd
//
//
//
// Filename:        $HeadURL$
//
// Version:         $Revision$,
//                  $Date$
//                  $Author$
//
// Copyright (c) Gurux Ltd
//
//---------------------------------------------------------------------------
//
//  DESCRIPTION
//
// This file is a part of Gurux Device Framework.
//
// Gurux Device Framework is Open Source software; you can redistribute it
// and/or modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; version 2 of the License.
// Gurux Device Framework is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
// See the GNU General Public License for more details.
//
// More information of Gurux products: http://www.gurux.org
//
// This code is licensed under the GNU General Public License v2.
// Full text may be retrieved at http://www.gnu.org/licenses/gpl-2.0.txt
//---------------------------------------------------------------------------

#ifndef GXDLMSCOMPACT_DATA_H
#define GXDLMSCOMPACT_DATA_H

#include "GXDLMSObject.h"
#include "GXDLMSCaptureObject.h"

typedef enum
{
    /**
     * Data is captured with Capture-method.
     */
    DLMS_CAPTURE_METHOD_INVOKE,
    /**
     * Data is captured upon reading.
     */
    DLMS_CAPTURE_METHOD_IMPLICIT
}DLMS_CAPTURE_METHOD;

/**
Online help:
http://www.gurux.fi/Gurux.DLMS.Objects.GXDLMSCompactData
*/
class CGXDLMSCompactData : public CGXDLMSObject
{
    /*
    * Compact buffer
    */
    CGXByteBuffer m_Buffer;

    /*
     * Capture objects.
     */
    std::vector<std::pair<CGXDLMSObject*, CGXDLMSCaptureObject*> > m_CaptureObjects;

    /*
     * Template ID.
     */
    unsigned char m_TemplateId;

    /*
     * Template description.
     */
    CGXByteBuffer m_TemplateDescription;

    /*
     * Capture method.
     */
    DLMS_CAPTURE_METHOD m_CaptureMethod;

    int GetCaptureObjects(CGXDLMSSettings& settings, CGXDLMSValueEventArg& e);

    //List of non exists capture objects.
    std::vector<CGXDLMSObject*> m_DynamicColumns;
public:
    //Constructor.
    CGXDLMSCompactData();

    //SN Constructor.
    CGXDLMSCompactData(std::string ln, unsigned short sn);

    //LN Constructor.
    CGXDLMSCompactData(std::string ln);

    ~CGXDLMSCompactData();

    /*
     * Returns Compact buffer
     */
    CGXByteBuffer& GetBuffer();

    /*
     * value: Compact buffer
     */
    void SetBuffer(CGXByteBuffer& value);

    /*
     * Capture objects.
     */
    std::vector<std::pair<CGXDLMSObject*, CGXDLMSCaptureObject*> >& GetCaptureObjects();

    /*
     * Returns Template ID.
     */
    unsigned char GetTemplateId();

    /*
     * value: Template ID.
     */
    void SetTemplateId(unsigned char value);

    /*
     * Returns template description.
     */
    CGXByteBuffer& GetTemplateDescription();

    /*
     * value: Template description.
     */
    void SetTemplateDescription(CGXByteBuffer& value);

    /*
     * Returns Capture method.
     */
    DLMS_CAPTURE_METHOD GetCaptureMethod();

    /*
     * value: Capture method.
     */
    void SetCaptureMethod(DLMS_CAPTURE_METHOD value);

    // Returns amount of attributes.
    int GetAttributeCount();

    // Returns amount of methods.
    int GetMethodCount();

    //Get attribute values of object.
    void GetValues(std::vector<std::string>& values);

    void GetAttributeIndexToRead(std::vector<int>& attributes);

    int GetDataType(int index, DLMS_DATA_TYPE& type);

    // Returns value of given attribute.
    int GetValue(CGXDLMSSettings& settings, CGXDLMSValueEventArg& e);

    // Set value of given attribute.
    int SetValue(CGXDLMSSettings& settings, CGXDLMSValueEventArg& e);
};
#endif //GXDLMSCOMPACT_DATA_H