Stopwatch UDF - Based on the concept in .NET.

guinness · May 13, 2014

This is for my C# fans out there who enjoy OOP. I have created a really rough draft (I mean it's super basic) of the Stopwatch Class in .NET, because I had the idea whilst travelling home and just thought it's neat to show a different paradigm to that of procedural programming.

Enjoy.

#include <WinAPISys.au3>

Global Const $STOPWATCH_GUID = '804835D8-0DF4-11E4-A11F-29560707A45E', $STOPWATCH_TICKSPERMILLISECOND = 10000, $STOPWATCH_TICKSPERSECOND = $STOPWATCH_TICKSPERMILLISECOND * 1000
Global Enum $STOPWATCH_TIMER, $STOPWATCH_RUNNING, $STOPWATCH_ELAPSED, $STOPWATCH_ISHIGHRESOLUTION, $STOPWATCH_FREQUENCY, $STOPWATCH_TICKFREQUENCY, $STOPWATCH_ID, $STOPWATCH_MAX

#Region Example
Example()

Func Example()
    Local $hStopWatch = Stopwatch()
    ConsoleWrite('IsRunning: ' & Stopwatch_IsRunning($hStopWatch) & @CRLF) ; Display running status.

    ConsoleWrite('Started' & @CRLF)
    Stopwatch_Start($hStopWatch) ; Start the stopwatch.
    ConsoleWrite('IsRunning: ' & Stopwatch_IsRunning($hStopWatch) & @CRLF) ; Display running status.
    Sleep(1000) ; Wait for 1 second.
    Stopwatch_Stop($hStopWatch) ; Stop the stopwatch.
    ConsoleWrite('Elapsed ms Time: ' & Stopwatch_ElapsedMilliseconds($hStopWatch) & @CRLF)
    ConsoleWrite('Stopped.' & @CRLF)

    ConsoleWrite('Waiting for 3 seconds whilst the stopwatch is stopped.' & @CRLF)
    Sleep(3000) ; Wait for 3 seconds.

    ConsoleWrite('Started' & @CRLF)
    Stopwatch_Start($hStopWatch) ; Start the stopwatch again.

    ConsoleWrite('Waiting for 2 seconds whilst the stopwatch is running' & @CRLF)
    Sleep(2000) ; Wait for 2 seconds.

    For $i = 1 To 10 ; The number of milliseconds is shown even when the stopwatch is running.
        ConsoleWrite('Elapsed ms Time: ' & Stopwatch_ElapsedMilliseconds($hStopWatch) & @CRLF)
        Sleep(250)
    Next

    Stopwatch_Stop($hStopWatch) ; Stop the stopwatch.
    ConsoleWrite('Elapsed ms Time: ' & Stopwatch_ElapsedMilliseconds($hStopWatch) & @CRLF) ; This should be about 5 seconds or so.
    ConsoleWrite('Stopped' & @CRLF)

    ConsoleWrite('IsRunning: ' & Stopwatch_IsRunning($hStopWatch) & @CRLF) ; Display running status.
EndFunc   ;==>Example
#EndRegion Example

; Stopwatch Class: http://msdn.microsoft.com/en-us/library/system.diagnostics.stopwatch(v=vs.110).aspx
Func Stopwatch()
    Local $aStopwatch[$STOPWATCH_MAX]
    $aStopwatch[$STOPWATCH_ID] = $STOPWATCH_GUID
    Stopwatch_Reset($aStopwatch)
    $aStopwatch[$STOPWATCH_FREQUENCY] = _WinAPI_QueryPerformanceFrequency()
    If $aStopwatch[$STOPWATCH_FREQUENCY] > 0 Then
        $aStopwatch[$STOPWATCH_ISHIGHRESOLUTION] = True
        $aStopwatch[$STOPWATCH_TICKFREQUENCY] = $STOPWATCH_TICKSPERSECOND
        $aStopwatch[$STOPWATCH_TICKFREQUENCY] /= $aStopwatch[$STOPWATCH_FREQUENCY]
    Else
        $aStopwatch[$STOPWATCH_ISHIGHRESOLUTION] = False
        $aStopwatch[$STOPWATCH_FREQUENCY] = $STOPWATCH_TICKSPERSECOND
        $aStopwatch[$STOPWATCH_TICKFREQUENCY] = 1
    EndIf
    Return $aStopwatch
EndFunc   ;==>Stopwatch

Func Stopwatch_ElapsedMilliseconds(ByRef $aStopwatch)
    Return (__Stopwatch_IsStopwatch($aStopwatch) ? __Stopwatch_GetElapsedDateTimeTicks($aStopwatch) / $STOPWATCH_TICKSPERMILLISECOND : 0)
EndFunc   ;==>Stopwatch_ElapsedMilliseconds

Func Stopwatch_ElapsedTicks(ByRef $aStopwatch)
    Return (__Stopwatch_IsStopwatch($aStopwatch) ? __Stopwatch_GetElapsedDateTimeTicks($aStopwatch) : 0)
EndFunc   ;==>Stopwatch_ElapsedTicks

Func Stopwatch_IsRunning(ByRef $aStopwatch)
    Return (__Stopwatch_IsStopwatch($aStopwatch) ? $aStopwatch[$STOPWATCH_RUNNING] : Null)
EndFunc   ;==>Stopwatch_IsRunning

Func Stopwatch_Reset(ByRef $aStopwatch)
    If __Stopwatch_IsStopwatch($aStopwatch) Then
        $aStopwatch[$STOPWATCH_ELAPSED] = 0
        $aStopwatch[$STOPWATCH_RUNNING] = False
        $aStopwatch[$STOPWATCH_TIMER] = 0
    EndIf
    Return True
EndFunc   ;==>Stopwatch_Reset

Func Stopwatch_Restart(ByRef $aStopwatch)
    If __Stopwatch_IsStopwatch($aStopwatch) Then
        Stopwatch_Reset($aStopwatch)
        Stopwatch_Start($aStopwatch)
    EndIf
    Return True
EndFunc   ;==>Stopwatch_Restart

Func Stopwatch_Start(ByRef $aStopwatch)
    If __Stopwatch_IsStopwatch($aStopwatch) And Not $aStopwatch[$STOPWATCH_RUNNING] Then
        $aStopwatch[$STOPWATCH_RUNNING] = True
        $aStopwatch[$STOPWATCH_TIMER] = __Stopwatch_GetTimestamp($aStopwatch)
    EndIf
    Return True
EndFunc   ;==>Stopwatch_Start

Func Stopwatch_StartNew()
    Local $aStopwatch = Stopwatch()
    Stopwatch_Start($aStopwatch)
    Return $aStopwatch
EndFunc   ;==>Stopwatch_StartNew

Func Stopwatch_Stop(ByRef $aStopwatch)
    If __Stopwatch_IsStopwatch($aStopwatch) And $aStopwatch[$STOPWATCH_RUNNING] Then
        $aStopwatch[$STOPWATCH_ELAPSED] = __Stopwatch_GetRawElapsedTicks($aStopwatch)
        $aStopwatch[$STOPWATCH_RUNNING] = False
    EndIf
    Return True
EndFunc   ;==>Stopwatch_Stop

Func __Stopwatch_GetElapsedDateTimeTicks(ByRef $aStopwatch)
    Return (__Stopwatch_GetRawElapsedTicks($aStopwatch) * ($aStopwatch[$STOPWATCH_ISHIGHRESOLUTION] ? $aStopwatch[$STOPWATCH_TICKFREQUENCY] : $STOPWATCH_TICKSPERMILLISECOND))
EndFunc   ;==>__Stopwatch_GetElapsedDateTimeTicks

Func __Stopwatch_GetRawElapsedTicks(ByRef $aStopwatch)
    Local $iElapsedTime = $aStopwatch[$STOPWATCH_ELAPSED]
    If $aStopwatch[$STOPWATCH_RUNNING] Then
        If $aStopwatch[$STOPWATCH_ISHIGHRESOLUTION] Then
            Local $iTimeStamp = __Stopwatch_GetTimestamp($aStopwatch)
            $iTimeStamp = $iTimeStamp - $aStopwatch[$STOPWATCH_TIMER]
            $iElapsedTime += $iTimeStamp
        Else
            $iElapsedTime += TimerDiff($aStopwatch[$STOPWATCH_TIMER])
        EndIf
    EndIf
    Return $iElapsedTime
