lib/abstractroutingengine.h

   1 /*
   2     Copyright (C) 2012  Intel Corporation
   3
   4     This library is free software; you can redistribute it and/or
   5     modify it under the terms of the GNU Lesser General Public
   6     License as published by the Free Software Foundation; either
   7     version 2.1 of the License, or (at your option) any later version.
   8
   9     This library is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12     Lesser General Public License for more details.
  13
  14     You should have received a copy of the GNU Lesser General Public
  15     License along with this library; if not, write to the Free Software
  16     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  17 */
  18
  19
  20 #ifndef ABSTRACTROUTINGENGINE_H
  21 #define ABSTRACTROUTINGENGINE_H
  22
  23 #include <boost/any.hpp>
  24 #include <functional>
  25 #include "vehicleproperty.h"
  26 #include "abstractpropertytype.h"
  27
  28 class AbstractSink;
  29 class AbstractSource;
  30 class AsyncPropertyReply;
  31
  32
  33 typedef std::function<void (AsyncPropertyReply*)> CompletedSignal;
  34
  35 class AsyncPropertyRequest
  36 {
  37 public:
  38         VehicleProperty::Property property;
  39         CompletedSignal completed;
  40 };
  41
  42 class AsyncPropertyReply: public AsyncPropertyRequest
  43 {
  44 public:
  45         AsyncPropertyReply(AsyncPropertyRequest request)
  46         {
  47                 this->property = request.property;
  48                 this->completed = request.completed;
  49         }
  50
  51         AbstractPropertyType value;
  52 };
  53
  54 class AbstractRoutingEngine
  55 {
  56 public:
  57         virtual void setSupported(PropertyList supported, AbstractSource* source) = 0;
  58         virtual void updateSupported(PropertyList added, PropertyList removed) = 0;
  59         virtual void updateProperty(VehicleProperty::Property property, AbstractPropertyType value) = 0;
  60
  61         /// sinks:
  62         virtual void registerSink(AbstractSink* self) = 0;
  63         virtual void  unregisterSink(AbstractSink* self) = 0;
  64         virtual AsyncPropertyReply *getPropertyAsync(AsyncPropertyRequest request) = 0;
  65         virtual void setProperty(VehicleProperty::Property, AbstractPropertyType) = 0;
  66         virtual void subscribeToProperty(VehicleProperty::Property, AbstractSink* self) = 0;
  67         virtual void unsubscribeToProperty(VehicleProperty::Property, AbstractSink* self) = 0;
  68         virtual PropertyList supported() = 0;
  69 };
  70
  71 #endif // ABSTRACTROUTINGENGINE_H