Data log. More...

#include <system/kzs_types.h>
#include <system/debug/kzs_error.h>
#include <system/kzs_header.h>

Data Structures
struct	KzcDataLogIterator
	Iterator for a single dataset. More...

struct	KzcDataSetConfiguration
	Configuration for a single dataset. More...

Macros
#define	kzcDataLogIterate(iterator_param)
	Iterator. More...

#define	kzcDataLogIteratorGetFormat(iterator_param)
	Get dataset format. More...

#define	kzcDataLogIteratorGetSetName(iterator_param)
	Get dataset name. More...

#define	kzcDataLogIteratorGetKey(iterator_param)
	Get current key. More...

#define	kzcDataLogIteratorGetFloatValue(iterator_param)
	Get current floating point value. More...

#define	kzcDataLogIteratorGetIntValue(iterator_param)
	Get current integer value. More...

#define	kzcDataLogIteratorGetUintValue(iterator_param)
	Get current unsigned integer value. More...

Enumerations
enum	KzcDataSetFormat { KZC_LOG_DATA_FORMAT_INT, KZC_LOG_DATA_FORMAT_UINT, KZC_LOG_DATA_FORMAT_FLOAT }
	Data format of dataset. More...

Functions
kzsError	kzcDataLogCreate (const struct KzcMemoryManager memoryManager, struct KzcDataLog *out_dataLog)
	Create DataLog. More...

kzsError	kzcDataLogDelete (struct KzcDataLog *dataLog)
	Delete DataLog. More...

struct KzcDataSetConfiguration	kzcDataSetConfigurationInitialize (enum KzcDataSetFormat format)
	Initialize a DataSetConfiguration. More...

kzsError	kzcDataLogAddDataSet (const struct KzcDataLog *dataLog, kzString name, struct KzcDataSetConfiguration config)
	Add dataset with given data type. More...

kzsError	kzcDataLogRemoveDataSet (const struct KzcDataLog *dataLog, kzString setName)
	Delete dataset. More...

kzsError	kzcDataLogAddInt (struct KzcDataLog *dataLog, kzString setName, kzUint key, kzInt value)
	Set integer number 'value' for dataset 'name' in position 'key'. More...

kzsError	kzcDataLogAddUint (struct KzcDataLog *dataLog, kzString setName, kzUint key, kzUint value)
	Set unsigned integer 'value' for dataset 'name' in position 'key'. More...

kzsError	kzcDataLogAddFloat (struct KzcDataLog *dataLog, kzString setName, kzUint key, kzFloat value)
	Set floating point number 'value' for dataset 'name' in position 'key'. More...

kzsError	kzcDataLogGetInt (const struct KzcDataLog dataLog, kzString setName, kzUint key, kzInt out_value)
	Get integer value in data point 'key'. More...

kzsError	kzcDataLogGetUint (const struct KzcDataLog dataLog, kzString setName, kzUint key, kzUint out_value)
	Get unsigned value in data point 'key'. More...

kzsError	kzcDataLogGetFloat (const struct KzcDataLog dataLog, kzString setName, kzUint key, kzFloat out_value)
	Get floating point value in data point 'key'. More...

kzBool	kzcDataLogHasDataset (const struct KzcDataLog *dataLog, kzString setName)
	Does dataLog contain dataset 'name'. More...

kzUint	kzcDataLogGetDataPointCount (const struct KzcDataLog *dataLog, kzString setName)
	How many key-value data points are stored to dataset 'name'. More...

kzUint	kzcDataLogGetDataPointCountInRange (const struct KzcDataLog *dataLog, kzString setName, kzUint startKey, kzUint endkey)
	How many key-value data points are stored to dataset 'name' within interval startKey and endKey. More...

kzsError	kzcDataLogGetAverageFloat (const struct KzcDataLog dataLog, kzString setName, kzFloat out_average)
	Get average of values within complete dataset. More...

kzsError	kzcDataLogGetAverageInt (const struct KzcDataLog dataLog, kzString setName, kzInt out_average)
	Get average of values within complete dataset. More...

kzsError	kzcDataLogGetAverageUint (const struct KzcDataLog dataLog, kzString setName, kzUint out_average)
	Get average of values within complete dataset. More...

kzsError	kzcDataLogGetAverageFloatInRange (const struct KzcDataLog dataLog, kzString setName, kzUint startKey, kzUint endKey, kzFloat out_average)
	Get average of values with keys within the range startKey and endKey. More...

