Modules/Interfaces/EDI/edi/acess-edi.h

   1 /*! \file acess-edi.h
   2  * \brief Acess Specific EDI Objects
   3  *
   4  * Contains documentation and information for
   5  * - Timers
   6  */
   7
   8 /* Copyright (c)  2006  John Hodge
   9  * Permission is granted to copy, distribute and/or modify this document
  10  * under the terms of the GNU Free Documentation License, Version 1.2
  11  * or any later version published by the Free Software Foundation;
  12  * with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
  13  * Texts.  A copy of the license is included in the file entitled "COPYING". */
  14
  15 #ifndef ACESS_EDI_H
  16 #define ACESS_EDI_H
  17
  18 #include "edi_objects.h"
  19
  20 /// \brief Name of Acess EDI Time Class
  21 #define ACESS_TIMER_CLASS       "ACESSEDI-TIMER"
  22
  23 #ifndef IMPLEMENTING_EDI
  24 /*! \brief int32_t ACESSEDI-TIMER.init_timer(uint32_t Delay, void (*Callback)(int), int Arg);
  25  *
  26  * Takes a timer pointer and intialises the timer object to fire after \a Delay ms
  27  * When the timer fires, \a Callback is called with \a Arg passed to it.
  28  */
  29 EDI_DEFVAR int32_t (*init_timer)(object_pointer port_object, uint32_t Delay, void (*fcn)(int), int arg);
  30
  31 /*! \brief void ACESSEDI-TIMER.disable_timer();
  32  *
  33  * Disables the timer and prevents it from firing
  34  * After this has been called, the timer can then be initialised again.
  35  */
  36 EDI_DEFVAR void (*disable_timer)(object_pointer port_object);
  37
  38
  39 #endif // defined(IMPLEMENTING_EDI)
  40
  41 #endif