EndFunc   ;==>__Stopwatch_GetRawElapsedTicks

Func __Stopwatch_GetTimestamp(ByRef $aStopwatch)
    Return ($aStopwatch[$STOPWATCH_ISHIGHRESOLUTION] ? _WinAPI_QueryPerformanceCounter() : TimerInit())
EndFunc   ;==>__Stopwatch_GetTimestamp

Func __Stopwatch_IsStopwatch(ByRef $aStopwatch) ; Internal function only.
    Return (UBound($aStopwatch) = $STOPWATCH_MAX And $aStopwatch[$STOPWATCH_ID] = $STOPWATCH_GUID)
EndFunc   ;==>__Stopwatch_IsStopwatch

Edited July 17, 2014 by guinness

guinness · May 13, 2014

Added: Stopwatch_StartNew()

Added: Checking Stopwatch_ElapsedMilliseconds() when running or stopped.

FaridAgl · May 14, 2014

Nice job.

What about returning Null instead of False when it's not a valid stopwatch?

Func Stopwatch_IsRunning(ByRef $aStopwatch)
    Return __Stopwatch_IsStopwatch($aStopwatch) ? $aStopwatch[$STOPWATCH_RUNNING] : Null
EndFunc

Adding another element (Index 0) as the signature could be a good idea.

Func __Stopwatch_IsStopwatch(ByRef $aStopwatch)
    Return UBound($aStopwatch) = $STOPWATCH_MAX And $aStopwatch[$STOPWATCH_SIG] = 0xDEADBEEF ;Or whatever
EndFunc

Edited May 14, 2014 by D4RKON3

guinness · May 14, 2014

Thanks.

I had Null but then changed it last minute and about the signature, I like it.

Edited May 14, 2014 by guinness

FaridAgl · May 14, 2014

Signature probably ^_^

guinness · May 14, 2014

Added: Now using _WinAPI_QueryPerformanceCounter() instead of TimerInt(), though only if _WinAPI_QueryPerformanceFrequency() is greater than zero. If it isn't then TimerInt() is used as a backup.

Added: Stopwatch_ElapsedTicks()

Added: Unique signature. (Thanks D4RKON3)

Changed: Return of IsRunning to Null if not a valid Stopwatch handle. (Thanks D4RKON3)

Changed: Used SharpDevelop's ILSpy to look at the code for the Stopwatch class and mimic what Microsoft was doing. (Thanks Microsoft)

Edited May 14, 2014 by guinness

FaridAgl · May 14, 2014

You saw how Microsoft implement that?

Is it possible to see codes regarding to .Net's event handlers? I'm really interesting in how they are doing this!

guinness · May 14, 2014

You can either use ILSpy or the beta version of SharpDevelop or http://referencesource.microsoft.com/.

guinness · May 14, 2014

Just reduced some lines by using ternary statements.

FaridAgl · May 15, 2014

The console output says

IsRunning:

It's the output of line 13, shouldn't it output False? Just like line 41?

guinness · May 15, 2014

The console output says
IsRunning:
It's the output of line 13, shouldn't it output False? Just like line 41?

Ah, fixed. It was because of the signature addition.

FaridAgl · May 18, 2014

guinness

I guess it's the time to replace _WinAPI_CreateGUID() with a constant GUID as you did in >Queue and >Stack UDFs ^_^

guinness · May 18, 2014

guinness
I guess it's the time to replace _WinAPI_CreateGUID() with a constant GUID as you did in >Queue and >Stack UDFs

Yeah, done.

guinness · June 5, 2014

I dunno about you, but I feel quite proud of how this UDF turned out in the end. I am already using in one application of mine.

FaridAgl · June 8, 2014

I just found one great usage for this UDF right now, going to implement that.

Thanks...

guinness · June 10, 2014

You have my attention too.

guinness · July 17, 2014

Removed redundant includes and did a bit of tidying of the syntax. Functionality still remains the same.

Stopwatch UDF - Based on the concept in .NET.

Recommended Posts

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Create an account or sign in to comment

Create an account

Sign in

Recently Browsing 0 members

Similar Content