inet::MoBANCoordinator Class Reference

This is the coordinator module of the MoBAN mobility model. More...

#include <MoBANCoordinator.h>

Inheritance diagram for inet::MoBANCoordinator:

Classes
struct	pattern
	Data type for one instance of mobility pattern. More...

Public Member Functions
	MoBANCoordinator ()
	~MoBANCoordinator ()
virtual double	getMaxSpeed () const override
	Returns the maximum possible speed at any future time. More...
Public Member Functions inherited from inet::LineSegmentsMobilityBase
	LineSegmentsMobilityBase ()
Public Member Functions inherited from inet::MovingMobilityBase
virtual Coord	getCurrentPosition () override
	Returns the current position at the current simulation time. More...
virtual Coord	getCurrentSpeed () override
	Returns the current speed at the current simulation time. More...
virtual EulerAngles	getCurrentAngularPosition () override
	Returns the current angular position at the current simulation time. More...
Public Member Functions inherited from inet::MobilityBase
virtual EulerAngles	getCurrentAngularSpeed () override
	Returns the current angular speed at the current simulation time. More...
virtual Coord	getConstraintAreaMax () const override
	Returns the current angular acceleration at the current simulation time. More...
virtual Coord	getConstraintAreaMin () const override
Public Member Functions inherited from inet::IMobility
virtual	~IMobility ()

Protected Types
enum	posture_sel_type { UNIFORM_RANDOM = 0, MARKOV_BASE }
	Possible (supported) strategies for posture selection. More...
typedef struct inet::MoBANCoordinator::pattern	Pattern
	Data type for one instance of mobility pattern. More...

Protected Member Functions
virtual int	numInitStages () const override
	Returns the required number of initialize stages. More...
virtual void	initialize (int) override
	Initializes mobility model parameters. More...
virtual void	setInitialPosition () override
	Initializes the position from the display string or from module parameters. More...
virtual void	setTargetPosition () override
	Set a new target position from the next posture. More...
virtual cModule *	findVisualRepresentation () override
	Returns the module that represents the object moved by this mobility module. More...
virtual void	finish () override
	To be called at the end of simulation run. More...
virtual void	refreshDisplay () const override
void	selectPosture ()
	Function to select the next posture considering the current posture and the Markov model. More...
Coord	selectDestination ()
	Function to select the destination in the case of a mobile posture. More...
double	selectSpeed ()
	Select a velocity value within the given velocity range. More...
simtime_t	selectDuration ()
	Select a stay time duration in the specified range for the new posture. More...
bool	isInsideWorld (Coord)
	Checks if all nodes of the WBAN are inside the simulation environment with the given position of the logical center. More...
bool	readPostureSpecificationFile ()
	Reading the input postures specification file and making the posture data base. More...
bool	readConfigurationFile ()
	Reads the input configuration file. More...
bool	readMobilityPatternFile ()
	Reads the previously logged mobility pattern and make mobility pattern data base. More...
void	publishToNodes ()
	Publishes the reference point and other information of the posture to the blackboard of the belonging nodes. More...
void	collectLocalModules (cModule *module)
	Collect MoBAN local modules. More...
void	computeMaxSpeed ()
Protected Member Functions inherited from inet::LineSegmentsMobilityBase
virtual void	initializePosition () override
	Initializes mobility position. More...
virtual void	move () override
	Moves according to the mobility model to the current simulation time. More...
Protected Member Functions inherited from inet::MovingMobilityBase
	MovingMobilityBase ()
virtual	~MovingMobilityBase ()
virtual void	handleSelfMessage (cMessage *message) override
	Called upon arrival of a self messages, subclasses must override. More...
void	scheduleUpdate ()
	Schedules the move timer that will update the mobility state. More...
void	moveAndUpdate ()
	Moves and notifies listeners. More...
Protected Member Functions inherited from inet::MobilityBase
	MobilityBase ()
virtual void	checkPosition ()
	Checks whether the position is valid or not. More...
virtual void	initializeOrientation ()
	Initializes the orientation from module parameters. More...
virtual void	handleMessage (cMessage *msg) override
	This modules should only receive self-messages. More...
virtual void	updateVisualRepresentation ()
	Moves the visual representation module's icon to the new position on the screen. More...
virtual void	emitMobilityStateChangedSignal ()
	Emits a signal with the updated mobility state. More...
virtual Coord	getRandomPosition ()
	Returns a new random position satisfying the constraint area. More...
virtual bool	isOutside ()
	Returns true if the mobility is outside of the constraint area. More...
virtual void	reflectIfOutside (Coord &targetPosition, Coord &speed, double &angle)
	Utility function to reflect the node if it goes outside the constraint area. More...
virtual void	wrapIfOutside (Coord &targetPosition)
	Utility function to wrap the node to the opposite edge (torus) if it goes outside the constraint area. More...
virtual void	placeRandomlyIfOutside (Coord &targetPosition)
	Utility function to place the node randomly if it goes outside the constraint area. More...
