BaseMobility.h

/* -*- mode:c++ -*- ********************************************************
 * file:        BaseMobility.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 BASE_MOBILITY_H
#define BASE_MOBILITY_H

#include "BatteryAccess.h"
#include "BaseWorldUtility.h"
#include "Coord.h"
#include "Move.h"

class BaseMobility : public BatteryAccess
{
  public:
    enum BorderPolicy {
        REFLECT,       
        WRAP,          
        PLACERANDOMLY, 
        RAISEERROR     
    };

    enum BaseMobilityMsgKinds {
        MOVE_HOST = 21311,
        MOVE_TO_BORDER,
    LAST_BASE_MOBILITY_KIND,
    };

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

  protected:

    BaseWorldUtility *world;

    cModule* hostPtr;
    int hostId;

    Move move;

    int moveCategory;

    simtime_t updateInterval;

    cMessage* moveMsg;

    bool coreDebug;

    bool scaleNodeByDepth;

    double playgroundScaleX;
    double playgroundScaleY;

    double origDisplayWidth;
    double origDisplayHeight;

    double origIconSize;
  public:

    BaseMobility();

    void handleMessage(cMessage *msg);

    virtual void initialize(int);

    virtual void finish(){};

  protected:
    virtual int iconSizeTagToSize(const char* tag);

  virtual const char* iconSizeToTag(double size);

    virtual void handleSelfMsg( cMessage* );

    virtual void handleBorderMsg( cMessage* );

    virtual void makeMove(){
      error("BaseMobility does not move the host");
    };

    virtual void updatePosition();

    double playgroundSizeX() const  {return world->getPgs()->getX();}

    double playgroundSizeY() const  {return world->getPgs()->getY();}

    double playgroundSizeZ() const  {return world->getPgs()->getZ();}

  Coord getRandomPosition() { return world->getRandomPosition();}


    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 reflectCoordinate(BorderHandling border, Coord& c);

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

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

    void placeRandomlyIfOutside( Coord& );

};

#endif