/tmp/l4check/full_tree/trunk/l4/pkg/rt_mon/include/scalar.h File Reference

Functions to operate on the most basic sensors type: scalars. More...

#include <l4/rt_mon/types.h>

Go to the source code of this file.

Functions
EXTERN_C_BEGIN rt_mon_scalar_t *	rt_mon_scalar_create (rt_mon_time_t low, rt_mon_time_t high, const char *name, const char *unit, int clock)
	Creates a new event_list, allocates memory for it and registers it at the coordinator.
void	rt_mon_scalar_free (rt_mon_scalar_t *scalar)
	Destroys a scalar, unregisters it at the coordinator and frees its memory.
void	rt_mon_scalar_insert (rt_mon_scalar_t *scalar, rt_mon_time_t data)
	Insert value into scalar.
rt_mon_time_t	rt_mon_scalar_measure (rt_mon_scalar_t *scalar)
	Get a time stamp using the timesource specified in scalar.
rt_mon_time_t	rt_mon_scalar_read (rt_mon_scalar_t *scalar)
	Read current value from scalar.
void	rt_mon_scalar_dump (rt_mon_scalar_t *scalar)
	Dump the content of the scalar using printf.

---

Detailed Description

Functions to operate on the most basic sensors type: scalars.

Date:

11/30/2004

Author:

Martin Pohlack <mp26@os.inf.tu-dresden.de>

---

Function Documentation

EXTERN_C_BEGIN rt_mon_scalar_t* rt_mon_scalar_create	(	rt_mon_time_t	low,
		rt_mon_time_t	high,
		const char *	name,
		const char *	unit,
		int	clock
	)

Creates a new event_list, allocates memory for it and registers it at the coordinator.

Parameters:

	low	lower bound for valid values
	high	lower bound for valid values
	name	name of this scalar
	unit	measurement unit of data transported in the scalar
	clock	type of time source to use

Returns:

pointer to newly malloc'ed, registered and initialized event_list, otherwise

• NULL in case of error (like out of memory)

void rt_mon_scalar_dump

(

rt_mon_scalar_t *

scalar

)

Dump the content of the scalar using printf.

Parameters:

scalar

scalar to dump

void rt_mon_scalar_free

(

rt_mon_scalar_t *

scalar

)

Destroys a scalar, unregisters it at the coordinator and frees its memory.

Parameters:

scalar

scalar to free

void rt_mon_scalar_insert	(	rt_mon_scalar_t *	scalar,
		rt_mon_time_t	data
	)			[inline]

Insert value into scalar.

Parameters:

	scalar	scalar to operate on
	data	value to insert

rt_mon_time_t rt_mon_scalar_measure

(

rt_mon_scalar_t *

scalar

)

[inline]

Get a time stamp using the timesource specified in scalar.

Parameters:

scalar

scalar to get the time source type from

Returns:

the time measured

rt_mon_time_t rt_mon_scalar_read

(

rt_mon_scalar_t *

scalar

)

[inline]

Read current value from scalar.

Parameters:

scalar

scalar to get the data from

Returns:

value read