CoordBasedRouting.h

Go to the documentation of this file.

//
// Copyright (C) 2006 Institut fuer Telematik, Universitaet Karlsruhe (TH)
//
// 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.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
//

#ifndef __COORDBASEDROUTING_H_
#define __COORDBASEDROUTING_H_

#include <omnetpp.h>

#include <OverlayKey.h>
#include <TransportAddress.h>
#include <CoordinateSystem.h>

class GlobalNodeList;

class CBRArea
{

  public:
    CBRArea(uint8_t dim);
    CBRArea(const Coords& bottoms,
            const Coords& tops,
            const std::string& prefix)
    : min(bottoms), max(tops), prefix(prefix) {};
    ~CBRArea() {};

    Coords min;
    Coords max;
    std::string prefix;

    friend std::ostream& operator<<(std::ostream& os,
                                    const CBRArea& area);
};




typedef std::vector<CBRArea> AP; //< {Global,Current} Area Partitioning
typedef std::vector<Coords> CD; //< {Global,Current} Coordinate Distribution

class CoordBasedRouting : public cSimpleModule
{
  private:
    static const std::string NOPREFIX;

    const char* areaCoordinateSource;
    uint8_t cbrStartAtDigit;
    uint8_t cbrStopAtDigit;
    uint8_t xmlDimensions;

    bool cbrChangeIdLater;
    simtime_t cbrChangeIdStart;
    simtime_t cbrChangeIdStop;


    AP* gap; //< Global Area Partitioning for LM-CBR

    GlobalNodeList* globalNodeList;

    void parseSource(const char* areaCoordinateSource);

    std::string getPrefix(const Coords& coords,
                          const AP* cap = NULL) const;

    bool checkDimensions(uint8_t dims) const;

    void splitNodes(CD& nodes,
                    const std::string& prefix,
                    const Coords& bottoms,
                    const Coords& tops,
                    uint8_t depth,
                    AP* cap);

    uint8_t ccdDim;
    uint16_t maxPrefix;

  protected:
    virtual void initialize();
    void finish();

  public:
    CoordBasedRouting() { gap = NULL; };
    ~CoordBasedRouting() { delete gap; };

    OverlayKey getNodeId(const Coords& coords,
                         uint8_t bpd, uint8_t length,
                         const AP* cap = NULL) const;

    uint8_t getXmlDimensions() const { return xmlDimensions; }

    double getEuclidianDistanceByKeyAndCoords(const OverlayKey& destKey,
                                              const std::vector<double>& nodeCoords,
                                              uint8_t bpd,
                                              const AP* cap = NULL) const;

    const AP* calculateCapFromCcd(const CD& ccd, uint8_t bpd);

    bool changeIdLater() const { return cbrChangeIdLater; };
    simtime_t getChangeIdStart() const { return cbrChangeIdStart; };
    simtime_t getChangeIdStop() const { return cbrChangeIdStop; };
};


class leqDim
{
private:
    uint8_t dim;

public:
    leqDim(uint8_t dim) { this->dim = dim; };
    int operator() (const Coords& left,
                    const Coords& right) { return left[dim] < right[dim]; };
};

#endif