UnderlayConfigurator Class Reference

#include <UnderlayConfigurator.h>

Inheritance diagram for UnderlayConfigurator:

List of all members.

---

Detailed Description

Base class for configurators of different underlay models.

Author:

Stephan Krause, Bernhard Heep

Public Member Functions
bool	isInit ()
	still in initialization phase?
Public Attributes
timeval	initFinishedTime
	timestamp at end of init phase
Protected Member Functions
int	numInitStages () const
	OMNeT number of init stages.
virtual void	initialize (int stage)
	OMNeT init methods.
virtual void	initializeUnderlay (int stage)=0
	Init method for derived underlay configurators.
virtual int	createRandomNode (bool initialize)=0
	Creates an overlay node.
virtual void	killRandomNode ()=0
	Removes randomly chosen overlay nodes from a randomly chosen access net.
virtual void	migrateRandomNode ()=0
	Migrates randomly chosen overlay nodes from on access net to another.
virtual void	finish ()=0
	Cleans up configurator.
virtual void	setDisplayString ()=0
	Sets display string.
void	handleMessage (cMessage *msg)
	Node mobility simulation.
Protected Attributes
std::vector< std::string >	channelTypes
	possible access types
bool	init
	still in initialization phase?
int	initialOverlayTerminalNum
	number of overlay terminals at beginning of simulation
int	targetOverlayTerminalNum
	final number of overlay terminals
int	overlayTerminalCount
	current number of overlay terminals
bool	keepFirstNode
int	firstNodeId
Private Attributes
double	creationProbability
	probability of creating a new overlay terminal
double	migrationProbability
	probability of migrating an overlay terminal
double	removalProbability
	probability of removing an overlay terminal
double	initialMean
	mean of update interval during initalization phase
double	initialDeviation
	deviation of update interval during initalization phase
double	targetMean
	mean of update interval after initalization phase
cMessage *	churnMsg
bool	churnIntervalChanged

---

Member Function Documentation

virtual int UnderlayConfigurator::createRandomNode

(

bool

initialize

)

[protected, pure virtual]

Creates an overlay node.

Parameters:

initialize

Implemented in IPv4UnderlayConfigurator, SimpleNetConfigurator, and SingleHostConfigurator.

virtual void UnderlayConfigurator::finish

(

)

[protected, pure virtual]

Cleans up configurator.

Implemented in IPv4UnderlayConfigurator, SimpleNetConfigurator, and SingleHostConfigurator.

void UnderlayConfigurator::handleMessage

(

cMessage *

msg

)

[protected]

Node mobility simulation.

Parameters:

msg

timer-message

{
    //schedule churnMsg
    if((double)(par("churnChangeInterval")) == 0) {
        targetMean = par("targetMobilityDelay");
        churnIntervalChanged = false;
    } else if(!churnMsg->isScheduled()) {
        scheduleAt(simulation.simTime() + (double)(par("churnChangeInterval")), churnMsg);
    }

    if(msg == churnMsg) {
        if(churnIntervalChanged) {
            targetMean = par("targetMobilityDelay");
            churnIntervalChanged = false;
        } else {
            targetMean = par("targetMobilityDelay2");
            churnIntervalChanged = true;
        }
        std::stringstream temp;
        temp << "Churn-rate changed to " << targetMean;
        bubble(temp.str().c_str());
    }
    else if ( init ) {
        // increase the number of nodes steadily during setup

        init = (overlayTerminalCount < (int)par("targetOverlayTerminalNum"));

        if (!init)
            gettimeofday(&initFinishedTime, NULL);
        else
            createRandomNode(false);

        scheduleAt(simulation.simTime()
                   + truncnormal(initialMean, initialDeviation), msg);
    } else {          
        double random = uniform(0, 1);

        // modify the number of nodes according to user parameters
        if (overlayTerminalCount != 0) {
            if(random < creationProbability) {
                createRandomNode(false);
            } else if(creationProbability <= random &&
                      random < creationProbability + removalProbability &&
                      overlayTerminalCount > 1) {
                killRandomNode();
            } else if ( creationProbability + removalProbability <= random &&
                        random < creationProbability + removalProbability
                        + migrationProbability) {
                migrateRandomNode();
            }
        }
        scheduleAt(simulation.simTime() + truncnormal(targetMean, targetMean / 3), msg);
    }
    setDisplayString();
}