virtual void	raiseErrorIfOutside ()
	Utility function to raise an error if the node gets outside the constraint area. More...
virtual void	handleIfOutside (BorderPolicy policy, Coord &targetPosition, Coord &speed, double &angle)
	Invokes one of reflectIfOutside(), wrapIfOutside() and placeRandomlyIfOutside(), depending on the given border policy. More...

Protected Attributes
std::vector< MoBANLocal * >	localModules
	The mobility modules of the nodes in this WBAN. More...
double	speed
	Currently selected speed for the mobile posture. More...
double	maxSpeed
	The possible maximum speed at any future time. More...
FILE *	logfile
	Pointer to the file for logging MoBAN mobility pattern for future use. More...
unsigned int	numPostures
	Number of predefined postures. More...
std::vector< Posture * >	postureList
	The list of all predefined postures (posture data base) More...
Posture *	currentPosture
	The current selected posture. More...
simtime_t	minDuration
	The minimum value of the duration for stable postures. More...
simtime_t	maxDuration
	The maximum value of the duration for stable postures. More...
bool	useMobilityPattern
	Variable that shows if reusing previously logged mobility pattern is requested. More...
Pattern *	mobilityPattern
	The mobility pattern data base. More...
int	patternLength
	The number of mobility pattern instances which has been read from the input file (length of mobility pattern data base). More...
int	currentPattern
	The index of the currently applied mobility pattern from. More...
double **	markovMatrix
	A matrix which maintains the transition probabilities of the Markov Model of posture pattern. More...
posture_sel_type	postureSelStrategy
	The requested strategy for posture selection. More...
PostureTransition *	transitions
	Class for performing operation for spatial and temporal correlations in posture selection. More...
Protected Attributes inherited from inet::LineSegmentsMobilityBase
Coord	targetPosition
	End position of current linear movement. More...
Protected Attributes inherited from inet::MovingMobilityBase
cMessage *	moveTimer
	The message used for mobility state changes. More...
simtime_t	updateInterval
	The simulation time interval used to regularly signal mobility state changes. More...
bool	stationary
	A mobility model may decide to become stationary at any time. More...
Coord	lastSpeed
	The last speed that was reported at lastUpdate. More...
simtime_t	lastUpdate
	The simulation time when the mobility state was last updated. More...
simtime_t	nextChange
	The next simulation time when the mobility module needs to update its internal state. More...
Protected Attributes inherited from inet::MobilityBase
cModule *	visualRepresentation
	Pointer to visual representation module, to speed up repeated access. More...
const CanvasProjection *	canvasProjection
	The 2D projection used on the canvas. More...
Coord	constraintAreaMin
	3 dimensional position and size of the constraint area (in meters). More...
Coord	constraintAreaMax
Coord	lastPosition
	The last position that was reported. More...
EulerAngles	lastOrientation
	The last position that was reported. More...

Additional Inherited Members
Public Types inherited from inet::MobilityBase
enum	BorderPolicy { REFLECT, WRAP, PLACERANDOMLY, RAISEERROR }
	Selects how a mobility module should behave if it reaches the edge of the constraint area. More...
Static Public Attributes inherited from inet::IMobility
static simsignal_t	mobilityStateChangedSignal = cComponent::registerSignal("mobilityStateChanged")
	A signal used to publish mobility state changes. More...

Detailed Description

This is the coordinator module of the MoBAN mobility model.

It should be instantiated in the top level simulation network, once per WBAN. The coordinator module is the main module that provides the group mobility and correlation between nodes in a WBAN. In the initialization phase, it reads three user defined input files which are the postures specification file, a configuration file which includes all required parameter for specific distributions, and the previously logged mobility pattern, if it is requested to use a logged pattern. Note that all WBAN instances may use the same input files if they are exactly in the same situation.

After the initialization phase, the MoBAN coordinator decides about the posture and the position of the Logical center of the group (WBAN). The absolute position of the reference point of each belonging node is calculated by adding the current position of the logical center by the reference point of that node in the selected posture. The coordinator sets the position of the reference point as well as the speed and the radius of the local movement of nodes.

Author

Majid Nabi

Member Typedef Documentation

typedef struct inet::MoBANCoordinator::pattern inet::MoBANCoordinator::Pattern

protected

Data type for one instance of mobility pattern.

Member Enumeration Documentation

enum inet::MoBANCoordinator::posture_sel_type

protected

Possible (supported) strategies for posture selection.

Enumerator
UNIFORM_RANDOM
MARKOV_BASE

                          {
        UNIFORM_RANDOM = 0,    // uniform random posture selection. No correlation is applied.
        MARKOV_BASE    // Either a Markov model matrix or a steady state vector is given for space-time domains
    };

Constructor & Destructor Documentation

inet::MoBANCoordinator::MoBANCoordinator

