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

#include "GXDLMSPppSetupIPCPOption.h"
#include "GXDLMSPppSetupLcpOption.h"
/**
PPP Authentication Type
 */
enum PPP_AUTHENTICATION_TYPE
{
    /**
     No authentication.
    */
    PPP_AUTHENTICATION_TYPE_NONE = 0,
    /**
     PAP Login
    */
    PPP_AUTHENTICATION_TYPE_PAP = 1,
    /**
     CHAP-algorithm
    */
    PPP_AUTHENTICATION_TYPE_CHAP = 2
};

/**
Online help:
http://www.gurux.fi/Gurux.DLMS.Objects.GXDLMSPppSetup
*/
class CGXDLMSPppSetup : public CGXDLMSObject
{
    std::vector<CGXDLMSPppSetupIPCPOption> m_IPCPOptions;
    std::string m_PHYReference;
    std::vector<CGXDLMSPppSetupLcpOption> m_LCPOptions;
    CGXByteBuffer m_UserName;
    CGXByteBuffer m_Password;
    PPP_AUTHENTICATION_TYPE m_Authentication;

public:
    //Constructor.
    CGXDLMSPppSetup();

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

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

    PPP_AUTHENTICATION_TYPE GetAuthentication();
    void SetAuthentication(PPP_AUTHENTICATION_TYPE value);

    /**
    PPP authentication procedure user name.
    */
    CGXByteBuffer GetUserName();
    void SetUserName(CGXByteBuffer value);

    /**
     PPP authentication procedure password.
    */
    CGXByteBuffer& GetPassword();
    void SetPassword(CGXByteBuffer value);

    std::string GetPHYReference();
    void SetPHYReference(std::string value);

    std::vector<CGXDLMSPppSetupLcpOption>& GetLCPOptions();
    std::vector<CGXDLMSPppSetupIPCPOption>& GetIPCPOptions();

    // 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 //GXDLMSPPPSETUP_H