consume.h File Reference

Functions to read in binary configuration files and modify the IMM accordingly. More...

#include <imm.h>

Functions
unsigned	LATC_consume (LATC_imm *imm, unsigned lcm, unsigned *key)
	Reads a configuration, as described by the configuration master file cfgName, into the latc structure.
unsigned	LATC_consumeMap (LATC_map *map, unsigned fid, unsigned *key)
	Read map data into the map structure.

---

Detailed Description

Functions to read in binary configuration files and modify the IMM accordingly.

Author:

James Swain -- jswain@slac.stanford.edu

---

Function Documentation

unsigned LATC_consume	(	LATC_imm *	imm,
		unsigned	lcm,
		unsigned *	key
	)

Reads a configuration, as described by the configuration master file cfgName, into the latc structure.

Parameters:

	imm	Pointer to the IMM to repopulate with the configuration information
	lcm	File ID of the LAT configuration master file
	key	Pointer to location to place the key of file lcm

Return values:

	LATC_SUCCESS	if all goes well
	LATC_BADFOPEN	if the fid, or any of the names the configuration master file contains, does not match a valid file.
	LATC_BADTYPE	if the file contains a bad type identifier
	LATC_BADREAD	if an error occures whilst the file is being read

References consumeAEMFile(), consumeDefaultFile(), consumeGEMFile(), consumeNormalFile(), file_close(), file_open(), and file_read().

unsigned LATC_consumeMap	(	LATC_map *	map,
		unsigned	fid,
		unsigned *	key
	)

Read map data into the map structure.

Parameters:

	map	Map structure to populate from file
	fid	ID of the file containing the data to use
	key	Pointer to location to place the key of file fid

Return values:

	LATC_SUCCESS	if all goes well
	LATC_BADFOPEN	if the fid, or any of the names the configuration master file contains, does not match a valid file.
	LATC_BADREAD	if an error occures whilst the file is being read

References file_close(), file_key(), file_open(), file_read(), and sizeofMap().