kzsError	kzcDataLogGetAverageIntInRange (const struct KzcDataLog dataLog, kzString setName, kzUint startKey, kzUint endKey, kzInt out_average)
	Get average of values with keys within the range startKey and endKey. More...

kzsError	kzcDataLogGetAverageUintInRange (const struct KzcDataLog dataLog, kzString setName, kzUint startKey, kzUint endKey, kzUint out_average)
	Get average of values with keys within the range startKey and endKey. More...

kzsError	kzcDataLogGetMinFloat (const struct KzcDataLog dataLog, kzString setName, kzFloat out_average)
	Get minimum floating point value in dataset. More...

kzsError	kzcDataLogGetMinInt (const struct KzcDataLog dataLog, kzString setName, kzInt out_average)
	Get minimum integer value in dataset. More...

kzsError	kzcDataLogGetMinUint (const struct KzcDataLog dataLog, kzString setName, kzUint out_average)
	Get minimum unsigned integer value in dataset. More...

kzsError	kzcDataLogGetMinFloatInRange (const struct KzcDataLog dataLog, kzString setName, kzUint startKey, kzUint endKey, kzFloat out_average)
	Get minimum floating point value in dataset within range startKey and endKey. More...

kzsError	kzcDataLogGetMinIntInRange (const struct KzcDataLog dataLog, kzString setName, kzUint startKey, kzUint endKey, kzInt out_average)
	Get minimum integer point value in dataset within range startKey and endKey. More...

kzsError	kzcDataLogGetMinUintInRange (const struct KzcDataLog dataLog, kzString setName, kzUint startKey, kzUint endKey, kzUint out_average)
	Get minimum unsigned integer point value in dataset within range startKey and endKey. More...

kzsError	kzcDataLogGetMaxFloat (const struct KzcDataLog dataLog, kzString setName, kzFloat out_average)
	Get maximum floating point value in dataset. More...

kzsError	kzcDataLogGetMaxInt (const struct KzcDataLog dataLog, kzString setName, kzInt out_average)
	Get maximum integer value in dataset. More...

kzsError	kzcDataLogGetMaxUint (const struct KzcDataLog dataLog, kzString setName, kzUint out_average)
	Get maximum unsigned integer value in dataset. More...

kzsError	kzcDataLogGetMaxFloatInRange (const struct KzcDataLog dataLog, kzString setName, kzUint startKey, kzUint endKey, kzFloat out_average)
	Get maximum floating point value in dataset within range startKey and endKey. More...

kzsError	kzcDataLogGetMaxIntInRange (const struct KzcDataLog dataLog, kzString setName, kzUint startKey, kzUint endKey, kzInt out_average)
	Get maximum integer value in dataset within range startKey and endKey. More...

kzsError	kzcDataLogGetMaxUintInRange (const struct KzcDataLog dataLog, kzString setName, kzUint startKey, kzUint endKey, kzUint out_average)
	Get maximum unsigned integer value in dataset within range startKey and endKey. More...

kzsError	kzcDataLogGetLastValueFloat (const struct KzcDataLog dataLog, kzString setName, kzUint out_key, kzFloat *out_value)
	Get last floating point value entered in dataset. More...

kzsError	kzcDataLogGetLastValueInt (const struct KzcDataLog dataLog, kzString setName, kzUint out_key, kzInt *out_value)
	Get last integer value entered in dataset. More...

kzsError	kzcDataLogGetLastValueUint (const struct KzcDataLog dataLog, kzString setName, kzUint out_key, kzUint *out_value)
	Get last unsigned integer value entered in dataset. More...

kzsError	kzcDataLogGetMaxKey (const struct KzcDataLog dataLog, kzString setName, kzUint out_key)
	Get maximum key value within dataset. More...

kzsError	kzcDataLogGetMinKey (const struct KzcDataLog dataLog, kzString setName, kzUint out_key)
	Get minimum key value within dataset. More...

kzsError	kzcDataLogGetFormat (const struct KzcDataLog dataLog, kzString setName, enum KzcDataSetFormat out_format)
	Get format of dataset. More...

kzsError	kzcDataLogGetDataSetNames (const struct KzcDataLog dataLog, kzString *out_dataSetNames)
	Get names for all of the DataSets contained within the datalog in an array. More...