(

)

                                   :
        speed(0),
        maxSpeed(0),
        logfile(nullptr),
        numPostures(0),
        currentPosture(nullptr),
        useMobilityPattern(false),
        mobilityPattern(nullptr),
        patternLength(0),
        currentPattern(-1),
        markovMatrix(nullptr),
        postureSelStrategy(MoBANCoordinator::posture_sel_type(-1)),
        transitions(nullptr)
{
}

inet::MoBANCoordinator::~MoBANCoordinator

(

)

{
    delete transitions;
    delete [] mobilityPattern;
    for (auto & elem : postureList)
        delete elem;
}

Member Function Documentation

void inet::MoBANCoordinator::collectLocalModules ( cModule *  module )

protected

Collect MoBAN local modules.

Referenced by initialize().

{
    for (cModule::SubmoduleIterator it(module); !it.end(); it++) {
        cModule *submodule = *it;
        collectLocalModules(submodule);
        MoBANLocal *localModule = dynamic_cast<MoBANLocal *>(submodule);
        if (localModule && localModule->par("coordinatorIndex").longValue() == getIndex()) {
            localModule->setCoordinator(this);
            localModules.push_back(localModule);
        }
    }
}

void inet::MoBANCoordinator::computeMaxSpeed ( )

protected

Referenced by initialize().

{
    if (useMobilityPattern)
    {
        for (int i = 0; i < patternLength; i++)
        {
            double patSpeed = mobilityPattern[i].speed;
            if (maxSpeed < patSpeed)
                maxSpeed = patSpeed;
        }
    }
    else
    {
        for (auto & elem : postureList)
        {
            double postureMaxSpeed = elem->getMaxSpeed();
            if (maxSpeed < postureMaxSpeed)
                maxSpeed = postureMaxSpeed;
        }

    }
}

virtual cModule* inet::MoBANCoordinator::findVisualRepresentation ( )

inlineoverrideprotectedvirtual

Returns the module that represents the object moved by this mobility module.

Reimplemented from inet::MobilityBase.

{ return this; }

void inet::MoBANCoordinator::finish ( )

overrideprotectedvirtual

To be called at the end of simulation run.

{
    fclose(logfile);
}

virtual double inet::MoBANCoordinator::getMaxSpeed ( ) const

inlineoverridevirtual

Returns the maximum possible speed at any future time.

Reimplemented from inet::MobilityBase.

Referenced by inet::MoBANLocal::computeMaxSpeed().

{ return maxSpeed; }

void inet::MoBANCoordinator::initialize ( int  stage )

overrideprotectedvirtual

Initializes mobility model parameters.

Reimplemented from inet::MovingMobilityBase.

{
    LineSegmentsMobilityBase::initialize(stage);

    EV_TRACE << "initializing MoBANCoordinator stage " << stage << endl;
    if (stage == INITSTAGE_PHYSICAL_ENVIRONMENT) {
        useMobilityPattern = par("useMobilityPattern").boolValue();
        collectLocalModules(getParentModule());

        // preparing output mobility pattern log file
        char log_file_name[70];
        sprintf(log_file_name, "MoBAN_Pattern_out%d.txt", getIndex());
        logfile = fopen(log_file_name, "w");

        if (!readPostureSpecificationFile())
            throw cRuntimeError("MoBAN Coordinator: error in reading the posture specification file");

        if (!readConfigurationFile())
            throw cRuntimeError("MoBAN Coordinator: error in reading the input configuration file");

        if (useMobilityPattern)
            if (!readMobilityPatternFile())
                throw cRuntimeError("MoBAN Coordinator: error in reading the input mobility pattern file");


        lastPosition = selectDestination();
        publishToNodes();
        computeMaxSpeed();
    }
}

bool inet::MoBANCoordinator::isInsideWorld ( Coord  tPos )

protected

Checks if all nodes of the WBAN are inside the simulation environment with the given position of the logical center.

Checks if all nodes of the WBAN are inside the simulation environment with the current position.

Referenced by selectDestination().

{
    Coord absolutePosition;

    for (unsigned int i = 0; i < localModules.size(); ++i) {
        absolutePosition = tPos + currentPosture->getPs(i);
        if (!absolutePosition.isInBoundary(this->constraintAreaMin, this->constraintAreaMax))
            return false;
    }

    return true;
}

virtual int inet::MoBANCoordinator::numInitStages ( ) const

inlineoverrideprotectedvirtual

Returns the required number of initialize stages.

Reimplemented from inet::MobilityBase.

{ return NUM_INIT_STAGES; }

void inet::MoBANCoordinator::publishToNodes ( )

protected

Publishes the reference point and other information of the posture to the blackboard of the belonging nodes.

Referenced by initialize(), and setTargetPosition().

{
    for (unsigned int i = 0; i < localModules.size(); ++i) {
        MoBANLocal *localModule = localModules[i];
        EV_DEBUG << "Publish data for: " << localModule->getParentModule()->getFullName() << endl;
        localModule->setMoBANParameters(currentPosture->getPs(i), currentPosture->getRadius(i), currentPosture->getSpeed(i));
    }
}

