Changes between Version 1 and Version 2 of Docs/Prog/Manual/ApplicationLibraries/lib825ev/Time/CTimer

Timestamp:

08/26/10 15:59:01 (14 years ago)

Author:

Don Wilson

Comment:

--

Docs/Prog/Manual/ApplicationLibraries/lib825ev/Time/CTimer

@@ +1 @@
+[[TOC]]
 = CTimer =
 
 CTimer is a C++ class for timer functions.
+
+== Constructor ==
+
+{{{
+CTimer(int nValue, bool bMilliseconds = false);
+}}}
+
+==== Parameters ====
+ * nValue - Time value, if bMilliseconds is false value is seconds, otherwise value is milliseconds
+ * bMilliseconds - True to interpret nValue as milliseconds, false nValue is interpreted as seconds.
+
+==== Example ====
+
+{{{
+CTimer tmr(10);
+
+tmr.Start(); // Start 10 second count
+
+while(1)
+{
+    // ... We can do some processing here
+    if(tmr.GetExpired())
+    {
+        // 10 seconds is up
+        break;
+    }
+}
+}}}
+
+== Member Functions ==
+
+=== Set ===
+
+{{{
+void Set(int nValue, bool bMilliseconds = false);
+}}}
+
+==== Parameters ====
+ * nValue - Time value, if bMilliseconds is false value is seconds, otherwise value is milliseconds
+ * bMilliseconds - True to interpret nValue as milliseconds, false nValue is interpreted as seconds.
+
+==== Return Value ====
+
+Function does not return a value.
+
+==== Remarks ====
+
+==== Example ====
+
+{{{
+
+}}}
+