straight.h File Reference

#include <cartcomm/cframe.h>

Include dependency graph for straight.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
void *	driver_straight_alloc (void)
	Construct a driver.
void	driver_straight_free (void *data)
	Deconstruct the driver.
int	driver_straight (cframe_t *cframe, void *data)
	Drive the cart.

---

Function Documentation

int driver_straight (  cframe_t *  cframe, void *  data )

Drive the cart. The driver is responsible for taking in the values the cframe and updating the cframe for transmission back to the cart. The process of updating is loosely called "driving". Parameters: cframe  current communication frame from the cart data  private state information (obtained from driver_alloc()) Return values: 0  successful and unfinished 1  successful and finished otherwise  error Definition at line 14 of file straight.c. References cframe_t.

void* driver_straight_alloc (  void   )

Construct a driver. The driver usually will allocat some kind of data structure which maintains the state of the driver between calls to driver(). The driver can perform any other initialization needed during this call. Returns: private state information See also: driver_free() Definition at line 6 of file straight.c.

void driver_straight_free (  void *  data  )

Deconstruct the driver. Free any memory and clean up any other resources held by the driver. Parameters: data  private state information (obtained from driver_alloc()) Definition at line 10 of file straight.c.

---