ROS Serial C client library
ros/include/ros_time.h File Reference

ROS Serial C time. More...

#include "ros_types.h"
Include dependency graph for ros_time.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

rosTime_t rosTimeNow ()
 Get current time.
void rosTimeSetNow (rosTime_t *new_now)
 Set current time.
void rosSleep (uint32_t milliseconds)
 Sleep given duration.
void rosRateInit (rosRate_t *rate, uint32_t frequency)
 Initialize rate.
void rosRateSleep (rosRate_t *rate)
 Sleep given rate.

Detailed Description

ROS Serial C time.

Date:
04/19/2013
Author:
Peter Rudolph

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

License:
This library is released under LGPLv3.

Function Documentation

void rosRateInit ( rosRate_t rate,
uint32_t  frequency 
)

Initialize rate.

Parameters:
start_timeInitial start time
frequencyFrequency to achieve
Returns:
None

Here is the call graph for this function:

void rosRateSleep ( rosRate_t rate)

Sleep given rate.

Parameters:
ratePointer to rosRate_t struct

Here is the call graph for this function:

void rosSleep ( uint32_t  milliseconds)

Sleep given duration.

Used for achieving a desired timing. If you want to achieve a continous to use rosRate_t

Here is the call graph for this function:

Get current time.

Returns:
current time

Here is the call graph for this function:

void rosTimeSetNow ( rosTime_t new_now)

Set current time.

Parameters:
pointerto a rosTime structure

Here is the call graph for this function:

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines