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
  27 class AbstractSink;
  28 class AbstractSource;
  29
  30 typedef std::function<void (void)> CompletedSignal;
  31
  32 class AsyncPropertyRequest
  33 {
  34 public:
  35         VehicleProperty::Property property;
  36         CompletedSignal completed;
  37 };
  38
  39 class AsyncPropertyReply: public AsyncPropertyRequest
  40 {
  41 public:
  42         AsyncPropertyReply(AsyncPropertyRequest request)
  43         {
  44                 this->property = request.property;
  45                 this->completed = request.completed;
  46         }
  47
  48         boost::any value;
  49 };
  50
  51 class AbstractRoutingEngine
  52 {
  53 public:
  54         virtual void setSupported(PropertyList supported, AbstractSource* source) = 0;
  55         virtual void updateSupported(PropertyList added, PropertyList removed) = 0;
  56         virtual void updateProperty(VehicleProperty::Property property, boost::any value) = 0;
  57
  58         /// sinks:
  59
  60         virtual boost::any getProperty(VehicleProperty::Property) = 0;
  61         virtual AsyncPropertyReply *getPropertyAsync(AsyncPropertyRequest request) = 0;
  62         virtual void setProperty(VehicleProperty::Property, boost::any) = 0;
  63         virtual void subscribeToProperty(VehicleProperty::Property, AbstractSink* self) = 0;
  64         virtual void unsubscribeToProperty(VehicleProperty::Property, AbstractSink* self) = 0;
  65 };
  66
  67 #endif // ABSTRACTROUTINGENGINE_H