struct KzcDataLogIterator	kzcDataLogGetIterator (const struct KzcDataLog *dataLog, kzString setName)
	Get iterator for dataset setName. More...

kzBool	kzcDataLogIterate_private (struct KzcDataLogIterator *iterator)

enum KzcDataSetFormat	kzcDataLogIteratorGetFormat_private (const struct KzcDataLogIterator *iterator)

kzString	kzcDataLogIteratorGetSetName_private (const struct KzcDataLogIterator *iterator)

kzUint	kzcDataLogIteratorGetKey_private (const struct KzcDataLogIterator *iterator)

kzFloat	kzcDataLogIteratorGetFloatValue_private (const struct KzcDataLogIterator *iterator)

kzInt	kzcDataLogIteratorGetIntValue_private (const struct KzcDataLogIterator *iterator)

kzUint	kzcDataLogIteratorGetUintValue_private (const struct KzcDataLogIterator *iterator)

Detailed Description

Data log.

Macro Definition Documentation

#define kzcDataLogIterate ( iterator_param)

Iterator.

Walks through data points in set in order which they were entered into the set.

#define kzcDataLogIteratorGetFormat ( iterator_param)

Get dataset format.

#define kzcDataLogIteratorGetSetName ( iterator_param)

Get dataset name.

#define kzcDataLogIteratorGetKey ( iterator_param)

Get current key.

#define kzcDataLogIteratorGetFloatValue ( iterator_param)

Get current floating point value.

#define kzcDataLogIteratorGetIntValue ( iterator_param)

Get current integer value.

#define kzcDataLogIteratorGetUintValue ( iterator_param)

Get current unsigned integer value.

Enumeration Type Documentation

enum KzcDataSetFormat

Data format of dataset.

Enumerator
KZC_LOG_DATA_FORMAT_INT	Data set contains ints.
KZC_LOG_DATA_FORMAT_UINT	Data set contains uints.
KZC_LOG_DATA_FORMAT_FLOAT	Data set contains floats.

Function Documentation

kzsError kzcDataLogCreate	(	const struct KzcMemoryManager *	memoryManager,
		struct KzcDataLog **	out_dataLog
	)

Create DataLog.

kzsError kzcDataLogDelete ( struct KzcDataLog * dataLog)

Delete DataLog.

struct KzcDataSetConfiguration kzcDataSetConfigurationInitialize ( enum KzcDataSetFormat format)

Initialize a DataSetConfiguration.

kzsError kzcDataLogAddDataSet	(	const struct KzcDataLog *	dataLog,
		kzString	name,
		struct KzcDataSetConfiguration	config
	)

Add dataset with given data type.

kzsError kzcDataLogRemoveDataSet	(	const struct KzcDataLog *	dataLog,
		kzString	setName
	)

Delete dataset.

Return error if could not remove the dataset.

kzsError kzcDataLogAddInt	(	struct KzcDataLog *	dataLog,
		kzString	setName,
		kzUint	key,
		kzInt	value
	)

Set integer number 'value' for dataset 'name' in position 'key'.

Parameters

[in]	dataLog	log container
[in]	setName	of dataset
[in]	key	to store value into
[in]	value	in integer format to store

kzsError kzcDataLogAddUint	(	struct KzcDataLog *	dataLog,
		kzString	setName,
		kzUint	key,
		kzUint	value
	)

Set unsigned integer 'value' for dataset 'name' in position 'key'.

Parameters

[in]	dataLog	log container
[in]	setName	of dataset
[in]	key	to store value into
[in]	value	in unsigned format to store

kzsError kzcDataLogAddFloat	(	struct KzcDataLog *	dataLog,
		kzString	setName,
		kzUint	key,
		kzFloat	value
	)

Set floating point number 'value' for dataset 'name' in position 'key'.

Parameters

[in]	dataLog	log container
[in]	setName	of dataset
[in]	key	to store value into
[in]	value	in floating point format to store

kzsError kzcDataLogGetInt	(	const struct KzcDataLog *	dataLog,
		kzString	setName,
		kzUint	key,
		kzInt *	out_value
	)

Get integer value in data point 'key'.

kzsError kzcDataLogGetUint	(	const struct KzcDataLog *	dataLog,
		kzString	setName,
		kzUint	key,
		kzUint *	out_value
	)

Get unsigned value in data point 'key'.

