senf/PPI/DebugEvent.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Stefan Bund <g0dil@berlios.de>
   7 //
   8 // This program is free software; you can redistribute it and/or modify
   9 // it under the terms of the GNU General Public License as published by
  10 // the Free Software Foundation; either version 2 of the License, or
  11 // (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the
  20 // Free Software Foundation, Inc.,
  21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23 /** \file
  24     \brief DebugEvent public header */
  25
  26 #ifndef HH_SENF_PPI_DebugEvent_
  27 #define HH_SENF_PPI_DebugEvent_ 1
  28
  29 // Custom includes
  30 #include "Events.hh"
  31
  32 //#include "DebugEvent.mpp"
  33 ///////////////////////////////hh.p////////////////////////////////////////
  34
  35 namespace senf {
  36 namespace ppi {
  37
  38     /** \brief Manually triggered event
  39
  40         DebugEvent is a manually triggered event. The event is triggered by explicit calls to
  41         trigger() and not by the event infrastructure.
  42       */
  43     class DebugEvent
  44         : public EventImplementation<>
  45     {
  46     public:
  47         ///////////////////////////////////////////////////////////////////////////
  48         // Types
  49
  50         ///////////////////////////////////////////////////////////////////////////
  51         ///\name Structors and default members
  52         ///@{
  53
  54         // default default constructor
  55         // default copy constructor
  56         // default copy assignment
  57         // default destructor
  58         // no conversion constructors
  59
  60         ///@}
  61         ///////////////////////////////////////////////////////////////////////////
  62
  63         void trigger();                 ///< Trigger event
  64
  65     protected:
  66
  67     private:
  68         virtual void v_enable();
  69         virtual void v_disable();
  70     };
  71
  72 }}
  73
  74 ///////////////////////////////hh.e////////////////////////////////////////
  75 #include "DebugEvent.cci"
  76 //#include "DebugEvent.ct"
  77 //#include "DebugEvent.cti"
  78 #endif
  79
  80 \f
  81 // Local Variables:
  82 // mode: c++
  83 // fill-column: 100
  84 // comment-column: 40
  85 // c-file-style: "senf"
  86 // indent-tabs-mode: nil
  87 // ispell-local-dictionary: "american"
  88 // compile-command: "scons -u test"
  89 // End: