ariba::addressing::mac_address_tpl< AddressInfo > Class Template Reference

#include <source/ariba/utility/addressing/mac_address.hpp>

Inherits address_convenience< mac_address_tpl< AddressInfo > >.

Collaboration diagram for ariba::addressing::mac_address_tpl< AddressInfo >:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 mac_address_tpl ()
 mac_address_tpl (const mac_address_tpl &copy)
 mac_address_tpl (const std::string &text)
 mac_address_tpl (const char *text)
 mac_address_tpl (const uint8_t *bytes, size_t size)
int compare_to (const mac_address_tpl &rhs) const
 implements comparison operators
bool is_bytes_size_static () const
 returns true, if this address has a fixed size in bytes
size_t to_bytes_size () const
 returns the number of bytes used for serialization of this address
void to_bytes (uint8_t *bytes) const
 converts this address to a binary representation
bool assign (const uint8_t *bytes, size_t size)
 Assigns an address using a bunch of bytes.
std::string to_string () const
 convert address to a string that can be used to reconstruct the address
bool assign (const std::string &text)
 Assigns an address using a human-readable.
bool assign (const mac_address_tpl &rhs)
 Assigns an address.
const std::string & type_name () const
const uint16_t type_id () const
bdaddr_t bluetooth () const
void bluetooth (bdaddr_t addr)

Private Attributes

uint8_t mac [6]


Detailed Description

template<class AddressInfo = mac_address_info>
class ariba::addressing::mac_address_tpl< AddressInfo >

TODO: Doc

Author:
Sebastian Mies <mies@tm.uka.de>

Definition at line 25 of file mac_address.hpp.


Constructor & Destructor Documentation

template<class AddressInfo = mac_address_info>
ariba::addressing::mac_address_tpl< AddressInfo >::mac_address_tpl (  )  [inline]

template<class AddressInfo = mac_address_info>
ariba::addressing::mac_address_tpl< AddressInfo >::mac_address_tpl ( const mac_address_tpl< AddressInfo > &  copy  )  [inline]

template<class AddressInfo = mac_address_info>
ariba::addressing::mac_address_tpl< AddressInfo >::mac_address_tpl ( const std::string &  text  )  [inline]

template<class AddressInfo = mac_address_info>
ariba::addressing::mac_address_tpl< AddressInfo >::mac_address_tpl ( const char *  text  )  [inline]

template<class AddressInfo = mac_address_info>
ariba::addressing::mac_address_tpl< AddressInfo >::mac_address_tpl ( const uint8_t *  bytes,
size_t  size 
) [inline]


Member Function Documentation

template<class AddressInfo = mac_address_info>
bool ariba::addressing::mac_address_tpl< AddressInfo >::assign ( const mac_address_tpl< AddressInfo > &  rhs  )  [inline]

Assigns an address.

Definition at line 110 of file mac_address.hpp.

References ariba::addressing::mac_address_tpl< AddressInfo >::mac.

template<class AddressInfo = mac_address_info>
bool ariba::addressing::mac_address_tpl< AddressInfo >::assign ( const std::string &  text  )  [inline]

Assigns an address using a human-readable.

Definition at line 98 of file mac_address.hpp.

References ariba::addressing::mac_address_tpl< AddressInfo >::mac.

template<class AddressInfo = mac_address_info>
bool ariba::addressing::mac_address_tpl< AddressInfo >::assign ( const uint8_t *  bytes,
size_t  size 
) [inline]

template<class AddressInfo = mac_address_info>
void ariba::addressing::mac_address_tpl< AddressInfo >::bluetooth ( bdaddr_t  addr  )  [inline]

template<class AddressInfo = mac_address_info>
bdaddr_t ariba::addressing::mac_address_tpl< AddressInfo >::bluetooth (  )  const [inline]

template<class AddressInfo = mac_address_info>
int ariba::addressing::mac_address_tpl< AddressInfo >::compare_to ( const mac_address_tpl< AddressInfo > &  rhs  )  const [inline]

implements comparison operators

Definition at line 54 of file mac_address.hpp.

References ariba::addressing::mac_address_tpl< AddressInfo >::mac.

Referenced by ariba::addressing::rfcomm_endpoint::compare_to().

template<class AddressInfo = mac_address_info>
bool ariba::addressing::mac_address_tpl< AddressInfo >::is_bytes_size_static (  )  const [inline]

returns true, if this address has a fixed size in bytes

Definition at line 64 of file mac_address.hpp.

template<class AddressInfo = mac_address_info>
void ariba::addressing::mac_address_tpl< AddressInfo >::to_bytes ( uint8_t *  bytes  )  const [inline]

converts this address to a binary representation

Definition at line 74 of file mac_address.hpp.

References ariba::addressing::mac_address_tpl< AddressInfo >::mac.

Referenced by ariba::addressing::rfcomm_endpoint::to_bytes().

template<class AddressInfo = mac_address_info>
size_t ariba::addressing::mac_address_tpl< AddressInfo >::to_bytes_size (  )  const [inline]

returns the number of bytes used for serialization of this address

Definition at line 69 of file mac_address.hpp.

Referenced by ariba::addressing::rfcomm_endpoint::to_bytes(), ariba::addressing::rfcomm_endpoint::to_bytes_size(), and ariba::addressing::endpoint_set::to_bytes_size().

template<class AddressInfo = mac_address_info>
std::string ariba::addressing::mac_address_tpl< AddressInfo >::to_string (  )  const [inline]

convert address to a string that can be used to reconstruct the address

Definition at line 90 of file mac_address.hpp.

References ariba::addressing::mac_address_tpl< AddressInfo >::mac.

Referenced by boost::hash< ariba::addressing::mac_address_tpl< T > >::operator()(), and ariba::addressing::rfcomm_endpoint::to_string().

template<class AddressInfo = mac_address_info>
const uint16_t ariba::addressing::mac_address_tpl< AddressInfo >::type_id (  )  const [inline]

Definition at line 122 of file mac_address.hpp.

template<class AddressInfo = mac_address_info>
const std::string& ariba::addressing::mac_address_tpl< AddressInfo >::type_name (  )  const [inline]

Definition at line 118 of file mac_address.hpp.


Member Data Documentation

template<class AddressInfo = mac_address_info>
uint8_t ariba::addressing::mac_address_tpl< AddressInfo >::mac[6] [private]


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

Generated on Fri Aug 14 23:39:14 2009 for Ariba by  doxygen 1.5.8