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

#include "GXDLMSObject.h"

enum AUTO_CONNECT_MODE
{
    /*
     * No auto dialling,
     */
    AUTO_CONNECT_MODE_NO_AUTO_DIALLING = 0,
    /**
     * Auto dialling allowed anytime,
     */
    AUTO_CONNECT_MODE_AUTO_DIALLING_ALLOWED_ANYTIME = 1,
    /**
     * Auto dialling allowed within the validity time of the calling window.
     */
    AUTO_CONNECT_MODE_AUTO_DIALLING_ALLOWED_CALLING_WINDOW = 2,
    /**
     * “regular” auto dialling allowed within the validity time
     * of the calling window; “alarm” initiated auto dialling allowed anytime,
     */
    AUTO_CONNECT_MODE_REGULAR_AUTO_DIALLING_ALLOWED_CALLING_WINDOW = 3,
    /**
     * SMS sending via Public Land Mobile Network (PLMN),
     */
    AUTO_CONNECT_MODE_SMS_SENDING_PLMN = 4,
    /*
     * SMS sending via PSTN.
     */
    AUTO_CONNECT_MODE_SMS_SENDING_PSTN = 5,
    /*
     * Email sending.
     */
    AUTO_CONNECT_MODE_EMAIL_SENDING = 6
};

enum AUTO_ANSWER_STATUS
{
    AUTO_ANSWER_STATUS_INACTIVE = 0,
    AUTO_ANSWER_STATUS_ACTIVE = 1,
    AUTO_ANSWER_STATUS_LOCKED = 2
};

/**
Online help:
http://www.gurux.fi/Gurux.DLMS.Objects.GXDLMSAutoAnswer
*/
class CGXDLMSAutoAnswer : public CGXDLMSObject
{
    int m_NumberOfRingsInListeningWindow, m_NumberOfRingsOutListeningWindow;
    AUTO_CONNECT_MODE m_Mode;
    std::vector<std::pair< CGXDateTime, CGXDateTime> > m_ListeningWindow;
    AUTO_ANSWER_STATUS m_Status;
    int m_NumberOfCalls;
public:
    /**
     Constructor.
    */
    CGXDLMSAutoAnswer();

    /**
     Constructor.

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

    /**
     Constructor.

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

    AUTO_CONNECT_MODE GetMode();
    void SetMode(AUTO_CONNECT_MODE value);

    std::vector<std::pair< CGXDateTime, CGXDateTime> >& GetListeningWindow();
    void SetListeningWindow(std::vector<std::pair< CGXDateTime, CGXDateTime> >& value);

    AUTO_ANSWER_STATUS GetStatus();
    void SetStatus(AUTO_ANSWER_STATUS value);

    int GetNumberOfCalls();
    void SetNumberOfCalls(int value);

    // Number of rings within the window defined by ListeningWindow.
    int GetNumberOfRingsInListeningWindow();
    void SetNumberOfRingsInListeningWindow(int value);

    //Number of rings outside the window defined by ListeningWindow.
    int GetNumberOfRingsOutListeningWindow();
    void SetNumberOfRingsOutListeningWindow(int 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 //GXDLMSAUTOANSWER_H