kzu_speed_measurer.h File Reference

Implements an object that calculates average speed from its measurement data. More...

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

Functions
kzsError	kzuSpeedMeasurerCreate (const struct KzcMemoryManager *memoryManager, kzUint maxMeasurements, kzUint maxAveragingTime, struct KzuSpeedMeasurer **out_measurer)
	Creates a speed measurer with the given properties. More...
kzsError	kzuSpeedMeasurerDelete (struct KzuSpeedMeasurer *measurer)
	Deletes a speed measurer. More...
void	kzuSpeedMeasurerReset (struct KzuSpeedMeasurer *measurer)
	Resets measurement data. More...
void	kzuSpeedMeasurerAddMeasurement (struct KzuSpeedMeasurer *measurer, kzFloat position, kzUint timestamp)
	Adds a new measurement to the measurer. More...
kzBool	kzuSpeedMeasurerGetSpeed (const struct KzuSpeedMeasurer *measurer, kzUint measurementTime, kzFloat *out_speed)
	Calculates average speed from measurements in units / second. More...

Detailed Description

Implements an object that calculates average speed from its measurement data.

Copyright 2008-2019 by Rightware. All rights reserved.

Function Documentation

kzsError kzuSpeedMeasurerCreate	(	const struct KzcMemoryManager *	memoryManager,
		kzUint	maxMeasurements,
		kzUint	maxAveragingTime,
		struct KzuSpeedMeasurer **	out_measurer
	)

Creates a speed measurer with the given properties.

kzsError kzuSpeedMeasurerDelete

(

struct KzuSpeedMeasurer *

measurer)

Deletes a speed measurer.

void kzuSpeedMeasurerReset

(

struct KzuSpeedMeasurer *

measurer)

Resets measurement data.

void kzuSpeedMeasurerAddMeasurement	(	struct KzuSpeedMeasurer *	measurer,
		kzFloat	position,
		kzUint	timestamp
	)

Adds a new measurement to the measurer.

kzBool kzuSpeedMeasurerGetSpeed	(	const struct KzuSpeedMeasurer *	measurer,
		kzUint	measurementTime,
		kzFloat *	out_speed
	)

Calculates average speed from measurements in units / second.

Returns KZ_FALSE and 0.0f if there were not enough measurements.