BasicMobility.h

/* -*- 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"
#include "HostMove.h"

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

    enum BasicMobilityMsgKinds {
        MOVE_HOST = 1050198237,
  MOVE_TO_BORDER,
  LAST_BASIC
    };

    enum BorderHandling {
  NOWHERE,   
        X_SMALLER, 
  X_BIGGER,  
  Y_SMALLER, 
  Y_BIGGER   
    };

  protected:
    ChannelControl *cc;

    cModule* hostPtr;
    int hostId;
    
    HostMove move;
    int moveCategory;
    
    double updateInterval;

    cMessage* moveMsg;

    bool coreDebug;

  public:
    Module_Class_Members( BasicMobility , BasicModule , 0 );

    void handleMessage(cMessage *msg);

    virtual void initialize(int);

    virtual void finish(){};

  protected:
    virtual void handleSelfMsg( cMessage* );
    
    virtual void handleBorderMsg( cMessage* );
    
    virtual void makeMove(){
  error("BasicMobility does not move the host");
    };

    virtual Coord getRandomPosition();

    void updatePosition();

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

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


    bool handleIfOutside(BorderPolicy, Coord&, Coord&, Coord&, double&);

    virtual void fixIfHostGetsOutside(){
  error("fixIfHostGetsOutside has to be redefined by the user");
    };

    BorderHandling checkIfOutside( Coord, Coord& );

    void goToBorder( BorderPolicy, BorderHandling, Coord&, Coord& );

    void reflectIfOutside(BorderHandling, Coord&, Coord&, Coord&, double&);

    void wrapIfOutside(BorderHandling, Coord&, Coord&);

    void placeRandomlyIfOutside( Coord& );

};

#endif

---