---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > RIM / V0-0-5

Constituent: rim     Tag: sun-gcc

---

         

---

record.h File Reference

Routine to fill datagrams from the Register In-memory Model structure. More...

#include "RIM/rim.h"

Include dependency graph for record.h:

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

Typedefs
typedef void(	RIM_startDgm )(void *ctl)
	Function called to start a new datagram.
typedef unsigned(	RIM_startCtb )(void *ctl, size_t size, unsigned type)
	Function called to start a new contribution.
typedef void(	RIM_addData )(void *ctl, void *data, size_t size)
	Function called to add data to a contribution.
typedef void(	RIM_endCtb )(void *ctl)
	Function called to end a datagram.
typedef unsigned(	RIM_endDgm )(void *ctl)
	Function called to end (and send) a datagram.
Enumerations
enum	LATC_CTB_BASE_ID {   LATC_SSR_APID = 0x3fd,   LATC_CTB_MAP = 0,   LATC_CTB_DATA = 128 }
	Contribution type base ID for the two types of LATC contributions.
Functions
unsigned	RIM_record (RIM *rim, void *pkt, RIM_startDgm *startDgm, RIM_startCtb *startCtb, RIM_addData *addData, RIM_endCtb *endCtb, RIM_endDgm *endDgm)
	Send the IMM to the SSR.
unsigned	RIM_retrieve (RIM *rim, char *dat, size_t len, unsigned id, int verb)
	Recover a portion of the RIM from a data buffer (actually an LSF contribution).

---

Detailed Description

Routine to fill datagrams from the Register In-memory Model structure.

Author:

James Swain -- jswain@slac.stanford.edu

---

Function Documentation

unsigned RIM_record (  RIM *  rim, void *  pkt, RIM_startDgm *  startDgm, RIM_startCtb *  startCtb, RIM_addData *  addData, RIM_endCtb *  endCtb, RIM_endDgm *  endDgm )

Send the IMM to the SSR. Parameters: rim  Pointer to the RIM structure used to populate the datagram pkt  Opaque pointer to the control structure passed back to the call-backs startDgm  Pointer to function used to start datagram startCtb  Pointer to function used to start a contribution addData  Pointer to function used to add a block of data endCtb  Pointer to function used to end a contribution endDgm  Pointer to function used to end a datagram Returns: One of the error codes from ITC_send, LATC_OUTSIZE if there is a coding error and one of the contributions will not fit into an otherwise empty datagram or LATC_SUCCESS if all goes well.

unsigned RIM_retrieve (  RIM *  rim, char *  dat, size_t  len, unsigned  id, int  verb )

Recover a portion of the RIM from a data buffer (actually an LSF contribution). Parameters: rim  Pointer to the RIM to populate dat  Pointer to a block of data to use len  Length of the data id  Contribution identfier verb  1 - print information messages, 0 - don't Return values: RIM_TYPE_UK  If the type ID in the contribution indicates a component type that does not have configuration data RIM_MAP_NONE  If the type ID in the contribution indicates a component map for a single component RIM_BUF_SHORT  If the contribution is too short to contain the specified data RIM_SUCCESSS  If the contribution is successfully handled

---