---

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

Constituent: rim_ground     Tag: sun-gcc

---

         

---

RIM_ground.h File Reference

Public definitions for RIM ground. More...

#include "RIM/RIM.h"
#include <stdio.h>

Include dependency graph for RIM_ground.h:

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

Functions
void	RIM_dumpMap (RIM_map *map, FILE *fp)
	Print out the map in hex dump format.
unsigned	RIM_parse (RIM *rim, char **filelist, unsigned filecount, unsigned verb)
	Parse a set of XML files and populate the RIM.
unsigned	RIM_parseMap (RIM_map *map, char **filelist, unsigned filecount, unsigned verb)
	Parse a set of XML files and set bits in the RIM map.
void	RIM_report (RIM *rim, FILE *fp)
	Print a report of the contents of the RIM to a file.
void	RIM_reportMap (RIM_map *map, RIM_map *ign, FILE *fp, int all)
	Print a report of the contents of a RIM map to a file.

---

Detailed Description

Public definitions for RIM ground.

Author:

James Swain & Owen Saxton

Id

RIM_ground.h,v 1.1 2007/11/09 22:46:27 saxton Exp

---

Function Documentation

void RIM_dumpMap (  RIM_map *  map, FILE *  fp )

Print out the map in hex dump format. Parameters: map  Pointer to an initialised map structure fp  Pointer to file to dump the map to

unsigned RIM_parse (  RIM *  rim, char **  filelist, unsigned  filecount, unsigned  verb )

Parse a set of XML files and populate the RIM. Parameters: rim  RIM object to populate from the XML files filelist  List of strings containing the names of XML files to parse filecount  Number of XML files to parse verb  1 for verbose, 0 for quiet Return values: RIM_SUCCESS  Success RIM_XMLPARSE  The XLX parser detected an error RIM_XMLVLERR  A string had an invalid value

unsigned RIM_parseMap (  RIM_map *  map, char **  filelist, unsigned  filecount, unsigned  verb )

Parse a set of XML files and set bits in the RIM map. Parameters: map  RIM_map to populate from the XML files filelist  List of strings containing the names of XML files to parse filecount  Number of XML files to parse verb  1 for verbose, 0 for quiet Return values: RIM_SUCCESS  Success RIM_XMLPARSE  The XLX parser detected an error RIM_XMLVLERR  A string had an invalid value

void RIM_report (  RIM *  rim, FILE *  fp )

Print a report of the contents of the RIM to a file. Parameters: rim  RIM structure to use as a source fp  Pointer to destination of the report

void RIM_reportMap (  RIM_map *  map, RIM_map *  ign, FILE *  fp, int  all )

Print a report of the contents of a RIM map to a file. Parameters: map  Address of the RIM map structure to use as a source ign  Address of a RIM ignore map structure. May be NULL. fp  Pointer to destination of the report all  If TRUE, the whole map is printed. Otherwise, only components with non-zero maps are printed.

---