00001 /*!@file Beobot/Edge.H basic edge in a graph class */ 00002 00003 // //////////////////////////////////////////////////////////////////// // 00004 // The iLab Neuromorphic Vision C++ Toolkit - Copyright (C) 2001 by the // 00005 // University of Southern California (USC) and the iLab at USC. // 00006 // See http://iLab.usc.edu for information about this project. // 00007 // //////////////////////////////////////////////////////////////////// // 00008 // Major portions of the iLab Neuromorphic Vision Toolkit are protected // 00009 // under the U.S. patent ``Computation of Intrinsic Perceptual Saliency // 00010 // in Visual Environments, and Applications'' by Christof Koch and // 00011 // Laurent Itti, California Institute of Technology, 2001 (patent // 00012 // pending; application number 09/912,225 filed July 23, 2001; see // 00013 // http://pair.uspto.gov/cgi-bin/final/home.pl for current status). // 00014 // //////////////////////////////////////////////////////////////////// // 00015 // This file is part of the iLab Neuromorphic Vision C++ Toolkit. // 00016 // // 00017 // The iLab Neuromorphic Vision C++ Toolkit is free software; you can // 00018 // redistribute it and/or modify it under the terms of the GNU General // 00019 // Public License as published by the Free Software Foundation; either // 00020 // version 2 of the License, or (at your option) any later version. // 00021 // // 00022 // The iLab Neuromorphic Vision C++ Toolkit is distributed in the hope // 00023 // that it will be useful, but WITHOUT ANY WARRANTY; without even the // 00024 // implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR // 00025 // PURPOSE. See the GNU General Public License for more details. // 00026 // // 00027 // You should have received a copy of the GNU General Public License // 00028 // along with the iLab Neuromorphic Vision C++ Toolkit; if not, write // 00029 // to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, // 00030 // Boston, MA 02111-1307 USA. // 00031 // //////////////////////////////////////////////////////////////////// // 00032 // 00033 // Primary maintainer for this file: Christian Siagian <siagian@usc.edu> 00034 // $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/Beobot/Edge.H $ 00035 // $Id $ 00036 // 00037 00038 #ifndef BEOBOT_EDGE_H_DEFINED 00039 #define BEOBOT_EDGE_H_DEFINED 00040 00041 #include "Beobot/Node.H" 00042 #include "rutz/shared_ptr.h" 00043 #include <string> 00044 #include <vector> 00045 00046 class Node; 00047 class Edge; 00048 00049 //! basic edge in a graph class 00050 //! the label is for display only, not necessary 00051 //! note its directionality is decided by the graph 00052 //! despite the label source and destination node 00053 class Edge 00054 { 00055 public: 00056 // ###################################################################### 00057 //! @name Constructor, assigment and destructor 00058 //@{ 00059 00060 //! Constructor: generate a blank edge (no end-nodes) 00061 Edge(float cost = 1.0F, 00062 const std::string label = std::string("")); 00063 00064 //! Constructor: generate a directed edge with two nodes 00065 Edge(rutz::shared_ptr<Node> sourceNode, rutz::shared_ptr<Node> destNode, 00066 float cost = 1.0F, 00067 const std::string label = std::string("")); 00068 00069 //! Destructor 00070 ~Edge(); 00071 00072 //! cost of traversing the edge 00073 //! default: 1.0 00074 inline float getCost(); 00075 00076 //! set the cost of the edge 00077 inline void setCost(float cost); 00078 00079 //! get the source node 00080 inline rutz::shared_ptr<Node> getSourceNode(); 00081 00082 //! get the destination node 00083 inline rutz::shared_ptr<Node> getDestNode(); 00084 00085 //! set the source node 00086 inline void setSourceNode(rutz::shared_ptr<Node> sourceNode); 00087 00088 //! set the destination node 00089 inline void setDestNode(rutz::shared_ptr<Node> destNode); 00090 00091 //! get the label of the edge 00092 inline std::string getLabel(); 00093 00094 //@} 00095 00096 private: 00097 00098 rutz::shared_ptr<Node> itsSourceNode; 00099 rutz::shared_ptr<Node> itsDestNode; 00100 float itsCost; 00101 std::string itsLabel; 00102 }; 00103 00104 // ###################################################################### 00105 // Implementation for Node inline functions 00106 // ###################################################################### 00107 inline float Edge::getCost() 00108 { 00109 return itsCost; 00110 } 00111 00112 inline void Edge::setCost(float cost) 00113 { 00114 itsCost = cost; 00115 } 00116 00117 inline rutz::shared_ptr<Node> Edge::getSourceNode() 00118 { 00119 return itsSourceNode; 00120 } 00121 00122 inline rutz::shared_ptr<Node> Edge::getDestNode() 00123 { 00124 return itsDestNode; 00125 } 00126 00127 inline void Edge::setSourceNode(rutz::shared_ptr<Node> sourceNode) 00128 { 00129 itsSourceNode = sourceNode; 00130 } 00131 00132 inline void Edge::setDestNode(rutz::shared_ptr<Node> destNode) 00133 { 00134 itsDestNode = destNode; 00135 } 00136 00137 inline std::string Edge::getLabel() 00138 { 00139 return itsLabel; 00140 } 00141 00142 #endif 00143 00144 // ###################################################################### 00145 /* So things look consistent in everyone's emacs... */ 00146 /* Local Variables: */ 00147 /* indent-tabs-mode: nil */ 00148 /* End: */