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

Structure encapsulating a network adapter mac address. More...

#include <MacAddress.h>

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

Public Member Functions

bool isInit () const
 retrieve object initialization flag
 
void init (const UInt8Vector &macAddress)
 initialize adapter mac address More...
 
const UInt8VectorgetAddress () const
 get address associated to object More...
 
void clear ()
 clear adapter mac address
 
std::string to_string () const
 convert mac address to string (format "ff:ff:ff::ff::ff::ff")
 
bool from_string (const std::string &str)
 initialize mac address from string (format "ff:ff:ff::ff::ff::ff")
 
Constructors and destructors
 MacAddress ()
 
 ~MacAddress ()
 
- 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

UInt8Vector _macAddress
 adapter mac address
 

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

Structure encapsulating a network adapter mac address.

Author
E. Noirfalise
Date
2013/11/27

Member Function Documentation

◆ init()

void ipsdk::hard::MacAddress::init ( const UInt8Vector macAddress)

initialize adapter mac address

Exceptions
ipsdk::hard::IPSDKHardwareExceptionif macAddress.empty() == true

◆ getAddress()

const UInt8Vector& ipsdk::hard::MacAddress::getAddress ( ) const

get address associated to object

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

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