LinkStateGraph.h

Go to the documentation of this file.
00001 /*
00002  * IMPORTANT: READ BEFORE DOWNLOADING, COPYING, INSTALLING OR USING. By
00003  * downloading, copying, installing or using the software you agree to
00004  * this license. If you do not agree to this license, do not download,
00005  * install, copy or use the software.
00006  * 
00007  * Intel Open Source License 
00008  * 
00009  * Copyright (c) 2004 Intel Corporation. All rights reserved. 
00010  * 
00011  * Redistribution and use in source and binary forms, with or without
00012  * modification, are permitted provided that the following conditions are
00013  * met:
00014  * 
00015  *   Redistributions of source code must retain the above copyright
00016  *   notice, this list of conditions and the following disclaimer.
00017  * 
00018  *   Redistributions in binary form must reproduce the above copyright
00019  *   notice, this list of conditions and the following disclaimer in the
00020  *   documentation and/or other materials provided with the distribution.
00021  * 
00022  *   Neither the name of the Intel Corporation nor the names of its
00023  *   contributors may be used to endorse or promote products derived from
00024  *   this software without specific prior written permission.
00025  *  
00026  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00027  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00028  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
00029  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE INTEL OR
00030  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00031  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00032  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
00033  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
00034  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00035  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00036  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037  */
00038 #ifndef _LINK_STATE_GRAPH_H_
00039 #define _LINK_STATE_GRAPH_H_
00040 
00041 #include <set>
00042 #include <oasys/debug/Logger.h>
00043 
00044 #include "BundleRouter.h"
00045 #include "LinkScheduleEstimator.h"
00046 
00047 
00048 #define MAX_EID 255
00049 
00050 namespace dtn {
00051 
00085 class LinkStateGraph : public oasys::Logger {
00086 public:
00087     LinkStateGraph();
00088 
00089     class Vertex;
00090     class Edge;
00091 
00092     typedef int cost_t;
00093     typedef std::set<Vertex*> VertexSet;
00094     typedef std::set<Edge*>  EdgeSet;
00095 
00101     VertexSet vertices_;    
00102 
00109     EdgeSet edges_;
00110 
00114     Edge* addEdge(Vertex* from, Vertex* to, cost_t cost);
00115 
00116     /*
00117      *  Returns the edge between from and to, if such an edge exists.
00118      */
00119     Edge* getEdge(Vertex* from, Vertex* to);
00120 
00124     void removeEdge(Edge *to);
00125     
00131     Vertex* getVertex(const char* eid);
00132 
00137     Vertex* getMatchingVertex(const char* eid);
00138 
00143     Vertex* findNextHop(Vertex* from, Vertex *to);
00144 
00146     void dumpGraph(oasys::StringBuffer* buf);
00147 
00148     EdgeSet edges();
00149 
00150     /* A time-varying connection between two vertices in the graph */
00151     class Edge {
00152      public:
00153         Edge(Vertex *from, Vertex *to, cost_t cost);
00154 
00155         Vertex* from_;
00156         Vertex* to_;
00157 
00158         cost_t cost_;
00159 
00160         // log of all the up/down events this edge has seen
00161         LinkScheduleEstimator::Log      log_;
00162         LinkScheduleEstimator::LogEntry contact_;
00163     };
00164 
00165 
00166     /* 
00167        A vertex in the graph is an EID 
00168        XXX/jakob - is it?
00169      */
00170     class Vertex {
00171       public:
00172         Vertex(const char * eid);
00173 
00174         char eid_[MAX_EID];        
00175         int dijkstra_distance_;
00176 
00177         std::map<Vertex*,Edge*> incoming_edges_;
00178         std::map<Vertex*,Edge*> outgoing_edges_;
00179 
00180         int operator<(Vertex* a) {
00181             ASSERT(a);
00182             return strcmp(eid_,a->eid_);
00183         }
00184     };    
00185 };
00186 
00187 } // namespace dtn
00188 
00189 #endif /* _LINK_STATE_GRAPH_H_ */

Generated on Fri Dec 22 14:47:59 2006 for DTN Reference Implementation by  doxygen 1.5.1