XDK API  3.6.0
Documentation
Data Structures | Typedefs | Functions
Serval_StopWatch.h File Reference

An interface to the stop watch module.This file provides interfaces to use stop watch functionality. In addition to the data structures needed to represent and manage a stop watch, this file also includes the interfaces which provides functionality like starting a stop watch, getting absolute time in millisecond and second since the start of stop watch and also getting starting time of stop watch. More...

#include <Serval_Types.h>
#include <Serval_Exceptions.h>
+ Include dependency graph for Serval_StopWatch.h:

Data Structures

struct  StopWatch_S
 

Typedefs

typedef struct StopWatch_S StopWatch_T
 

Functions

retcode_t StopWatch_getDuaration (StopWatch_T *watch_ptr, uint32_t *time_ptr)
 
retcode_t StopWatch_getDuarationMillis (StopWatch_T *watch_ptr, uint64_t *time_ptr)
 
retcode_t StopWatch_getStartTime (StopWatch_T *watch_ptr, uint64_t *time_ptr)
 
retcode_t StopWatch_start (StopWatch_T *watch_ptr)
 

Typedef Documentation

typedef struct StopWatch_S StopWatch_T

This data structure represents a context of a stop watch.

See also
struct StopWatch_S

Function Documentation

retcode_t StopWatch_getDuaration ( StopWatch_T watch_ptr,
uint32_t *  time_ptr 
)

This function is called to fetch the duration in second(s) since start of given instance of stop watch. The function StopWatch_start() should have been called before calling this function.

Parameters
[in]watch_ptrReference to a StopWatch_T object which identifies the instance of stop watch been used. It has to be a valid pointer.
[out]time_ptrThis will contain time value in second(s) when the function returns.
Returns
RC_OK if successful
See also
StopWatch_getDuarationMillis()
retcode_t StopWatch_getDuarationMillis ( StopWatch_T watch_ptr,
uint64_t *  time_ptr 
)

This function is called to fetch the duration in millisecond(s) since start of given instance of stop watch. The function StopWatch_start() should have been called before calling this function.

Parameters
[in]watch_ptrReference to a StopWatch_T object which identifies the instance of stop watch been used. It has to be a valid pointer.
[out]time_ptrThis will contain time value in millisecond(s) when the function returns.
Returns
RC_OK if successful
See also
StopWatch_getDuaration()
retcode_t StopWatch_getStartTime ( StopWatch_T watch_ptr,
uint64_t *  time_ptr 
)

This function is called to fetch the starting time value of given instance of stop watch.

Parameters
[in]watch_ptrReference to a StopWatch_T object which identifies the instance of stop watch been used. It has to be a valid pointer.
[out]time_ptrPointer to store the start time to
Returns
RC_OK if successful
retcode_t StopWatch_start ( StopWatch_T watch_ptr)

This function is called to mark start of stop watch.

Parameters
[in]watch_ptrReference to a StopWatch_T object which identifies the instance of stop watch been started. It has to be a valid pointer.
Returns
RC_OK on success

All rights reserved. The use is subject to the XDK SDK EULA by Bosch Connected Devices and Solutions GmbH.
This documentation file has been automatically generated on Thu Mar 14 2019 19:12:46 by doxygen 1.8.8