bool inet::MoBANCoordinator::readConfigurationFile ( )

protected

Reads the input configuration file.

Function to read the configuration file which includes the information for configuring and tuning the model for a specific application scenario.

The configuration file can provide the Markov model transition matrices, different area types and time domains, and the proper matrix for each time-space combination. However, these are all optional and will be given just in the case that the space-time correlation are required to be simulated. The function will be called in the initialization phase.

Referenced by initialize().

{
    cXMLElement *xmlConfig = par("configFile").xmlValue();
    if (xmlConfig == nullptr)
        return false;

    cXMLElementList tagList;
    cXMLElement *tempTag;
    const char *str;
    std::string sstr;    // for easier comparison

    /* Reading the initial posture if it is given*/
    int postureID;
    tagList = xmlConfig->getElementsByTagName("initialPosture");

    if (tagList.empty())
        postureID = 0; // no initial posture has been specified. The first one is selected!
    else {
        tempTag = tagList.front();
        str = tempTag->getAttribute("postureID");
        postureID = strtol(str, nullptr, 0);
    }
    currentPosture = postureList[postureID];
    EV_DEBUG << "Initial Posture: " << currentPosture->getPostureName() << endl;

    /* Reading the initial position if it is given */
    tagList = xmlConfig->getElementsByTagName("initialLocation");
    if (tagList.empty())
        lastPosition = Coord(10, 10, 5); // no initial location has been specified .
    else {
        double x, y, z;
        tempTag = tagList.front();

        str = tempTag->getAttribute("x");
        x = strtod(str, nullptr);
        str = tempTag->getAttribute("y");
        y = strtod(str, nullptr);
        str = tempTag->getAttribute("z");
        z = strtod(str, nullptr);
        lastPosition = Coord(x, y, z);
    }
    EV_DEBUG << "Initial position of the LC: " << lastPosition << endl;

    /* Reading the given range for duration of stable postures */
    tagList = xmlConfig->getElementsByTagName("durationRange");
    if (tagList.empty()) {
        // no duration is specified. We assign a value!
        minDuration = 0;
        maxDuration = 100;
    }
    else {
        tempTag = tagList.front();

        str = tempTag->getAttribute("min");
        minDuration = strtod(str, nullptr);
        str = tempTag->getAttribute("max");
        maxDuration = strtod(str, nullptr);
    }
    EV_DEBUG << "Posture duration range: (" << minDuration << " , " << maxDuration << ")" << endl;

    transitions = new PostureTransition(numPostures);

    /* Reading the Markov transition matrices, if there are any. */
    tagList = xmlConfig->getElementsByTagName("markovMatrices");

    if (tagList.empty()) {
        postureSelStrategy = UNIFORM_RANDOM;    // no posture selection strategy is required. uniform random is applied
        EV_DEBUG << "Posture Selection strategy: UNIFORM_RANDOM " << endl;
        return true;
    }

    tempTag = tagList.front();

    cXMLElementList matrixList;
    matrixList = tempTag->getElementsByTagName("MarkovMatrix");

    if (tagList.empty()) {
        postureSelStrategy = UNIFORM_RANDOM;    // no posture selection strategy is required. uniform random is applied
        EV_DEBUG << "Posture Selection strategy: UNIFORM_RANDOM " << endl;
        return true;
    }

    postureSelStrategy = MARKOV_BASE;

    // make an empty matrix for the Markov Chain
    double **matrix = new double *[numPostures];
    for (unsigned int i = 0; i < numPostures; ++i)
        matrix[i] = new double[numPostures];

    bool setDefault = false;    // variable to remember if the default matrix is defined.
    cXMLElementList::const_iterator matrixTag;
    for (matrixTag = matrixList.begin(); matrixTag != matrixList.end(); matrixTag++) {
        cXMLElementList rowList;
        cXMLElementList cellList;
        int i = 0, j = 0;
        bool thisDefault = false;

        if ((*matrixTag)->getAttribute("type") != nullptr) {
            sstr = (*matrixTag)->getAttribute("type");
            if (sstr == "Default" || sstr == "default") {
                if (setDefault)
                    throw cRuntimeError("There are more than one default matrix defined in the configuration file!");
                else {
                    setDefault = true;
                    thisDefault = true;
                }
            }
        }

        sstr = (*matrixTag)->getAttribute("name");

        rowList = (*matrixTag)->getElementsByTagName("row");
        if (rowList.size() != numPostures && rowList.size() != 1)
            throw cRuntimeError("Number of rows in  the Markov transition matrix should be equal to either the number"
                                " of postures (full Markov matrix) or one (steady state vector)");

        if (rowList.size() != numPostures && thisDefault)
            throw cRuntimeError("Dimension of the default Markov matrix should be equal to the number of postures in the configuration file");

        if ((rowList.size() == 1) && (!setDefault))
            throw cRuntimeError("A default matrix is supposed to be defined before a steady state can be defined in the configuration file");

        for (cXMLElementList::const_iterator row = rowList.begin(); row != rowList.end(); row++) {
            cellList = (*row)->getElementsByTagName("cell");
            if (cellList.size() != numPostures)
                throw cRuntimeError("Number of columns in  the Markov transition matrix should be equal to the number of postures");

            j = 0;
            for (cXMLElementList::const_iterator cell = cellList.begin(); cell != cellList.end(); cell++) {
                str = (*cell)->getAttribute("value");
                matrix[i][j] = strtod(str, nullptr);
                j++;
            }

            ++i;
        }

        if (rowList.size() == 1)
            transitions->addSteadyState(sstr, matrix[0]); // steady state
        else
            transitions->addMatrix(sstr, matrix, thisDefault); // A full Markovian matrix

        EV_DEBUG << "Markov transition matrix " << sstr << " : " << endl;
        for (int k = 0; k < i; ++k) {
            for (unsigned int f = 0; f < numPostures; ++f)
                EV_DEBUG << matrix[k][f] << " ";
            EV_DEBUG << endl;
        }
    }
    for (unsigned int i = 0; i < numPostures; ++i)
        delete [] matrix[i];
    delete [] matrix;

    /* Reading the Area types, if there are any. */
    tagList = xmlConfig->getElementsByTagName("areaTypes");

    if (tagList.empty())
        EV_DEBUG << "No area type is given. So there is no spatial correlation in posture selection." << endl;
    else {
        tempTag = tagList.front();
        cXMLElementList typeList = tempTag->getElementsByTagName("areaType");

        if (typeList.empty())
            throw cRuntimeError("No areaType has been defined in areaTypes!");

        for (cXMLElementList::const_iterator aType = typeList.begin(); aType != typeList.end(); aType++) {
            sstr = (*aType)->getAttribute("name");

            EV_DEBUG << "Area type " << sstr << " : " << endl;

            int typeID = transitions->addAreaType(sstr);

            cXMLElementList boundList = (*aType)->getElementsByTagName("boundary");
            if (boundList.empty())
                throw cRuntimeError("No boundary is given for a area type!");

            Coord minBound, maxBound;
            for (cXMLElementList::const_iterator aBound = boundList.begin(); aBound != boundList.end(); aBound++) {
                str = (*aBound)->getAttribute("xMin");
                minBound.x = strtod(str, nullptr);
                str = (*aBound)->getAttribute("yMin");
                minBound.y = strtod(str, nullptr);
                str = (*aBound)->getAttribute("zMin");
                minBound.z = strtod(str, nullptr);

                str = (*aBound)->getAttribute("xMax");
                maxBound.x = strtod(str, nullptr);
                str = (*aBound)->getAttribute("yMax");
                maxBound.y = strtod(str, nullptr);
                str = (*aBound)->getAttribute("zMax");
                maxBound.z = strtod(str, nullptr);

                transitions->setAreaBoundry(typeID, minBound, maxBound);
                EV_DEBUG << "Low bound: " << minBound << endl;
                EV_DEBUG << "High bound: " << maxBound << endl;
            }
        }
    }

    /* Reading the time domains, if there are any. */
    tagList = xmlConfig->getElementsByTagName("timeDomains");

    if (tagList.empty())
        EV_DEBUG << "No time domain is given. So there is no temporal correlation in posture selection." << endl;
    else {
        tempTag = tagList.front();
        cXMLElementList typeList = tempTag->getElementsByTagName("timeDomain");

        if (typeList.empty())
            throw cRuntimeError("No timeDomain has been defined in timeDomains!");

        for (cXMLElementList::const_iterator aType = typeList.begin(); aType != typeList.end(); aType++) {
            sstr = (*aType)->getAttribute("name");

            EV_DEBUG << "Time domain " << sstr << " : " << endl;

            int typeID = transitions->addTimeDomain(sstr);

            cXMLElementList boundList = (*aType)->getElementsByTagName("boundary");
            if (boundList.empty())
                throw cRuntimeError("No boundary is given for a time domain!");

            simtime_t minTime, maxTime;
            for (cXMLElementList::const_iterator aBound = boundList.begin(); aBound != boundList.end(); aBound++) {
                str = (*aBound)->getAttribute("tMin");
                minTime = strtod(str, nullptr);
                str = (*aBound)->getAttribute("tMax");
                maxTime = strtod(str, nullptr);

                transitions->setTimeBoundry(typeID, minTime, maxTime);
                EV_DEBUG << "Low bound: (" << minTime.dbl() << ", " << maxTime << ")" << endl;
            }
        }
    }

    /* Reading the combinations, if there are any. */
    tagList = xmlConfig->getElementsByTagName("combinations");

    if (tagList.empty())
        EV_DEBUG << "No combination is given. The default Markov model is then used for the whole time and space!" << endl;
    else {
        tempTag = tagList.front();
        cXMLElementList combList = tempTag->getElementsByTagName("combination");

        if (combList.empty())
            throw cRuntimeError("No combination has been defined in combinations!");

        EV_DEBUG << "Combinations: " << endl;

        for (cXMLElementList::const_iterator aComb = combList.begin(); aComb != combList.end(); aComb++) {
            std::string areaName, timeName, matrixName;

            if ((*aComb)->getAttribute("areaType") != nullptr)
                areaName = (*aComb)->getAttribute("areaType");
            else
                areaName.clear();

            if ((*aComb)->getAttribute("timeDomain") != nullptr)
                timeName = (*aComb)->getAttribute("timeDomain");
            else
                timeName.clear();

            if ((*aComb)->getAttribute("matrix") != nullptr)
                matrixName = (*aComb)->getAttribute("matrix");
            else
                throw cRuntimeError("No transition matrix is specified for a combination");

            transitions->addCombination(areaName, timeName, matrixName);

            EV_DEBUG << "(" << areaName << ", " << timeName << ", " << matrixName << ")" << endl;
        }
    }

    return true;
}

bool inet::MoBANCoordinator::readMobilityPatternFile ( )

protected

Reads the previously logged mobility pattern and make mobility pattern data base.

This function reads the input mobility pattern file and make a list of the mobility patterns.

It will be called in the initialization phase if the useMobilityPattern parameter is true.

Referenced by initialize().

{
    patternLength = 0;
    double x, y, z, s;
    int id;
    char file_name[70];
    char posture_name[50];

    sprintf(file_name, "%s", par("mobilityPatternFile").stringValue());
    FILE *fp = fopen(file_name, "r");
    if (fp == nullptr)
        return false;

    // count number of patterns (lines in the input file)
    int c;
    while ((c = fgetc(fp)) != EOF)
        if (c == '\n')
            patternLength++;

    fclose(fp);

    EV_DEBUG << "Mobility Pattern Length: " << patternLength << endl;

    mobilityPattern = new Pattern[patternLength];

    fp = fopen(file_name, "r");

    int i = 0;
    while (fscanf(fp, "%49s %d", posture_name, &id) != -1) {
        mobilityPattern[i].postureID = id;
        if (postureList[id]->isMobile()) {
            assert(fscanf(fp, "%le %le %le %le", &x, &y, &z, &s) != -1);
            mobilityPattern[i].targetPos = Coord(x, y, z);
            mobilityPattern[i].speed = s;
        }
        else {
            assert(fscanf(fp, "%le", &x) != -1);
            mobilityPattern[i].duration = x;
        }
        ++i;
    }

    fclose(fp);

    currentPattern = -1;

    return true;
}

bool inet::MoBANCoordinator::readPostureSpecificationFile ( )

protected

Reading the input postures specification file and making the posture data base.

Function to read the specified posture specification input file and make the posture data base.

The posture specification includes the specification of a set of possible body postures in the target application. The specification of each posture should provide the speed range of the global movement of the whole WBAN and the relative position of the reference point, movement radius around the reference point and movement velocity of all nodes in the WBAN. The function will be called in the initialization phase.

Referenced by initialize().

{
    cXMLElement *xmlPosture = par("postureSpecFile").xmlValue();
    if (xmlPosture == nullptr)
        return false;

    const char *str;

    // read the specification of every posture from file and make a list of postures
    cXMLElementList postures;

    postures = xmlPosture->getElementsByTagName("posture");

    // find the number of defined postures
    numPostures = postures.size();
    if (numPostures == 0)
        throw cRuntimeError("No posture is defined in the input posture specification file");

    unsigned int postureID;

    cXMLElementList::const_iterator posture;
    for (posture = postures.begin(); posture != postures.end(); posture++) {
        str = (*posture)->getAttribute("postureID");
        postureID = strtol(str, nullptr, 0);
        if (postureID >= numPostures)
            throw cRuntimeError("Posture ID in input posture specification file is out of the range");

        postureList.push_back(new Posture(postureID, localModules.size()));

        str = (*posture)->getAttribute("name");
        postureList[postureID]->setPostureName(const_cast<char *>(str));

        str = (*posture)->getAttribute("minSpeed");
        double minS = strtod(str, nullptr);
        str = (*posture)->getAttribute("maxSpeed");
        double maxS = strtod(str, nullptr);
        postureList[postureID]->setPostureSpeed(minS, maxS);

        int i = 0;
        double x, y, z, s, r;
        cXMLElementList nodeParameters;

        nodeParameters = (*posture)->getElementsByTagName("nodeParameters");
        if (nodeParameters.size() != localModules.size())
            throw cRuntimeError("Some nodes may not have specified parameters in a posture in input posture specification file");

        cXMLElementList::const_iterator param;
        for (param = nodeParameters.begin(); param != nodeParameters.end(); param++) {
            str = (*param)->getAttribute("positionX");
            x = strtod(str, nullptr);

            str = (*param)->getAttribute("positionY");
            y = strtod(str, nullptr);

            str = (*param)->getAttribute("positionZ");
            z = strtod(str, nullptr);

            str = (*param)->getAttribute("radius");
            r = strtod(str, nullptr);

            str = (*param)->getAttribute("speed");
            s = strtod(str, nullptr);

            postureList[postureID]->setPs(i, Coord(x, y, z));
            postureList[postureID]->setRadius(i, r);
            postureList[postureID]->setSpeed(i, s);

            i++;
        }
    }

    /* Report the obtained specification of the postures. */
    for (unsigned int i = 0; i < numPostures; ++i) {
        EV_DEBUG << "Information for the posture: " << i << " is" << endl;
        for (unsigned int j = 0; j < localModules.size(); ++j)
            EV_DEBUG << "Node " << j << " position: " << postureList[i]->getPs(j)
                     << " and radius: " << postureList[i]->getRadius(j) << " and speed: " << postureList[i]->getSpeed(j) << endl;
    }

    return true;
}

