BasicMobility.h

Go to the documentation of this file.

/* -*- mode:c++ -*- ********************************************************
 * file:        BasicMobility.h
 *
 * author:      Daniel Willkomm, Andras Varga
 *
 * copyright:   (C) 2004 Telecommunication Networks Group (TKN) at
 *              Technische Universitaet Berlin, Germany.
 *
 *              (C) 2005 Andras Varga
 *
 *              This program is free software; you can redistribute it
 *              and/or modify it under the terms of the GNU General Public
 *              License as published by the Free Software Foundation; either
 *              version 2 of the License, or (at your option) any later
 *              version.
 *              For further information see file COPYING
 *              in the top level directory
 ***************************************************************************
 * part of:     framework implementation developed by tkn
 **************************************************************************/


#ifndef BASIC_MOBILITY_H
#define BASIC_MOBILITY_H

#include <omnetpp.h>

#include "BasicModule.h"
#include "ChannelControl.h"
#include "Coord.h"


class INET_API BasicMobility : public BasicModule
{
  public:
    enum BorderPolicy {
        REFLECT,       
        WRAP,          
        PLACERANDOMLY, 
        RAISEERROR     
    };

  protected:
    ChannelControl *cc;

    ChannelControl::HostRef myHostRef;

    cModule* hostPtr;

    Coord pos;

  protected:
    virtual void handleMessage(cMessage *msg);

    virtual void initialize(int);

    virtual void finish() {}

  protected:
    virtual void handleSelfMsg(cMessage *msg) = 0;

    virtual void updatePosition();

    virtual double getPlaygroundSizeX() const  {return cc->getPgs()->x;}

    virtual double getPlaygroundSizeY() const  {return cc->getPgs()->y;}

    virtual Coord getRandomPosition();

    virtual void reflectIfOutside(Coord& targetPos, Coord& step, double& angle);

    virtual void wrapIfOutside(Coord& targetPos);

    virtual void placeRandomlyIfOutside(Coord& targetPos);

    virtual void raiseErrorIfOutside();

    virtual void handleIfOutside(BorderPolicy policy, Coord& targetPos, Coord& step, double& angle);

};

#endif