senf/PPI/DebugEvent.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 //
   6 // The contents of this file are subject to the Fraunhofer FOKUS Public License
   7 // Version 1.0 (the "License"); you may not use this file except in compliance
   8 // with the License. You may obtain a copy of the License at
   9 // http://senf.berlios.de/license.html
  10 //
  11 // The Fraunhofer FOKUS Public License Version 1.0 is based on,
  12 // but modifies the Mozilla Public License Version 1.1.
  13 // See the full license text for the amendments.
  14 //
  15 // Software distributed under the License is distributed on an "AS IS" basis,
  16 // WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  17 // for the specific language governing rights and limitations under the License.
  18 //
  19 // The Original Code is Fraunhofer FOKUS code.
  20 //
  21 // The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V.
  22 // (registered association), Hansastraße 27 c, 80686 Munich, Germany.
  23 // All Rights Reserved.
  24 //
  25 // Contributor(s):
  26 //   Stefan Bund <g0dil@berlios.de>
  27
  28 /** \file
  29     \brief DebugEvent public header */
  30
  31 #ifndef HH_SENF_PPI_DebugEvent_
  32 #define HH_SENF_PPI_DebugEvent_ 1
  33
  34 // Custom includes
  35 #include "Events.hh"
  36
  37 //#include "DebugEvent.mpp"
  38 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  39
  40 namespace senf {
  41 namespace ppi {
  42
  43     /** \brief Manually triggered event
  44
  45         DebugEvent is a manually triggered event. The event is triggered by explicit calls to
  46         trigger() and not by the event infrastructure.
  47       */
  48     class DebugEvent
  49         : public EventImplementation<>
  50     {
  51     public:
  52         //-////////////////////////////////////////////////////////////////////////
  53         // Types
  54
  55         //-////////////////////////////////////////////////////////////////////////
  56         ///\name Structors and default members
  57         //\{
  58
  59         // default default constructor
  60         // default copy constructor
  61         // default copy assignment
  62         // default destructor
  63         // no conversion constructors
  64
  65         //\}
  66         //-////////////////////////////////////////////////////////////////////////
  67
  68         void trigger();                 ///< Trigger event
  69
  70     protected:
  71
  72     private:
  73         virtual void v_enable();
  74         virtual void v_disable();
  75     };
  76
  77 }}
  78
  79 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  80 #include "DebugEvent.cci"
  81 //#include "DebugEvent.ct"
  82 //#include "DebugEvent.cti"
  83 #endif
  84
  85 \f
  86 // Local Variables:
  87 // mode: c++
  88 // fill-column: 100
  89 // comment-column: 40
  90 // c-file-style: "senf"
  91 // indent-tabs-mode: nil
  92 // ispell-local-dictionary: "american"
  93 // compile-command: "scons -u test"
  94 // End: