#include <source/ariba/SpoVNetProperties.h>
Public Types | |
enum | OverlayType { ONE_HOP_OVERLAY = 0, CHORD_OVERLAY = 1 } |
Public Member Functions | |
SpoVNetProperties () | |
SpoVNetProperties (const SpoVNetProperties ©) | |
virtual | ~SpoVNetProperties () |
const Name & | getName () const |
const SpoVNetID & | getId () const |
const NodeID & | getInitiator () const |
uint16_t | getIdentifierLength () const |
void | setIdentifierLength (uint16_t length) |
const OverlayType | getBaseOverlayType () const |
void | setBaseOverlayType (OverlayType type) |
bool | isHidden () const |
void | setHidden (bool is_hidden) |
std::string | toString () const |
Static Public Attributes | |
static const SpoVNetProperties | DEFAULT |
Private Attributes | |
Name | name |
SpoVNetID | id |
uint8_t | type |
uint16_t | idLength |
NodeID | initiator |
bool | hidden |
Definition at line 66 of file SpoVNetProperties.h.
ariba::SpoVNetProperties::SpoVNetProperties | ( | ) |
Constructs a new default SpoVnet property object.
Definition at line 45 of file SpoVNetProperties.cpp.
References name, and ariba::Name::toSpoVNetId().
ariba::SpoVNetProperties::SpoVNetProperties | ( | const SpoVNetProperties & | copy | ) |
Constructs a new SpoVnet property object.
TODO: replace with setters! for downwards compatibility Copy constructor.
Definition at line 52 of file SpoVNetProperties.cpp.
ariba::SpoVNetProperties::~SpoVNetProperties | ( | ) | [virtual] |
Destructor.
Definition at line 58 of file SpoVNetProperties.cpp.
const Name & ariba::SpoVNetProperties::getName | ( | ) | const |
Returns the canonical SpoVNet name
Definition at line 61 of file SpoVNetProperties.cpp.
References name.
const SpoVNetID & ariba::SpoVNetProperties::getId | ( | ) | const |
const NodeID & ariba::SpoVNetProperties::getInitiator | ( | ) | const |
Returns the node id of the initiator of the spovnet. If the node id is unspecified, the initiator wanted to be anonymous.
Definition at line 69 of file SpoVNetProperties.cpp.
References initiator.
uint16_t ariba::SpoVNetProperties::getIdentifierLength | ( | ) | const |
Returns the node identifier length in bites
Definition at line 73 of file SpoVNetProperties.cpp.
References idLength.
void ariba::SpoVNetProperties::setIdentifierLength | ( | uint16_t | length | ) | [inline] |
const SpoVNetProperties::OverlayType ariba::SpoVNetProperties::getBaseOverlayType | ( | ) | const |
Returns the overlay type.
Definition at line 77 of file SpoVNetProperties.cpp.
References type.
Referenced by ariba::Node::initiate().
void ariba::SpoVNetProperties::setBaseOverlayType | ( | OverlayType | type | ) | [inline] |
Definition at line 137 of file SpoVNetProperties.h.
bool ariba::SpoVNetProperties::isHidden | ( | ) | const |
Returns true, if the spovnet is hidden
Definition at line 81 of file SpoVNetProperties.cpp.
References hidden.
void ariba::SpoVNetProperties::setHidden | ( | bool | is_hidden | ) | [inline] |
std::string ariba::SpoVNetProperties::toString | ( | ) | const |
Returns a human readable string representation of the SpoVNet properties
Definition at line 85 of file SpoVNetProperties.cpp.
References hidden, idLength, initiator, name, ariba::Name::toString(), and type.
const SpoVNetProperties ariba::SpoVNetProperties::DEFAULT [static] |
This object holds the default settings for a newly created spovnet instance.
Definition at line 78 of file SpoVNetProperties.h.
Referenced by ariba::Node::getSpoVNetProperties().
Name ariba::SpoVNetProperties::name [private] |
Definition at line 158 of file SpoVNetProperties.h.
Referenced by getName(), SpoVNetProperties(), and toString().
SpoVNetID ariba::SpoVNetProperties::id [private] |
uint8_t ariba::SpoVNetProperties::type [private] |
Definition at line 160 of file SpoVNetProperties.h.
Referenced by getBaseOverlayType(), and toString().
uint16_t ariba::SpoVNetProperties::idLength [private] |
Definition at line 161 of file SpoVNetProperties.h.
Referenced by getIdentifierLength(), setIdentifierLength(), and toString().
NodeID ariba::SpoVNetProperties::initiator [private] |
bool ariba::SpoVNetProperties::hidden [private] |
Definition at line 163 of file SpoVNetProperties.h.
Referenced by isHidden(), setHidden(), and toString().