kzsError kzcDataLogGetFloat	(	const struct KzcDataLog *	dataLog,
		kzString	setName,
		kzUint	key,
		kzFloat *	out_value
	)

Get floating point value in data point 'key'.

kzBool kzcDataLogHasDataset	(	const struct KzcDataLog *	dataLog,
		kzString	setName
	)

Does dataLog contain dataset 'name'.

kzUint kzcDataLogGetDataPointCount	(	const struct KzcDataLog *	dataLog,
		kzString	setName
	)

How many key-value data points are stored to dataset 'name'.

kzUint kzcDataLogGetDataPointCountInRange	(	const struct KzcDataLog *	dataLog,
		kzString	setName,
		kzUint	startKey,
		kzUint	endkey
	)

How many key-value data points are stored to dataset 'name' within interval startKey and endKey.

kzsError kzcDataLogGetAverageFloat	(	const struct KzcDataLog *	dataLog,
		kzString	setName,
		kzFloat *	out_average
	)

Get average of values within complete dataset.

Throws error on wrong format or name.

kzsError kzcDataLogGetAverageInt	(	const struct KzcDataLog *	dataLog,
		kzString	setName,
		kzInt *	out_average
	)

Get average of values within complete dataset.

. Throws error on wrong format or name.

kzsError kzcDataLogGetAverageUint	(	const struct KzcDataLog *	dataLog,
		kzString	setName,
		kzUint *	out_average
	)

Get average of values within complete dataset.

. Throws error on wrong format or name.

kzsError kzcDataLogGetAverageFloatInRange	(	const struct KzcDataLog *	dataLog,
		kzString	setName,
		kzUint	startKey,
		kzUint	endKey,
		kzFloat *	out_average
	)

Get average of values with keys within the range startKey and endKey.

Throws error on wrong format or name.

kzsError kzcDataLogGetAverageIntInRange	(	const struct KzcDataLog *	dataLog,
		kzString	setName,
		kzUint	startKey,
		kzUint	endKey,
		kzInt *	out_average
	)

Get average of values with keys within the range startKey and endKey.

Throws error on wrong format or name.

kzsError kzcDataLogGetAverageUintInRange	(	const struct KzcDataLog *	dataLog,
		kzString	setName,
		kzUint	startKey,
		kzUint	endKey,
		kzUint *	out_average
	)

Get average of values with keys within the range startKey and endKey.

Throws error on wrong format or name.

kzsError kzcDataLogGetMinFloat	(	const struct KzcDataLog *	dataLog,
		kzString	setName,
		kzFloat *	out_average
	)

Get minimum floating point value in dataset.

Throws error on wrong format or name.

kzsError kzcDataLogGetMinInt	(	const struct KzcDataLog *	dataLog,
		kzString	setName,
		kzInt *	out_average
	)

Get minimum integer value in dataset.

Throws error on wrong format or name.

kzsError kzcDataLogGetMinUint	(	const struct KzcDataLog *	dataLog,
		kzString	setName,
		kzUint *	out_average
	)

Get minimum unsigned integer value in dataset.

Throws error on wrong format or name.

kzsError kzcDataLogGetMinFloatInRange	(	const struct KzcDataLog *	dataLog,
		kzString	setName,
		kzUint	startKey,
		kzUint	endKey,
		kzFloat *	out_average
	)

Get minimum floating point value in dataset within range startKey and endKey.

Throws error on wrong format or name.

kzsError kzcDataLogGetMinIntInRange	(	const struct KzcDataLog *	dataLog,
		kzString	setName,
		kzUint	startKey,
		kzUint	endKey,
		kzInt *	out_average
	)

Get minimum integer point value in dataset within range startKey and endKey.

Throws error on wrong format or name.

kzsError kzcDataLogGetMinUintInRange	(	const struct KzcDataLog *	dataLog,
		kzString	setName,
		kzUint	startKey,
		kzUint	endKey,
		kzUint *	out_average
	)

Get minimum unsigned integer point value in dataset within range startKey and endKey.

Throws error on wrong format or name.

kzsError kzcDataLogGetMaxFloat	(	const struct KzcDataLog *	dataLog,
		kzString	setName,
		kzFloat *	out_average
	)

Get maximum floating point value in dataset.

Throws error on wrong format or name.