void inet::MoBANCoordinator::refreshDisplay ( ) const

overrideprotectedvirtual

{
    //show posture name in the graphical interface
    char dis_str[100];
    sprintf(dis_str, "%s until %f", currentPosture->getPostureName(), nextChange.dbl());
    getDisplayString().setTagArg("t", 0, dis_str);
}

Coord inet::MoBANCoordinator::selectDestination ( )

protected

Function to select the destination in the case of a mobile posture.

Select a position inside the simulation area as the destination for the new mobile posture.

It is called whenever a new mobile posture is selected. It is taken into account that all nodes should be inside the area.

Referenced by initialize(), and setTargetPosition().

{
    Coord res;
    res = getRandomPosition();
    res.z = lastPosition.z;    // the z value remain the same

    // check if it is okay using CoverRadius
    while (!isInsideWorld(res)) {
        res = getRandomPosition();
        res.z = lastPosition.z;
    }

    return res;
}

simtime_t inet::MoBANCoordinator::selectDuration ( )

protected

Select a stay time duration in the specified range for the new posture.

Select a stay time duration in the specified duration range for the new posture.

It is called whenever a new stable posture is selected.

Referenced by setTargetPosition().

{
    return uniform(minDuration, maxDuration);
}

void inet::MoBANCoordinator::selectPosture ( )

protected

Function to select the next posture considering the current posture and the Markov model.

Select a new posture randomly or based on the given Markov model.

If the requested strategy is not uniform random, A Markov chain will be used. If the strategy is INDIVIDUAL_MARKOV, we should retrieve the transition matrix for the current part of the area. If it is INDIVIDUAL_MARKOV, we have the base transition matrix and a steady state vector for the current part of the area. So the closest transition matrix to the base matrix is calculated which satisfies the required steady state vector. In any case, the next posture is selected considering the current posture and according to the final Markov transition matrix.

Referenced by setTargetPosition().

{
    int postureID = 0;

    if (postureSelStrategy == UNIFORM_RANDOM) {
        postureID = floor(uniform(0, numPostures));    // uniformly random posture selection
        currentPosture = postureList[postureID];
        return;
    }

    /* Here we check the area and the time to determine the corresponding posture transition matrix */
    markovMatrix = transitions->getMatrix(simTime(), lastPosition);

    /* Using transition matrix to select the next posture */
    double randomValue = uniform(0, 1);
    double comp = 0;
    int currentP = currentPosture->getPostureID();    // it determines the column in the matrix

    for (int i = 0; i < static_cast<int>(numPostures); ++i) {
        comp += markovMatrix[i][currentP];
        if (randomValue < comp) {
            postureID = i;
            break;
        }
    }

    currentPosture = postureList[postureID];
}

double inet::MoBANCoordinator::selectSpeed ( )

protected

Select a velocity value within the given velocity range.

It is called whenever a new stable posture is selected. In the case of using a logged mobility pattern, the speed value is retrieved from the pattern.

Referenced by setTargetPosition().

{
    return uniform(currentPosture->getMinSpeed(), currentPosture->getMaxSpeed());
}

void inet::MoBANCoordinator::setInitialPosition ( )

overrideprotectedvirtual

Initializes the position from the display string or from module parameters.

Reimplemented from inet::MobilityBase.

{
//    lastPosition = selectDestination();
}

void inet::MoBANCoordinator::setTargetPosition ( )

overrideprotectedvirtual

Set a new target position from the next posture.

The main process of the MoBAN mobility model.

To be called whenever a destination is reached or the duration of the previous posture expires. It select the behavior of the next movement (the posture and the destination), and prepare the required variables to make the movement. In the case of using a logged mobility pattern, the new posture and other parameters are obtained from the pattern.

Implements inet::LineSegmentsMobilityBase.

