Menu

famouso::mw::nl::NetworkID< size > Struct Template Reference

An ID representing a node at the network. More...

#include <NetworkID.h>

Public Types

typedef NetworkID< size > type

Public Member Functions

bool operator== (const NetworkID &o) const
 Compare 2 NetworkIDs of equality.
bool operator< (const NetworkID &o) const
 Compare two network ids for sorting.
void print (::logging::loggingReturnType &out) const
 prints the NetworkID to the stream.
 operator const uint8_t * () const

Static Public Member Functions

static NetworkID parse (uint8_t data[size])
 Parse a pointer and return a NetworkID.

Detailed Description

template<uint16_t size = 0>
struct famouso::mw::nl::NetworkID< size >

An ID representing a node at the network.

Template Parameters:
size The number of bytes the id can be long.

Member Typedef Documentation

template<uint16_t size = 0>
typedef NetworkID<size> famouso::mw::nl::NetworkID< size >::type

Member Function Documentation

template<uint16_t size = 0>
famouso::mw::nl::NetworkID< size >::operator const uint8_t * (  )  const [inline]
template<uint16_t size = 0>
bool famouso::mw::nl::NetworkID< size >::operator< ( const NetworkID< size > &  o  )  const [inline]

Compare two network ids for sorting.

Parameters:
o The other network id to compare with.
Returns:
True if this id is smaller than the other id, otherwise false.
template<uint16_t size = 0>
bool famouso::mw::nl::NetworkID< size >::operator== ( const NetworkID< size > &  o  )  const [inline]

Compare 2 NetworkIDs of equality.

Parameters:
o The other NetworkID.
Returns:
true if the NetworkIDs are equal, false otherwise.
template<uint16_t size = 0>
static NetworkID famouso::mw::nl::NetworkID< size >::parse ( uint8_t  data[size]  )  [inline, static]

Parse a pointer and return a NetworkID.

Parameters:
data The pointer where the NetworkID can be located.
Returns:
A NetworkID.
template<uint16_t size = 0>
void famouso::mw::nl::NetworkID< size >::print ( ::logging::loggingReturnType &  out  )  const [inline]

prints the NetworkID to the stream.

Parameters:
out The output stream to print to.
The documentation for this struct was generated from the following file: