All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
kzu_speed_measurer.h File Reference

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

Functions

KANZI_API kzsError kzuSpeedMeasurerCreate (const struct KzcMemoryManager *memoryManager, kzUint maxMeasurements, kzUint minAveragingTime, kzUint maxAveragingTime, struct KzuSpeedMeasurer **out_measurer)
 Creates a speed measurer with the given properties. More...
 
KANZI_API kzsError kzuSpeedMeasurerDelete (struct KzuSpeedMeasurer *measurer)
 Deletes a speed measurer. More...
 
KANZI_API void kzuSpeedMeasurerReset (struct KzuSpeedMeasurer *measurer)
 Resets measurement data. More...
 
KANZI_API void kzuSpeedMeasurerAddMeasurement (struct KzuSpeedMeasurer *measurer, kzFloat position, kzUint timestamp)
 Adds a new measurement to the measurer. More...
 
KANZI_API 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-2020 by Rightware. All rights reserved.

Function Documentation

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

Creates a speed measurer with the given properties.

KANZI_API kzsError kzuSpeedMeasurerDelete ( struct KzuSpeedMeasurer measurer)

Deletes a speed measurer.

KANZI_API void kzuSpeedMeasurerReset ( struct KzuSpeedMeasurer measurer)

Resets measurement data.

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

Adds a new measurement to the measurer.

KANZI_API 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.