FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kHealthSummary.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_HEALTH_SUMMARY_H
9 #define K_FIRESYNC_HEALTH_SUMMARY_H
10 
11 #include <kFireSync/kNodeDef.h>
12 #include <kApi/Data/kMap.h>
13 #include <kFireSync/Health/kHealthSummary.x.h>
14 
67 //typedef kObject kHealthSummary; --forward-declared in kFsDef.x.h
68 
75 //typedef kObject kHealthSummaryStat; --forward-declared in kFsDef.x.h
76 
85 kFsFx(kStatus) kHealthSummary_Construct(kHealthSummary* summary, kAlloc allocator);
86 
101 kFsFx(kStatus) kHealthSummary_BeginCompose(kHealthSummary summary, kSize entryCount);
102 
123 kFsFx(kStatus) kHealthSummary_AddStat(kHealthSummary summary, const kChar* name, kHealthId id, k32u instance, kHealthSummaryStat* stat);
124 
136 
148 {
149  kObj(kHealthSummary, summary);
150 
151  return kArrayList_Count(obj->stats);
152 }
153 
165 {
166  kObj(kHealthSummary, summary);
167 
168  return obj->entryCount;
169 }
170 
184 {
185  kObj(kHealthSummary, summary);
186 
187  return kArrayList_ItemT(obj->stats, index, stat);
188 }
189 
202 {
203  kObj(kHealthSummary, summary);
204 
205  return kArrayList_AsT(obj->stats, index, kHealthSummaryStat);
206 }
207 
225 
239 
249 {
250  return kHealthSummaryStat_Name(stat);
251 }
252 
262 {
263  return kHealthSummaryStat_Id(stat);
264 }
265 
275 {
276  return kHealthSummaryStat_Instance(stat);
277 }
278 
291 {
292  return kHealthSummaryStat_Data(stat);
293 }
294 
309 {
310  kArrayList data = kHealthSummaryStat_Data(stat);
311 
312  return kArrayList_ItemT(data, index, &value);
313 }
314 
328 {
329  kArrayList data = kHealthSummaryStat_Data(stat);
330 
331  return kArrayList_AsT(data, index, k64s);
332 }
333 
334 #endif
Numeric identifier for a health statistic.
kStatus kHealthSummary_EntryItem(kHealthSummary summary, kHealthSummaryStat stat, kSize index, k64s *value)
Gets the log entry associated with the specified stat at the specified log entry index.
Definition: kHealthSummary.h:308
k64s kHealthSummary_EntryAt(kHealthSummary summary, kHealthSummaryStat stat, kSize index)
Returns the log entry associated with the specified stat at the specified log entry index...
Definition: kHealthSummary.h:327
kStatus kHealthSummary_Construct(kHealthSummary *summary, kAlloc allocator)
Constructs a kHealthSummary object.
kStatus kHealthSummary_EndCompose(kHealthSummary summary)
Closes the health summary for writing.
#define kArrayList_ItemT(kArrayList_list, kSize_index, TPtr_item)
kSize kHealthSummary_StatCount(kHealthSummary summary)
Reports the number of stats represented in the summary.
Definition: kHealthSummary.h:147
#define kInlineFx(TYPE)
Represents a summary of health log data.
kHealthId kHealthSummary_StatId(kHealthSummary summary, kHealthSummaryStat stat)
Reports the ID associated with the specified health stat.
Definition: kHealthSummary.h:261
Essential declarations related to FireSync nodes.
const kChar * kHealthSummary_StatName(kHealthSummary summary, kHealthSummaryStat stat)
Reports the name of the specified health stat.
Definition: kHealthSummary.h:248
kStatus kHealthSummary_StatItem(kHealthSummary summary, kSize index, kHealthSummaryStat *stat)
Gets a reference to the stat item at the specified index.
Definition: kHealthSummary.h:183
kStatus kHealthSummary_ToString(kHealthSummary summary, kString str)
Prints the contents of the summary to a readable string.
kSize kHealthSummary_EntryCount(kHealthSummary summary)
Reports the number of log entries per stat in the summary.
Definition: kHealthSummary.h:164
#define kObj(TypeName_T, T_object)
kStatus kHealthSummary_FindStat(kHealthSummary summary, kHealthId id, k32u instance, kHealthSummaryStat *stat)
Looks up a stat item by its unique id-instance pair.
kHealthSummaryStat kHealthSummary_StatAt(kHealthSummary summary, kSize index)
Returns a reference to the stat item at the specified index.
Definition: kHealthSummary.h:201
kArrayList kHealthSummary_EntryData(kHealthSummary summary, kHealthSummaryStat stat)
Provides a reference to the entry array associated with the specified stat.
Definition: kHealthSummary.h:290
k32u kHealthSummary_StatInstance(kHealthSummary summary, kHealthSummaryStat stat)
Reports the instance value associated with the specified health stat.
Definition: kHealthSummary.h:274
#define kArrayList_AsT(kArrayList_list, kSize_index, T)
kStatus kHealthSummary_AddStat(kHealthSummary summary, const kChar *name, kHealthId id, k32u instance, kHealthSummaryStat *stat)
Adds a stat to the log.
kStatus kHealthSummary_BeginCompose(kHealthSummary summary, kSize entryCount)
Opens the health summary for writing.
Represents a health statistic within a health log summary.