ariba::SpoVNetProperties Class Reference

#include <source/ariba/SpoVNetProperties.h>

Collaboration diagram for ariba::SpoVNetProperties:

Collaboration graph
[legend]

List of all members.

Public Types

enum  OverlayType { ONE_HOP_OVERLAY = 0, CHORD_OVERLAY = 1 }

Public Member Functions

 SpoVNetProperties ()
 SpoVNetProperties (const SpoVNetProperties &copy)
virtual ~SpoVNetProperties ()
const NamegetName () const
const SpoVNetIDgetId () const
const NodeIDgetInitiator () 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


Detailed Description

This class implements a container that holds all properties of a SpoVNet instance. It may evolve with new features when new features are introduced.

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

Christoph Mayer <mayer@tm.uka.de>

Definition at line 66 of file SpoVNetProperties.h.


Member Enumeration Documentation

Enumerator:
ONE_HOP_OVERLAY 
CHORD_OVERLAY 

Definition at line 68 of file SpoVNetProperties.h.


Constructor & Destructor Documentation

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.


Member Function Documentation

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

Returns the SpoVNet id

Definition at line 65 of file SpoVNetProperties.cpp.

References id.

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]

Definition at line 128 of file SpoVNetProperties.h.

References idLength.

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]

Definition at line 146 of file SpoVNetProperties.h.

References hidden.

std::string ariba::SpoVNetProperties::toString (  )  const

Returns a human readable string representation of the SpoVNet properties

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.


Member Data Documentation

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().

Definition at line 158 of file SpoVNetProperties.h.

Referenced by getName(), SpoVNetProperties(), and toString().

Definition at line 159 of file SpoVNetProperties.h.

Referenced by getId().

uint8_t ariba::SpoVNetProperties::type [private]

Definition at line 160 of file SpoVNetProperties.h.

Referenced by getBaseOverlayType(), and toString().

Definition at line 161 of file SpoVNetProperties.h.

Referenced by getIdentifierLength(), setIdentifierLength(), and toString().

Definition at line 162 of file SpoVNetProperties.h.

Referenced by getInitiator(), and toString().

Definition at line 163 of file SpoVNetProperties.h.

Referenced by isHidden(), setHidden(), and toString().


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

Generated on Wed May 27 18:23:57 2009 for Ariba by  doxygen 1.5.6