//
// --------------------------------------------------------------------------
//  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 GXDLMSCLOCK_H
#define GXDLMSCLOCK_H

#include "GXDLMSObject.h"

/**
Online help:
http://www.gurux.fi/Gurux.DLMS.Objects.GXDLMSClock
*/
class CGXDLMSClock : public CGXDLMSObject
{
    DLMS_CLOCK_BASE m_ClockBase;
    char m_Deviation;
    bool m_Enabled;
    CGXDateTime m_End;
    DLMS_CLOCK_STATUS m_Status;
    CGXDateTime m_Begin;
    short m_TimeZone;
    CGXDateTime m_Time;

public:
    /**
     Constructor.
    */
    CGXDLMSClock();

    /**
     Constructor.
     @param ln Logical Name of the object.
    */
    CGXDLMSClock(std::string ln);

    /**
     Constructor.
     @param ln Logical Name of the object.
     @param sn Short Name of the object.
    */
    CGXDLMSClock(std::string ln, unsigned short sn);

    /**
     Time of COSEM Clock object.
    */
    CGXDateTime& GetTime();

    void SetTime(CGXDateTime& value);

    /**
     TimeZone of COSEM Clock object.
    */
    short GetTimeZone();
    void SetTimeZone(short value);

    /**
     Status of COSEM Clock object.
    */
    DLMS_CLOCK_STATUS GetStatus();
    void SetStatus(DLMS_CLOCK_STATUS value);

    CGXDateTime& GetBegin();
    void SetBegin(CGXDateTime& value);

    CGXDateTime& GetEnd();
    void SetEnd(CGXDateTime& value);

    char GetDeviation();
    void SetDeviation(char value);

    bool GetEnabled();
    void SetEnabled(bool value);

    /**
     Clock base of COSEM Clock object.
    */
    DLMS_CLOCK_BASE GetClockBase();
    void SetClockBase(DLMS_CLOCK_BASE 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 GetUIDataType(int index, DLMS_DATA_TYPE& type);
    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 //GXDLMSCLOCK_H
