ADTF  3.18.2
cSystem::cAdapterInfo

Helper class to store ethernet adapter infos, see cSystem::GetEthernetAdapterInfo. More...

Inheritance diagram for cSystem::cAdapterInfo:
[legend]

Classes

struct  tAdapterInfo
 Internal struct used for storing the retrieved data. More...
 

Public Member Functions

tResult HandleAdapterInfo (const tChar *strName, const tChar *strDescription, tUInt8 *pui8PhysicalAddress)
 This will be called for each available ethernet adapter. More...
 
tBool Empty () const
 Returns whether or not object is empty. More...
 
tSize Size () const
 Returns the amount of adapter infos stored in this object. More...
 
const tAdapterInfoAt (tUInt nPos)
 Returns the given adapter information at position nPos. More...
 

Private Attributes

std::vector< tAdapterInfom_vecAdapters
 internal
 

Detailed Description

Member Function Documentation

◆ At()

const tAdapterInfo& At ( tUInt  nPos)
inline

Returns the given adapter information at position nPos.

Parameters
[in]nPos- Position of adapter information within the adapter info vector.
Returns
The given adapter information.

Definition at line 102 of file builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/src/libraries/a_utils/include/a_utils/sys/system.h.

◆ Empty()

tBool Empty ( ) const
inline

Returns whether or not object is empty.

Returns
Whether or not object is empty.

Definition at line 83 of file builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/src/libraries/a_utils/include/a_utils/sys/system.h.

◆ HandleAdapterInfo()

tResult HandleAdapterInfo ( const tChar strName,
const tChar strDescription,
tUInt8 pui8PhysicalAddress 
)
inlinevirtual

This will be called for each available ethernet adapter.

Parameters
[in]strNameThe name of the adapter.
[in]strDescriptionAn additional description of the adapter
[in]pui8PhysicalAddressThe physical address (MAC) of the adapter, an array of 6 bytes.
Returns

Implements cSystem::IAdapterInfoCallback.

Definition at line 66 of file builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/src/libraries/a_utils/include/a_utils/sys/system.h.

References MAX_ETHERNET_PHYSICAL_ADDRESS_LENGTH, cMemoryBlock::MemCopy(), and RETURN_NOERROR.

◆ Size()

tSize Size ( ) const
inline

Returns the amount of adapter infos stored in this object.

Returns
The amount of adapter infos stored in this object.

Definition at line 92 of file builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/src/libraries/a_utils/include/a_utils/sys/system.h.