IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
Public Member Functions | Protected Attributes | List of all members
ipsdk::hard::NetworkAdapterDescription Class Reference

Description associated to a network adapter resource. More...

#include <NetworkAdapterDescription.h>

Inheritance diagram for ipsdk::hard::NetworkAdapterDescription:
ipsdk::BaseSerializationObject ipsdk::BaseDynamicObject

Public Member Functions

bool isInit () const
 recovery of object initialization flag
 
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)
 initialization of object
 
const std::string & getAdapterName () const
 retrieve adapter name More...
 
const std::string & getFriendlyAdapterName () const
 retrieve friendly adapter name More...
 
const std::string & getControllerDescription () const
 retrieve hardware controller description More...
 
const MacAddressgetMacAddress () const
 retrieve adapter mac address More...
 
const tcpip::AddressV4getIpV4Address () const
 retrieve ip v4 address associated to network adapter More...
 
const tcpip::AddressV6getIpV6Address () const
 retrieve ip v6 address associated to network adapter More...
 
Constructors and destructors
 NetworkAdapterDescription ()
 
 ~NetworkAdapterDescription ()
 
- Public Member Functions inherited from ipsdk::BaseSerializationObject
 BaseSerializationObject ()
 Default constructor.
 
virtual ~BaseSerializationObject ()=0
 destructor
 
- Public Member Functions inherited from ipsdk::BaseDynamicObject
virtual const std::string & getClassName () const
 method allowing to retrieve object class name
 
virtual BaseDynamicObjectcreateNew () const =0
 method allowing to create new instance of current object type
 
virtual DynamicObjectPtr createShared () const =0
 method allowing to create new shared instance of current object type
 
virtual bool hasCopySupport () const =0
 check whether objet has copy support
 
virtual BaseDynamicObjectduplicate () const =0
 method allowing to duplicate current object More...
 
virtual DynamicObjectPtr duplicateShared () const =0
 method allowing shared duplication of current object More...
 
 BaseDynamicObject ()
 
virtual ~BaseDynamicObject ()=0
 

Protected Attributes

std::string _adapterName
 adapter name
 
std::string _friendlyAdapterName
 friendly adapter name
 
std::string _controllerDescription
 hardware controller description
 
MacAddress _macAddress
 adapter mac address
 
tcpip::AddressV4 _ipV4Address
 ip v4 address associated to network adapter
 
tcpip::AddressV6 _ipV6Address
 ip v6 address associated to network adapter
 
bool _bInit
 object initialization flag
 

Additional Inherited Members

- Static Public Member Functions inherited from ipsdk::BaseSerializationObject
static ipUInt32 getVersion ()
 method allowing to retrieve class version information for serialization
 
- Static Public Member Functions inherited from ipsdk::BaseDynamicObject
static const std::string & getTypeName ()
 method allowing to retrieve name associated to class
 
- Protected Member Functions inherited from ipsdk::BaseSerializationObject
virtual BoolResult write (BaseOArchive &ar) const
 method allowing to ensure serialization write part for object
 
virtual BoolResult read (BaseIArchive &ar)
 method allowing to ensure serialization read part for object
 
- Protected Member Functions inherited from ipsdk::BaseDynamicObject
virtual void initCtorCopy (const BaseDynamicObject &object)
 
virtual void copy (const BaseDynamicObject &object)
 method allowing to copy data from another object
 

Detailed Description

Description associated to a network adapter resource.

Author
E. Noirfalise
Date
2013/3/27

Member Function Documentation

◆ getAdapterName()

const std::string& ipsdk::hard::NetworkAdapterDescription::getAdapterName ( ) const

retrieve adapter name

Exceptions
ipsdk::hard::IPSDKHardwareExceptionif isInit() == false

◆ getFriendlyAdapterName()

const std::string& ipsdk::hard::NetworkAdapterDescription::getFriendlyAdapterName ( ) const

retrieve friendly adapter name

Exceptions
ipsdk::hard::IPSDKHardwareExceptionif isInit() == false

◆ getControllerDescription()

const std::string& ipsdk::hard::NetworkAdapterDescription::getControllerDescription ( ) const

retrieve hardware controller description

Exceptions
ipsdk::hard::IPSDKHardwareExceptionif isInit() == false

◆ getMacAddress()

const MacAddress& ipsdk::hard::NetworkAdapterDescription::getMacAddress ( ) const

retrieve adapter mac address

Exceptions
ipsdk::hard::IPSDKHardwareExceptionif isInit() == false

◆ getIpV4Address()

const tcpip::AddressV4& ipsdk::hard::NetworkAdapterDescription::getIpV4Address ( ) const

retrieve ip v4 address associated to network adapter

Exceptions
ipsdk::hard::IPSDKHardwareExceptionif isInit() == false

◆ getIpV6Address()

const tcpip::AddressV6& ipsdk::hard::NetworkAdapterDescription::getIpV6Address ( ) const

retrieve ip v6 address associated to network adapter

Exceptions
ipsdk::hard::IPSDKHardwareExceptionif isInit() == false

The documentation for this class was generated from the following file: