lib/abstractsink.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 ABSTRACTSINK_H
  21 #define ABSTRACTSINK_H
  22
  23 #include <string>
  24 #include <list>
  25 #include <vector>
  26 #include <map>
  27 #include <functional>
  28 #include <boost/any.hpp>
  29
  30 #include "vehicleproperty.h"
  31 #include "abstractpropertytype.h"
  32
  33 using namespace std;
  34
  35 class AbstractRoutingEngine;
  36 class AbstractSink;
  37
  38 typedef vector<AbstractSink*> SinkList;
  39
  40 class AbstractSink
  41 {
  42
  43 public:
  44         AbstractSink(AbstractRoutingEngine* engine, map<string, string> config);
  45         virtual ~AbstractSink();
  46
  47         ///Pure virtual methods:
  48
  49         /*! uuid() is a unique identifier
  50           * @return a guid-style unique identifier
  51           */
  52         virtual const string uuid() = 0;
  53
  54         /*! \brief propertyChanged is called when a subscribed to property changes.
  55           * \see AbstractRoutingEngine::subscribeToPropertyChanges()
  56           * \param value value of the property that changed. this is a temporary pointer that will be destroyed.
  57           * Do not destroy it.  If you need to store the value use value.anyValue(), value.value<T>() or
  58           * value->copy() to copy.
  59           */
  60         virtual void propertyChanged(AbstractPropertyType *value){ (void)value; }
  61
  62         /*! supportedChanged() is called when the supported properties changes
  63          * @arg supportedProperties the new list of supported properties.
  64          */
  65         virtual void supportedChanged(const PropertyList & supportedProperties) = 0;
  66
  67 protected:
  68         /*!
  69          * \brief routingEngine is the core of AMB.  It is used to pass plugin and property information to other plugins
  70          */
  71         AbstractRoutingEngine* routingEngine;
  72         map<string, string> configuration;
  73 };
  74
  75 #endif // ABSTRACTSINK_H