void UnderlayConfigurator::initialize

(

int

stage

)

[protected, virtual]

OMNeT init methods.

{
    if(stage == MIN_STAGE_UNDERLAY) {
        initialOverlayTerminalNum = par("initialOverlayTerminalNum");
        targetOverlayTerminalNum = par("targetOverlayTerminalNum");
        creationProbability = par("creationProbability");
        migrationProbability = par("migrationProbability");
        removalProbability = par("removalProbability");
        initialMean = par("initialMobilityDelay");
        initialDeviation = initialMean / 3;
        targetMean = par("targetMobilityDelay");
        WATCH(targetMean);
        //targetDeviation = targetMean / 3;
        channelTypes = cStringTokenizer(par("channelTypes"), " ").asVector();
        init = true;
        gettimeofday(&initFinishedTime, NULL);
        keepFirstNode = par("keepFirstNode");
        firstNodeId = -1;
        WATCH(firstNodeId);

        churnMsg = new cMessage;
        churnIntervalChanged = false;
    }

    if(stage >= MIN_STAGE_UNDERLAY && stage <= MAX_STAGE_UNDERLAY)
        initializeUnderlay(stage);
}

virtual void UnderlayConfigurator::initializeUnderlay

(

int

stage

)

[protected, pure virtual]

Init method for derived underlay configurators.

Implemented in IPv4UnderlayConfigurator, SimpleNetConfigurator, and SingleHostConfigurator.

bool UnderlayConfigurator::isInit

(

)

[inline]

still in initialization phase?

    {
        return init;
    };

virtual void UnderlayConfigurator::killRandomNode

(

)

[protected, pure virtual]

Removes randomly chosen overlay nodes from a randomly chosen access net.

Implemented in IPv4UnderlayConfigurator, SimpleNetConfigurator, and SingleHostConfigurator.

virtual void UnderlayConfigurator::migrateRandomNode

(

)

[protected, pure virtual]

Migrates randomly chosen overlay nodes from on access net to another.

Implemented in IPv4UnderlayConfigurator, SimpleNetConfigurator, and SingleHostConfigurator.

int UnderlayConfigurator::numInitStages

(

)

const [protected]

OMNeT number of init stages.

{
    return MAX_STAGE_UNDERLAY + 1;
}

virtual void UnderlayConfigurator::setDisplayString

(

)

[protected, pure virtual]

Sets display string.

Implemented in IPv4UnderlayConfigurator, SimpleNetConfigurator, and SingleHostConfigurator.

---

Member Data Documentation

std::vector<std::string> UnderlayConfigurator::channelTypes [protected]

possible access types

bool UnderlayConfigurator::churnIntervalChanged [private]

cMessage* UnderlayConfigurator::churnMsg [private]

double UnderlayConfigurator::creationProbability [private]

probability of creating a new overlay terminal

int UnderlayConfigurator::firstNodeId [protected]

bool UnderlayConfigurator::init [protected]

still in initialization phase?

struct timeval UnderlayConfigurator::initFinishedTime

timestamp at end of init phase

double UnderlayConfigurator::initialDeviation [private]

deviation of update interval during initalization phase

double UnderlayConfigurator::initialMean [private]

mean of update interval during initalization phase

int UnderlayConfigurator::initialOverlayTerminalNum [protected]

number of overlay terminals at beginning of simulation

bool UnderlayConfigurator::keepFirstNode [protected]

double UnderlayConfigurator::migrationProbability [private]

probability of migrating an overlay terminal

int UnderlayConfigurator::overlayTerminalCount [protected]

current number of overlay terminals

double UnderlayConfigurator::removalProbability [private]

probability of removing an overlay terminal

double UnderlayConfigurator::targetMean [private]

mean of update interval after initalization phase

int UnderlayConfigurator::targetOverlayTerminalNum [protected]

final number of overlay terminals

---

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

• UnderlayConfigurator.h
• UnderlayConfigurator.cc

---