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 OverlayType getBaseOverlayType () const
void setBaseOverlayType (OverlayType type)
std::string toString () const

Static Public Attributes

static const SpoVNetProperties DEFAULT

Private Attributes

uint8_t type

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

Different types of overlays that are supported

Enumerator:
ONE_HOP_OVERLAY 
CHORD_OVERLAY 

Definition at line 71 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.

ariba::SpoVNetProperties::SpoVNetProperties ( const SpoVNetProperties copy  ) 

Copy constructor.

Definition at line 49 of file SpoVNetProperties.cpp.

ariba::SpoVNetProperties::~SpoVNetProperties (  )  [virtual]

Destructor.

Definition at line 53 of file SpoVNetProperties.cpp.


Member Function Documentation

const SpoVNetProperties::OverlayType ariba::SpoVNetProperties::getBaseOverlayType (  )  const

Returns the overlay type.

Definition at line 56 of file SpoVNetProperties.cpp.

References type.

Referenced by ariba::Node::initiate().

void ariba::SpoVNetProperties::setBaseOverlayType ( OverlayType  type  )  [inline]

Definition at line 102 of file SpoVNetProperties.h.

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 60 of file SpoVNetProperties.cpp.

References type.


Member Data Documentation

This object holds the default settings for a newly created spovnet instance.

Definition at line 80 of file SpoVNetProperties.h.

Referenced by ariba::Node::getSpoVNetProperties().

uint8_t ariba::SpoVNetProperties::type [private]

Definition at line 114 of file SpoVNetProperties.h.

Referenced by getBaseOverlayType(), and toString().


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

Generated on Fri Dec 10 11:09:24 2010 for Ariba by  doxygen 1.6.1