Changeset 913 in Sophya for trunk/SophyaLib/SysTools/periodic.cc

Timestamp:

Apr 13, 2000, 5:58:41 PM (25 years ago)

Author:

ansari

Message:

Documentation + Modifs mineures (namespace, etc..) - Reza 13/4/2000

File:

• trunk/SophyaLib/SysTools/periodic.cc (modified) (7 diffs)

trunk/SophyaLib/SysTools/periodic.cc

@@ -9 +9 @@
 
 #include "periodic.h"
+/*!
+  \class SOPHYA::Periodic
+  \ingroup SysTools
+  This class provide the service of calling a given function at 
+  regular intervals. It can also be subclassed with the method 
+  \b DoPeriodic redefined to perform a periodic action.
+*/
 
 /* --Methode-- */
+/*! Constructor with the definition of the interval (in seconds)
+  and an optional user action */
 Periodic::Periodic(int dt, UsPeriodicAction act, void * usp)
 {
@@ -29 +38 @@
 
 /* --Methode-- */
+/*! Sets the user action function and its data \c usp */
 void Periodic::SetAction(UsPeriodicAction act, void * usp)
 {
@@ -36 +46 @@
 
 /* --Methode-- */
+/*! Changes the interval \c dt specified in seconds */
 void Periodic::SetInterval(int dt)
 {
@@ -44 +55 @@
 
 /* --Methode-- */
+/*! Changes the interval \c dtms specified in milli-seconds */
 void Periodic::SetIntervalms(int dtms)
 {
@@ -53 +65 @@
 
 /* --Methode-- */
+/*! Activate the object */
 void Periodic::Start(int dt)
 {
@@ -69 +82 @@
 
 /* --Methode-- */
+/*! Deactivate the object */
 void Periodic::Stop()
 {
@@ -86 +100 @@
 
 /* --Methode-- */
+/*! This method should be redefined for sub-classes of Periodic 
+  The default implementation calls the user action function */
 void Periodic::DoPeriodic()
 {