NetworkAdapterDescription.h

// NetworkAdapterDescription.h:
// ----------------------------
//

#ifndef __IPSDKHARDWARE_NETWORKADAPTERDESCRIPTION_H__
#define __IPSDKHARDWARE_NETWORKADAPTERDESCRIPTION_H__

// suppression warnings
// warning C4251: 'ipsdk::hard::NetworkAdapterDescription::_adapterName' : class 'std::basic_string<_Elem,_Traits,_Ax>' needs to have dll-interface to be used by clients of class 'ipsdk::hard::NetworkAdapterDescription'
#pragma warning (push)
#pragma warning (disable : 4251)

#include <IPSDKHardware/IPSDKHardwareExports.h>
#include <IPSDKSerialization/Engine/BaseSerializationObject.h>
#include <IPSDKUtil/BaseTypes.h>
#include <IPSDKHardware/Network/NetworkAdapterTypes.h>
#include <IPSDKHardware/Network/MacAddress.h>

namespace ipsdk {
namespace hard {


class IPSDKHARDWARE_API NetworkAdapterDescription : public BaseSerializationObject
{
    // declare serial class
    IPSDK_DECLARE_SERIAL_WITH_COPY(IPSDKHardware, NetworkAdapterDescription)

public:
    NetworkAdapterDescription();
    ~NetworkAdapterDescription();
    
// methods
public:
    bool                isInit() const;

    void                    init(const std::string& adapterName,
                                 const std::string& friendlyAdapterName,
                                 const std::string& controllerDescription,
                                 const MacAddress& macAddress,
                                 const tcpip::AddressV4& ipV4Address,
                                 const tcpip::AddressV6& ipV6Address);

    const std::string&      getAdapterName() const;

    const std::string&      getFriendlyAdapterName() const;

    const std::string&      getControllerDescription() const;

    const MacAddress&       getMacAddress() const;

    const tcpip::AddressV4& getIpV4Address() const;

    const tcpip::AddressV6& getIpV6Address() const;

// attributes
protected:
    std::string         _adapterName;

    std::string         _friendlyAdapterName;

    std::string         _controllerDescription;

    MacAddress          _macAddress;

    tcpip::AddressV4    _ipV4Address;

    tcpip::AddressV6    _ipV6Address;

    bool                _bInit;
};


inline bool
NetworkAdapterDescription::isInit() const
{
    return _bInit;
}


} // end of namespace hard
} // end of namespace ipsdk

#pragma warning (pop)

#endif // __IPSDKHARDWARE_NETWORKADAPTERDESCRIPTION_H__