Changeset 2143 in Sophya for trunk/SophyaLib/SysTools

Timestamp:

Jul 29, 2002, 2:22:12 PM (23 years ago)

Author:

ansari

Message:

MAJ periodic.cc pour autodoc (doc PI) - Reza 29/7/2002

File:

• trunk/SophyaLib/SysTools/periodic.cc (modified) (1 diff)

trunk/SophyaLib/SysTools/periodic.cc

@@ -16 +16 @@
   \b DoPeriodic redefined to perform a periodic action.
 */
+
+//++
+// Class        Periodic
+// Lib          SysTools
+// include      periodic.h
+//
+//      Classe d'objets avec une méthode "DoPeriodic()" appelée périodiquement
+//      à intervalle régulier.
+//--
+
+//++
+// Titre        Constructeur, méthodes
+//--
+//++
+//  Periodic(int dt, UsPeriodicAction act=NULL, void * usp=NULL)
+//      Constructeur avec un intervalle de temps en secondes "dt".
+//      Il est possible de spécifier une fonction "UsPeriodicAction" avec
+//      un argument "usp" qui sera appelée régulierement.
+//|     typedef void (* UsPeriodicAction) (void *);
+//--
+
+//++
+//  void  Start(int dt=-1)
+//      Activation de l'objet périodique. 
+//      On peut spécifier l'intervalle en temps (en secondes) si "dt > 0".
+//  void  Stop()
+//      Désactivation de l'objet périodique.
+//  void  DoPeriodic()
+//      Méthode virtuelle qui peut être surchargée dans les classes dérivées.
+//      Elle est appelée lorsque l'intervalle de temps est écoulé. Par défaut,
+//      elle appelle la fonction "UsPeriodicAction" associée si "!= NULL"
+//--
+
 
 /* --Methode-- */