{
    // select the new posture and set the variable currentPosture as well as the reference points of all nodes within the WBAN.
    if (useMobilityPattern) {
        currentPattern = (currentPattern + 1) % patternLength;
        int postureID = mobilityPattern[currentPattern].postureID;
        currentPosture = postureList[postureID];
    }
    else
        selectPosture();

    EV_DEBUG << "New posture is selected: " << currentPosture->getPostureName() << endl;

    simtime_t duration;
    if (currentPosture->isMobile()) {
        double distance;

        if (useMobilityPattern) {
            targetPosition = mobilityPattern[currentPattern].targetPos;
            speed = mobilityPattern[currentPattern].speed;
        }
        else {
            targetPosition = selectDestination();
            speed = selectSpeed();
        }

        if (speed == 0)
            throw cRuntimeError("The velocity in a mobile posture should not be zero!");

        distance = lastPosition.distance(targetPosition);
        duration = distance / speed;
    }
    else {
        targetPosition = lastPosition;
        if (useMobilityPattern)
            duration = mobilityPattern[currentPattern].duration;
        else
            duration = selectDuration();
    }
    nextChange = simTime() + duration;

    // write the move step into the output log file
    if (currentPosture->isMobile())
        fprintf(logfile, "%s %d %f %f %f %f \n", currentPosture->getPostureName(), currentPosture->getPostureID(), targetPosition.x, targetPosition.y, targetPosition.z, speed);
    else
        fprintf(logfile, "%s %d %f \n", currentPosture->getPostureName(), currentPosture->getPostureID(), duration.dbl());

    publishToNodes();

    EV_DEBUG << "New posture: " << currentPosture->getPostureName() << endl;
    EV_DEBUG << "Destination: " << targetPosition << " Total Time = " << duration << endl;
}

Member Data Documentation

int inet::MoBANCoordinator::currentPattern

protected

The index of the currently applied mobility pattern from.

Referenced by readMobilityPatternFile(), and setTargetPosition().

Posture* inet::MoBANCoordinator::currentPosture

protected

The current selected posture.

Referenced by isInsideWorld(), publishToNodes(), readConfigurationFile(), refreshDisplay(), selectPosture(), selectSpeed(), and setTargetPosition().

std::vector<MoBANLocal *> inet::MoBANCoordinator::localModules

protected

The mobility modules of the nodes in this WBAN.

Referenced by collectLocalModules(), isInsideWorld(), publishToNodes(), and readPostureSpecificationFile().

FILE* inet::MoBANCoordinator::logfile

protected

Pointer to the file for logging MoBAN mobility pattern for future use.

Referenced by finish(), initialize(), and setTargetPosition().

double** inet::MoBANCoordinator::markovMatrix

protected

A matrix which maintains the transition probabilities of the Markov Model of posture pattern.

To be given through configuration file.

Referenced by selectPosture().

simtime_t inet::MoBANCoordinator::maxDuration

protected

The maximum value of the duration for stable postures.

Referenced by readConfigurationFile(), and selectDuration().

double inet::MoBANCoordinator::maxSpeed

protected

The possible maximum speed at any future time.

Referenced by computeMaxSpeed().

simtime_t inet::MoBANCoordinator::minDuration

protected

The minimum value of the duration for stable postures.

Referenced by readConfigurationFile(), and selectDuration().

Pattern* inet::MoBANCoordinator::mobilityPattern

protected

The mobility pattern data base.

Referenced by computeMaxSpeed(), readMobilityPatternFile(), setTargetPosition(), and ~MoBANCoordinator().

unsigned int inet::MoBANCoordinator::numPostures

protected

Number of predefined postures.

Referenced by readConfigurationFile(), readPostureSpecificationFile(), and selectPosture().

int inet::MoBANCoordinator::patternLength

protected

The number of mobility pattern instances which has been read from the input file (length of mobility pattern data base).

Referenced by computeMaxSpeed(), readMobilityPatternFile(), and setTargetPosition().

std::vector<Posture *> inet::MoBANCoordinator::postureList

protected

The list of all predefined postures (posture data base)

Referenced by computeMaxSpeed(), readConfigurationFile(), readMobilityPatternFile(), readPostureSpecificationFile(), selectPosture(), setTargetPosition(), and ~MoBANCoordinator().

posture_sel_type inet::MoBANCoordinator::postureSelStrategy

protected

The requested strategy for posture selection.

To be given through configuration file.

Referenced by readConfigurationFile(), and selectPosture().

double inet::MoBANCoordinator::speed

protected

Currently selected speed for the mobile posture.

Referenced by setTargetPosition().

PostureTransition* inet::MoBANCoordinator::transitions

protected

Class for performing operation for spatial and temporal correlations in posture selection.

Referenced by readConfigurationFile(), selectPosture(), and ~MoBANCoordinator().

bool inet::MoBANCoordinator::useMobilityPattern

protected

Variable that shows if reusing previously logged mobility pattern is requested.

The value is gotten from the parameter of the module

Referenced by computeMaxSpeed(), initialize(), and setTargetPosition().

---

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

• MoBANCoordinator.h
• MoBANCoordinator.cc