include/anna/timex/Timer.hpp

   1 // ANNA - Anna is Not 'N' Anymore
   2 //
   3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
   4 //
   5 // https://bitbucket.org/testillano/anna
   6 //
   7 // Redistribution and use in source and binary forms, with or without
   8 // modification, are permitted provided that the following conditions
   9 // are met:
  10 //
  11 //     * Redistributions of source code must retain the above copyright
  12 // notice, this list of conditions and the following disclaimer.
  13 //     * Redistributions in binary form must reproduce the above
  14 // copyright notice, this list of conditions and the following disclaimer
  15 // in the documentation and/or other materials provided with the
  16 // distribution.
  17 //     * Neither the name of Google Inc. nor the names of its
  18 // contributors may be used to endorse or promote products derived from
  19 // this software without specific prior written permission.
  20 //
  21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32 //
  33 // Authors: eduardo.ramos.testillano@gmail.com
  34 //          cisco.tierra@gmail.com
  35
  36
  37 #ifndef anna_timex_Timer_hpp
  38 #define anna_timex_Timer_hpp
  39
  40 #include <anna/timex/TimeEvent.hpp>
  41
  42 namespace anna {
  43
  44 namespace timex {
  45
  46 /**
  47    Clase base para los temporizadores. Se activa una unica vez y cuando transcurren los milisegundos
  48    establecidos por TimeEvent::getTimeout se invoca al metodo #expire. La implementacion de este metodo
  49    sera particular para cada uno de los temporizadores.
  50
  51    @see Clock
  52 */
  53 class Timer : public TimeEvent {
  54 public:
  55   /**
  56      Constructor
  57
  58      @param name Nombre logico de este temporizador.
  59      @param timeout Duracion del temporizador indicado en milisegundos.
  60   */
  61   Timer(const char* name, const Millisecond & timeout) :
  62     TimeEvent(anna_ptrnumber_cast(this), timeout),
  63     a_name(name) {
  64   }
  65
  66   /**
  67      Devuelve una cadena con la informacion referente a este temporizador.
  68      \return Una cadena con la informacion referenta a este temporizador.
  69   */
  70   std::string asString() const
  71   throw() {
  72     std::string msg("Timer { ");
  73     msg += TimeEvent::asString();
  74     msg += " | Name: ";
  75     msg += a_name;
  76     return msg += " }";
  77   }
  78
  79 private:
  80   std::string a_name;
  81 };
  82
  83 }
  84 }
  85
  86 #endif
  87
  88