FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kTimeAvg.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_TIME_AVG_H
9 #define K_FIRESYNC_TIME_AVG_H
10 
11 #include <kFireSync/kFsDef.h>
12 #include <kFireSync/Data/kTimeAvg.x.h>
13 
20 //typedef kObject kTimeAvg; --forward-declared in kFsDef.x.h
21 
32 kFsFx(kStatus) kTimeAvg_Construct(kTimeAvg* stat, k64u window, k64u minInterval, kAlloc allocator);
33 
40 kFsFx(kStatus) kTimeAvg_Clear(kTimeAvg stat);
41 
51 kFsFx(kStatus) kTimeAvg_Add(kTimeAvg stat, k64u timestamp, k64s value);
52 
60 kFsFx(kSize) kTimeAvg_Count(kTimeAvg stat);
61 
69 kFsFx(k64s) kTimeAvg_ValueSum(kTimeAvg stat);
70 
80 kFsFx(kStatus) kTimeAvg_SampleDiff(kTimeAvg stat, k64u* timeDiff, k64s* valueDiff);
81 
82 #endif
kTimeAvg::kTimeAvg_ValueSum
k64s kTimeAvg_ValueSum(kTimeAvg stat)
Reports the sum of current sample values in the dataset.
kTimeAvg::kTimeAvg_Add
kStatus kTimeAvg_Add(kTimeAvg stat, k64u timestamp, k64s value)
Adds a sample value to the data set.
kTimeAvg::kTimeAvg_Construct
kStatus kTimeAvg_Construct(kTimeAvg *stat, k64u window, k64u minInterval, kAlloc allocator)
Constructs a kTimeAvg object.
kTimeAvg::kTimeAvg_Clear
kStatus kTimeAvg_Clear(kTimeAvg stat)
Clears dataset.
kFsDef.h
Essential API declarations for the kFireSync library.
kTimeAvg::kTimeAvg_SampleDiff
kStatus kTimeAvg_SampleDiff(kTimeAvg stat, k64u *timeDiff, k64s *valueDiff)
Reports the time and value differences between the last and first samples.
kTimeAvg::kTimeAvg_Count
kSize kTimeAvg_Count(kTimeAvg stat)
Reports the current count of samples the dataset.
kTimeAvg
Helper class to support calculation of running averages over a time window.