kzsError kzcDataLogGetMaxInt	(	const struct KzcDataLog *	dataLog,
		kzString	setName,
		kzInt *	out_average
	)

Get maximum integer value in dataset.

Throws error on wrong format or name.

kzsError kzcDataLogGetMaxUint	(	const struct KzcDataLog *	dataLog,
		kzString	setName,
		kzUint *	out_average
	)

Get maximum unsigned integer value in dataset.

Throws error on wrong format or name.

kzsError kzcDataLogGetMaxFloatInRange	(	const struct KzcDataLog *	dataLog,
		kzString	setName,
		kzUint	startKey,
		kzUint	endKey,
		kzFloat *	out_average
	)

Get maximum floating point value in dataset within range startKey and endKey.

Throws error on wrong format or name.

kzsError kzcDataLogGetMaxIntInRange	(	const struct KzcDataLog *	dataLog,
		kzString	setName,
		kzUint	startKey,
		kzUint	endKey,
		kzInt *	out_average
	)

Get maximum integer value in dataset within range startKey and endKey.

Throws error on wrong format or name.

kzsError kzcDataLogGetMaxUintInRange	(	const struct KzcDataLog *	dataLog,
		kzString	setName,
		kzUint	startKey,
		kzUint	endKey,
		kzUint *	out_average
	)

Get maximum unsigned integer value in dataset within range startKey and endKey.

Throws error on wrong format or name.

kzsError kzcDataLogGetLastValueFloat	(	const struct KzcDataLog *	dataLog,
		kzString	setName,
		kzUint *	out_key,
		kzFloat *	out_value
	)

Get last floating point value entered in dataset.

Throws error on wrong format or name.

kzsError kzcDataLogGetLastValueInt	(	const struct KzcDataLog *	dataLog,
		kzString	setName,
		kzUint *	out_key,
		kzInt *	out_value
	)

Get last integer value entered in dataset.

Throws error on wrong format or name.

kzsError kzcDataLogGetLastValueUint	(	const struct KzcDataLog *	dataLog,
		kzString	setName,
		kzUint *	out_key,
		kzUint *	out_value
	)

Get last unsigned integer value entered in dataset.

Throws error on wrong format or name.

kzsError kzcDataLogGetMaxKey	(	const struct KzcDataLog *	dataLog,
		kzString	setName,
		kzUint *	out_key
	)

Get maximum key value within dataset.

kzsError kzcDataLogGetMinKey	(	const struct KzcDataLog *	dataLog,
		kzString	setName,
		kzUint *	out_key
	)

Get minimum key value within dataset.

kzsError kzcDataLogGetFormat	(	const struct KzcDataLog *	dataLog,
		kzString	setName,
		enum KzcDataSetFormat *	out_format
	)

Get format of dataset.

kzsError kzcDataLogGetDataSetNames	(	const struct KzcDataLog *	dataLog,
		kzString **	out_dataSetNames
	)

Get names for all of the DataSets contained within the datalog in an array.

The array must be freed after use with kzcMemoryFreeArray().

struct KzcDataLogIterator kzcDataLogGetIterator	(	const struct KzcDataLog *	dataLog,
		kzString	setName
	)

Get iterator for dataset setName.

kzBool kzcDataLogIterate_private ( struct KzcDataLogIterator * iterator)

See Also: kzcDataLogIterate

enum KzcDataSetFormat kzcDataLogIteratorGetFormat_private ( const struct KzcDataLogIterator * iterator)

See Also: kzcDataLogIteratorGetFormat

kzString kzcDataLogIteratorGetSetName_private ( const struct KzcDataLogIterator * iterator)

See Also: kzcDataLogIteratorGetSetName

kzUint kzcDataLogIteratorGetKey_private ( const struct KzcDataLogIterator * iterator)

See Also: kzcDataLogIteratorGetKey

kzFloat kzcDataLogIteratorGetFloatValue_private ( const struct KzcDataLogIterator * iterator)

See Also: kzcDataLogIteratorGetFloatValue

kzInt kzcDataLogIteratorGetIntValue_private ( const struct KzcDataLogIterator * iterator)

See Also: kzcDataLogIteratorGetIntValue

kzUint kzcDataLogIteratorGetUintValue_private ( const struct KzcDataLogIterator * iterator)

See Also: kzcDataLogIteratorGetUintValue

Data Structures

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

Enumeration Type Documentation

Function Documentation