NeighborCandidateList Class Reference

#include <NeighborCandidateList.h>

List of all members.

---

Detailed Description

This class is for managing of possible neighbor nodes Used for JOIN-Protocol.

Public Member Functions
uint	getSize ()
	Get size of candidate list.
void	add (const NodeHandle &node)
	Add an node to candidate list.
void	remove (uint position)
	Removes node from position.
void	remove (const NodeHandle &node)
	Removes node.
bool	contains (const NodeHandle &node)
	Check if candidate list contains node.
const NodeHandle &	getRandomCandidate ()
const NodeHandle &	get (uint position)
	Get node from position.
void	clear ()
	Clear candidate list.
Protected Attributes
std::set< NodeHandle >	candidates
	contains all neighbor candidates

---

Member Function Documentation

void NeighborCandidateList::add

(

const NodeHandle &

node

)

Add an node to candidate list.

Parameters:

node

Node to add to candidate list

{
    assert(!(node.isUnspecified()));
    candidates.insert( node );
}

void NeighborCandidateList::clear

(

)

Clear candidate list.

{
    candidates.clear();
}

bool NeighborCandidateList::contains

(

const NodeHandle &

node

)

Check if candidate list contains node.

Parameters:

node

Returns:

true if list contains node

{
    if(node.key.isUnspecified())
        return false;

    std::set
        <NodeHandle>::iterator it = candidates.find(node);

    if(it != candidates.end() && it->key == node.key)
        return true;
    else
        return false;
}

const NodeHandle & NeighborCandidateList::get

(

uint

position

)

Get node from position.

Parameters:

position

{
    if ( position >= candidates.size() )
        return NodeHandle::UNSPECIFIED_NODE;
    else {
        std::set
            <NodeHandle>::iterator it = candidates.begin();
        for (uint i=0; i<position; i++) {
            it++;
        }
        return *it;
    }
}

const NodeHandle & NeighborCandidateList::getRandomCandidate

(

)

{
    return get
               (intuniform(0, getSize()));
}

uint NeighborCandidateList::getSize

(

)

Get size of candidate list.

Returns:

Size of candidate list

{
    return candidates.size();
}

void NeighborCandidateList::remove

(

const NodeHandle &

node

)

Removes node.

Parameters:

node

Node to remove from candidate list

{
    candidates.erase(node);
}

void NeighborCandidateList::remove

(

uint

position

)

Removes node from position.

Parameters:

position

{
    std::set
        <NodeHandle>::iterator it = candidates.begin();
    for (uint i=0; i<position; i++) {
        it++;
    }
    candidates.erase( it );
}

---

Member Data Documentation

std::set<NodeHandle> NeighborCandidateList::candidates [protected]

contains all neighbor candidates

---

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

• NeighborCandidateList.h
• NeighborCandidateList.cc

---