-
Notifications
You must be signed in to change notification settings - Fork 0
/
winapi_timer.cpp
1169 lines (966 loc) · 41.5 KB
/
winapi_timer.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/****************************************************************
** OrangeBot Project
*****************************************************************************
** /
** /
** /
** ______ \
** \
** \
*****************************************************************************
** Winapi Timer
*****************************************************************************
** Author: Orso Eric
** Creation Date:
** Last Edit Date:
** Revision: 1
** Version: 0.1 ALFA
****************************************************************************/
/****************************************************************************
** DESCRIPTION
*****************************************************************************
** This class provides a wrapper to the queue timers.
** It is meant to simply initialize a repeatable timer with callback.
** WINAPI
** This class is based upon the windows queue timers. As far as i understand
** it's a special process inside the scheduler. system calls allow for
** a very precise callback timer down to the time slice of the scheduler.
** Using this function i discovered that the time slice in my windows is 5mS
** ROUNDING
** If i use a period of N*5mS, the timer is VERY precise.
** I tested is using the windows performance counters.
** If not, the queue timer will mantain the verage, but will call at nearest
** multiple making the period irregular.
** Example:
** Period = 10mS
** 10.01mS 9.99mS 10mS 10mS ...
** Period 0 8mS
** 10mS 5mS 5mS 10mS 5mS 10mS 5mS 5mS ...
** i tried 65 and does 62 and 78
** 60 does 62 and 48. it's definitely more complex than this. maybe i shouldn't round
** RELEASE
** It can take a few seconds for the queue timers and all timers within to be released
** They will be still called after the release call. Handle it.
****************************************************************************/
/****************************************************************************
** HYSTORY VERSION
*****************************************************************************
** V0.1
** >class header and data structure
** >creation of time queue and timer tested in project test_timer_queue
** >Minimum time step is 5mS on my PC
** >Made function to approximate frequency in N*timesteps.
****************************************************************************/
/****************************************************************************
** KNOWN BUG
*****************************************************************************
**
****************************************************************************/
/****************************************************************************
** INCLUDE
****************************************************************************/
#include <iostream>
//Windows api
#include <windows.h>
//Utilities based on winapi system call
#include "winapi_utils.h"
//header
#include "winapi_timer.h"
/****************************************************************************
** NAMESPACE
****************************************************************************/
using namespace std;
/****************************************************************************
** GLOBAL VARIABILE
****************************************************************************/
/****************************************************************************
*****************************************************************************
** CONSTRUCTORS
*****************************************************************************
****************************************************************************/
/****************************************************************************
** Empty Constructor
**
*****************************************************************************
** PARAMETER:
** RETURN:
** DESCRIPTION:
****************************************************************************/
Winapi_timer::Winapi_timer( void )
{
///--------------------------------------------------------------------------
/// STATIC VARIABILE
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// LOCAL VARIABILE
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// CHECK
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// INITIALIZATIONS
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// BODY
///--------------------------------------------------------------------------
//Initialize class variables
init_vars();
///--------------------------------------------------------------------------
/// FINALIZATIONS
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// RETURN
///--------------------------------------------------------------------------
return;
} //end empty constructor
/****************************************************************************
** Initialized constructor: frame rate
** Winapi_timer | int, WAITORTIMERCALLBACK
*****************************************************************************
** PARAMETER:
** RETURN:
** DESCRIPTION:
****************************************************************************/
Winapi_timer::Winapi_timer( int freq, WAITORTIMERCALLBACK callback )
{
///--------------------------------------------------------------------------
/// STATIC VARIABILE
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// LOCAL VARIABILE
///--------------------------------------------------------------------------
//return flag
bool f_ret;
//period argument for the system call
int period_ms;
///--------------------------------------------------------------------------
/// CHECK
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// INITIALIZATIONS
///--------------------------------------------------------------------------
//Initialize class variables
init_vars();
///--------------------------------------------------------------------------
/// BODY
///--------------------------------------------------------------------------
///Calculate period
//calculate period in mS rounded to the nearest period step.
period_ms = from_freq( freq );
//if: bad period
if (period_ms <= 0)
{
//source frequency was bad
cerr << __FUNCTION__ << " ERR: input frequncy was bad: " << freq << endl;
//fail
return;
}
///Create timer
//create th timer itself
f_ret = born_timer( period_ms, callback );
//if: fail
if (f_ret == TRUE)
{
cerr << __FUNCTION__ << " CRIT ERR: failed to create timer!\n";
//fail
return;
}
///--------------------------------------------------------------------------
/// FINALIZATIONS
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// RETURN
///--------------------------------------------------------------------------
return; //OK
} //end constructor: Winapi_timer | int, WAITORTIMERCALLBACK
/****************************************************************************
*****************************************************************************
** DESTRUCTORS
*****************************************************************************
****************************************************************************/
/****************************************************************************
** Default Destructor
**
*****************************************************************************
** PARAMETER:
** RETURN:
** DESCRIPTION:
****************************************************************************/
Winapi_timer::~Winapi_timer( void )
{
///--------------------------------------------------------------------------
/// STATIC VARIABILE
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// LOCAL VARIABILE
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// CHECK
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// INITIALIZATIONS
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// BODY
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// FINALIZATIONS
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// RETURN
///--------------------------------------------------------------------------
return;
} //end empty constructor
/****************************************************************************
*****************************************************************************
** GETTERS
*****************************************************************************
****************************************************************************/
/****************************************************************************
*****************************************************************************
** SETTERS
*****************************************************************************
****************************************************************************/
/****************************************************************************
*****************************************************************************
** TESTERS
*****************************************************************************
****************************************************************************/
/****************************************************************************
*****************************************************************************
** PUBLIC METHODS
*****************************************************************************
****************************************************************************/
/****************************************************************************
*****************************************************************************
** PRIVATE METHODS
*****************************************************************************
****************************************************************************/
/****************************************************************************
** Private Method
** init_vars | void
*****************************************************************************
** PARAMETER:
** RETURN:
** DESCRIPTION:
** Initialize class vars to thir default value
****************************************************************************/
void Winapi_timer::init_vars( void )
{
///--------------------------------------------------------------------------
/// STATIC VARIABILE
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// LOCAL VARIABILE
///--------------------------------------------------------------------------
//fast counter
register int t;
///--------------------------------------------------------------------------
/// CHECK
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// INITIALIZATIONS
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// BODY
///--------------------------------------------------------------------------
///Initialize class vars
//Init timer queue handle
g_timer_queue = INVALID_HANDLE_VALUE;
//For: scan all possible timers
for (t = 0;t < WINAPI_MAX_TIMERS;t++)
{
//Init timer handle
g_timer[ t ] = INVALID_HANDLE_VALUE;
}
//Init number of timers active
g_num_timer = 0;
///--------------------------------------------------------------------------
/// FINALIZATIONS
///--------------------------------------------------------------------------
return; //OK
} //end method: init_vars
/****************************************************************************
** Public Method
** born_timer_queue | void
*****************************************************************************
** PARAMETER:
** RETURN:
** DESCRIPTION:
** Create a timer queue
****************************************************************************/
bool Winapi_timer::born_timer_queue( void )
{
///--------------------------------------------------------------------------
/// STATIC VARIABILE
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// LOCAL VARIABILE
///--------------------------------------------------------------------------
//temp handle
HANDLE htmp = INVALID_HANDLE_VALUE;
//return winapi error code
DWORD err;
///--------------------------------------------------------------------------
/// CHECK
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// INITIALIZATIONS
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// BODY
///--------------------------------------------------------------------------
///----------------------------------------------------------------
/// CreateTimerQueue
///----------------------------------------------------------------
// This function creates the thread that makes the callback
//Create the timer queue
htmp = CreateTimerQueue();
//if: bad handle
if (IS_BAD_HANDLE(htmp))
{
//Find out what went wrong
err = GetLastError();
//
cerr << __FUNCTION__ << "ERR: failed to create HANDLE: timer_queue. code: " << err << endl;
//Fail
return TRUE;
}
///--------------------------------------------------------------------------
/// FINALIZATIONS
///--------------------------------------------------------------------------
//Write back handle
g_timer_queue = htmp;
return FALSE; //OK
} //end method: born_timer_queue | void
/****************************************************************************
** Private Method
** born_timer | int, WAITORTIMERCALLBACK
*****************************************************************************
** PARAMETER:
** RETURN:
** FALSE: Everything is OK
** TRUE: Something went wrong. timer did not initialize.
** DESCRIPTION:
** Add a timer to the timer queue
** If the tiemr queue does not exists, try and create it.
****************************************************************************/
bool Winapi_timer::born_timer( int period_ms, WAITORTIMERCALLBACK callback )
{
///--------------------------------------------------------------------------
/// STATIC VARIABILE
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// LOCAL VARIABILE
///--------------------------------------------------------------------------
//Temp handle
HANDLE timer_queue;
HANDLE timer;
//temp timer index
int index;
//return bool
bool f_ret;
//windows error code
DWORD err;
///--------------------------------------------------------------------------
/// CHECK
///--------------------------------------------------------------------------
//if: bad parameters
if ((callback == NULL) || (period_ms <= 0))
{
cerr << __FUNCTION__ << " ERR: Bad input parameters!\n";
return TRUE; //Fail
}
///--------------------------------------------------------------------------
/// INITIALIZATIONS
///--------------------------------------------------------------------------
//Fetch timerqueue
timer_queue = g_timer_queue;
//if: bad timer queue
if (IS_BAD_HANDLE(timer_queue))
{
//Timer queue is not initialized. initialize her
f_ret = Winapi_timer::born_timer_queue();
//Fetch timerqueue
timer_queue = g_timer_queue;
//if: fail
if ((f_ret == TRUE) || (IS_BAD_HANDLE(timer_queue)))
{
cerr << __FUNCTION__ << " CRIT ERR: failed to make a queue timer!!!\n";
return TRUE; //Fail
}
//This is timer of index 0. First timer.
index = 0;
} //if: bad timer queue
//if: queue already exists
else
{
//I'm adding one timer to the queue
//The index is the current number of timers
index = g_num_timer;
//if: user tried to place more timers than allowed
if (index >= WINAPI_MAX_TIMERS)
{
cerr << __FUNCTION__ << " CAP: too many timers in the queue. Increase WINAPI_MAX_TIMERS define.\n";
//(TODO) release timer queeue
//
return TRUE; //Fail
}
} //end if: queue already exists
///--------------------------------------------------------------------------
/// BODY
///--------------------------------------------------------------------------
///----------------------------------------------------------------
/// CreateTimerQueueTimer:
///----------------------------------------------------------------
// Register a timer inside a TimerQueue. It's a thread that will make the callback.
// Most parameters are strightforward, but flags is particularly tricky.
// Flags is deeply related to the inner working of the scheduler and timer queue thread.
// NOTE: worker I/O threads do exsts in 2003 and XP, but not in Vista or later
// FLAGS:
// WT_EXECUTEDEFAUL (Default) | The callback function is executed by a non worker I/O thread
// WT_EXECUTEINTIMERTHREAD | The callback function is executed inside the TimerQueue thread.
// Best response, but can affect what's happening in the queue.
// Keep it short
// WT_EXECUTEINIOTHREAD | The callback function is executed by a worker I/O thread
// WT_EXECUTEINPERSISTENTTHREAD | executed by a thread that never terminates.
// WT_EXECUTELONGFUNCTION | The callbackk function can have a long wait inside it.
// helps the system decide how to execute the callback function
// WT_EXECUTEONLYONCE | Specify OneShot timer. period must be zero for this flag to be risen
// WT_TRANSFER_IMPERSONATION | (?????????) wut? what are access tokens
///Create First timer
f_ret =
CreateTimerQueueTimer
(
&timer, //handle of the timer
timer_queue, //TimerQueue that will mak the callback
(WAITORTIMERCALLBACK)callback, //special functin pointer to the callback function to be executed
(PVOID)NULL, //Optional argument that can be sent to the callback function.
0, //Due Time [mS]. The first call will happen after this delay. Can be zero.
period_ms, //Period [mS]. The repeat time. If zero, the timer is one shot.
0 //Flags. Deeply related to the inner working of the scheduler and timer queue thread.
);
//if: queuing the timer has failed
if ( (f_ret == FALSE) || (IS_BAD_HANDLE(timer)))
{
//Find out what went wrong
err = GetLastError();
//
cerr << __FUNCTION__ << "ERR: failed to create timer. Error code: " << err << endl;
//Fail
return TRUE;
}
///--------------------------------------------------------------------------
/// FINALIZATIONS
///--------------------------------------------------------------------------
//Write back timer index
g_num_timer = index;
//write back handle
g_timer[index] = timer;
return FALSE; //OK
} //end method: born_timer | int, WAITORTIMERCALLBACK
/****************************************************************************
** Public Method
** from_freq | int
*****************************************************************************
** PARAMETER:
** RETURN:
** DESCRIPTION:
** calculate delay in mS rounded to the nearest resolution
****************************************************************************/
int Winapi_timer::from_freq( int freq )
{
///--------------------------------------------------------------------------
/// STATIC VARIABILE
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// LOCAL VARIABILE
///--------------------------------------------------------------------------
//temp period in milliseconds
int period_ms;
///--------------------------------------------------------------------------
/// CHECK
///--------------------------------------------------------------------------
//if: bad parameter
if (freq <= 0)
{
cerr << __FUNCTION__ << " ERR: Silly you. A frequency cannot be zero or negatve...\n";
return -1; //Fail
}
///--------------------------------------------------------------------------
/// INITIALIZATIONS
///--------------------------------------------------------------------------
// Example
// (2*12) % (2 *5) = 4 | 4 < 5 | 10
// (2*14) % (2 *5) = 8 | 8 > 5 | 10
#ifdef WINAPI_TIMER_ROUND
int tmp;
//first
period_ms = 2 *1000 / freq;
if (period_ms %(2 *WINAPI_TIME_STEP) < WINAPI_TIME_STEP)
{
period_ms /= (2 *WINAPI_TIME_STEP);
period_ms *= WINAPI_TIME_STEP;
}
else
{
period_ms /= (2 *WINAPI_TIME_STEP);
//round up
period_ms++;
period_ms *= WINAPI_TIME_STEP;
}
#else
//Calculate period.
period_ms = 1000 /freq;
#endif
///CAP Minimum time step
//if: below minimum
if (period_ms < WINAPI_TIME_STEP)
{
//cap to minimum
period_ms = WINAPI_TIME_STEP;
}
///--------------------------------------------------------------------------
/// BODY
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// FINALIZATIONS
///--------------------------------------------------------------------------
//period
return period_ms;
} //end method: from_freq | int
/****************************************************************************
** Public Method
**
*****************************************************************************
** PARAMETER:
** RETURN:
** DESCRIPTION:
****************************************************************************/
bool Winapi_timer::dummy( void )
{
///--------------------------------------------------------------------------
/// STATIC VARIABILE
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// LOCAL VARIABILE
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// CHECK
///--------------------------------------------------------------------------
if (FALSE)
{
cerr << __FUNCTION__ << ":\n";
return TRUE; //Fail
}
///--------------------------------------------------------------------------
/// INITIALIZATIONS
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// BODY
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// FINALIZATIONS
///--------------------------------------------------------------------------
return FALSE; //OK
} //end method:
/****************************************************************************
*****************************************************************************
** CONSTRUCTORS
*****************************************************************************
****************************************************************************/
/****************************************************************************
** Empty Constructor
** Winapi_chrono | void
*****************************************************************************
** PARAMETER:
** RETURN:
** DESCRIPTION:
****************************************************************************/
Winapi_chrono::Winapi_chrono( void )
{
///--------------------------------------------------------------------------
/// STATIC VARIABILE
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// LOCAL VARIABILE
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// CHECK
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// INITIALIZATIONS
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// BODY
///--------------------------------------------------------------------------
//Initialize class variables.
init_vars();
//Calculate system frequency.
get_freq();
///--------------------------------------------------------------------------
/// FINALIZATIONS
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// RETURN
///--------------------------------------------------------------------------
return;
} //end constructor: Winapi_chrono | void
/****************************************************************************
*****************************************************************************
** DESTRUCTORS
*****************************************************************************
****************************************************************************/
/****************************************************************************
** Default Destructor
**
*****************************************************************************
** PARAMETER:
** RETURN:
** DESCRIPTION:
****************************************************************************/
Winapi_chrono::~Winapi_chrono( void )
{
///--------------------------------------------------------------------------
/// STATIC VARIABILE
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// LOCAL VARIABILE
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// CHECK
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// INITIALIZATIONS
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// BODY
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// FINALIZATIONS
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// RETURN
///--------------------------------------------------------------------------
return;
} //end default destructor
/****************************************************************************
*****************************************************************************
** SETTERS
*****************************************************************************
****************************************************************************/
/****************************************************************************
*****************************************************************************
** GETTERS
*****************************************************************************
****************************************************************************/
/****************************************************************************
*****************************************************************************
** TESTERS
*****************************************************************************
****************************************************************************/
/****************************************************************************
*****************************************************************************
** PUBLIC METHODS
*****************************************************************************
****************************************************************************/
/****************************************************************************
** Public Method
** get_freq | void
*****************************************************************************
** PARAMETER:
** RETURN:
** DESCRIPTION:
** calculate system frequency
****************************************************************************/
void Winapi_chrono::get_freq( void )
{
///--------------------------------------------------------------------------
/// STATIC VARIABILE
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// LOCAL VARIABILE
///--------------------------------------------------------------------------
//temp
LARGE_INTEGER freq_tmp;
///--------------------------------------------------------------------------
/// CHECK
///--------------------------------------------------------------------------
//get system frequency
QueryPerformanceFrequency( &freq_tmp );
///--------------------------------------------------------------------------
/// INITIALIZATIONS
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// BODY
///--------------------------------------------------------------------------
//save
g_freq = freq_tmp;
///--------------------------------------------------------------------------
/// FINALIZATIONS
///--------------------------------------------------------------------------
return;
} //end method: get_freq | void
/****************************************************************************
** Public Static Method
** start | int
*****************************************************************************
** PARAMETER:
** RETURN:
** DESCRIPTION:
** snap start of timer
****************************************************************************/
void Winapi_chrono::start( int index )
{
///--------------------------------------------------------------------------
/// STATIC VARIABILE
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// LOCAL VARIABILE
///--------------------------------------------------------------------------
//temp
LARGE_INTEGER time;
///--------------------------------------------------------------------------
/// CHECK
///--------------------------------------------------------------------------
if ((index < 0) || (index > WINAPI_MAX_CHRONOS))
{
cerr << __FUNCTION__ << " ERR: bad chronometer index\n";
return;
}
///--------------------------------------------------------------------------
/// INITIALIZATIONS
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// BODY
///--------------------------------------------------------------------------
//Fetch current time
QueryPerformanceCounter( &time );
//Save start
g_start[index] = time;
///--------------------------------------------------------------------------
/// FINALIZATIONS
///--------------------------------------------------------------------------
return;
} //end method: start | int
/****************************************************************************
** Public Method
** stop | int
*****************************************************************************
** PARAMETER:
** RETURN:
**
** DESCRIPTION:
** Stop time [index]. Get DeltaT in Seconds. Stop doesn't change start. Multiple stop refers to same start.
****************************************************************************/
float Winapi_chrono::stop( int index )
{
///--------------------------------------------------------------------------
/// STATIC VARIABILE
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// LOCAL VARIABILE
///--------------------------------------------------------------------------
//Partial time
float deltat;
//temp frequency
LARGE_INTEGER freq;
//start time
LARGE_INTEGER start;
//Stop time.
LARGE_INTEGER stop;
///--------------------------------------------------------------------------
/// CHECK
///--------------------------------------------------------------------------
//If: bad paramter
if ((index < 0) || (index > WINAPI_MAX_CHRONOS))
{
cerr << __FUNCTION__ << " ERR: bad chronometer index\n";
return WINAPI_CHRONOS_ERR;
}
//If: frequency is somehow not initialized
if (g_freq.QuadPart == 0)
{
//calculate systm frequency
get_freq();
}
//if: start is not defined
if (g_start[index].QuadPart == 0)
{
//stop without start.
return 0.0;
}
///--------------------------------------------------------------------------
/// INITIALIZATIONS
///--------------------------------------------------------------------------
//fetch frequency
freq = g_freq;
//Fetch start
start = g_start[index];
//Get current time
QueryPerformanceCounter( &stop );
//Calculat time delay
deltat = 1.0 *(stop.QuadPart -start.QuadPart) /freq.QuadPart;
///--------------------------------------------------------------------------
/// BODY
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// FINALIZATIONS
///--------------------------------------------------------------------------
return deltat;
} //end method: stop | int
/****************************************************************************
** Public Method
**
*****************************************************************************
** PARAMETER:
** RETURN:
** DESCRIPTION:
** Stop than start
****************************************************************************/
float Winapi_chrono::stop_start( int index )
{
///--------------------------------------------------------------------------
/// STATIC VARIABILE
///--------------------------------------------------------------------------
///--------------------------------------------------------------------------
/// LOCAL VARIABILE
///--------------------------------------------------------------------------