GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> RIM / dev > rim_ground / rhel4-32


Interface   Data Structures   File List   Data Fields   Globals  

RIM_report.c File Reference

Functions to create report file from a RIM structure. More...

#include <RIM_ground_p.h>
#include <RIM_p.h>
#include <RIM_descriptions.ic>
#include <RIM_number.ic>
#include <RIM_data.ic>
#include <RIM_AG_init_p.h>
#include <RIM/RIM_ground.h>
#include <RIM/RIM_msgs.h>
#include <stdio.h>
#include <time.h>

Enumerations

enum  {
  ADDR_SIZE = 9,
  MAX_WIDTH = 80,
  COL_SPACE = 2,
  LVL_COLM = 0,
  LVL_TYPE = 1,
  LVL_ALL = 2,
  INDENT = 4
}

Functions

static void genxmlDflt (const RIM *rim, FILE *fp, RIM_tag **tags, int depth, RIM_type *types)
static void genxmlExcpn (const RIM *rim, FILE *fp, RIM_tag **tags, int depth, RIM_type *types)
static void reportLL (const CptDescription *cd, const void *data, FILE *fp)
static void reportL (const CptDescription *cd, const void *data, FILE *fp)
static void reportS (const CptDescription *cd, const void *data, FILE *fp)
static void reportLayerAddr (const RIM_addr *addr, RIM_type type, FILE *fp)
static void reportStdAddr (const RIM_addr *addr, RIM_type type, FILE *fp)
static void genxmlLL (const CptDescription *cd, const void *data, int depth, FILE *fp)
static void genxmlL (const CptDescription *cd, const void *data, int depth, FILE *fp)
static void genxmlS (const CptDescription *cd, const void *data, int depth, FILE *fp)
static int mapIsMasked (const RIM_map *map, const RIM_map *ign, RIM_type type)
void RIM_report (const RIM *rim, unsigned int secs, const char *title, FILE *fp)
 Print a report of the contents of the RIM to a file.
void RIM_genxml (const RIM *rim, FILE *fp)
 Generate XML source from the contents of a RIM.
void RIM_reportMap (const RIM_map *map, const RIM_map *ign, FILE *fp, int level)
 Print a report of the contents of a RIM map to a file.
void RIM_dumpMap (const RIM_map *map, FILE *fp)
 Print out the map in hex dump format.

Variables

static char blank [] = " "


Detailed Description

Functions to create report file from a RIM structure.

Author:
James Swain & Owen Saxton
$Id: RIM_report.c,v 1.12 2011/03/27 06:53:19 saxton Exp $

Function Documentation

void RIM_dumpMap ( const 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

References sizeofMap().

void RIM_genxml ( const RIM rim,
FILE *  fp 
)

Generate XML source from the contents of a RIM.

In order to produce the XML source, the hierarchy of component types must be reconstructed. This can done from either the tree of configuration tags or the tree of map tags. The latter is used since it contains only the hierarchy of types.

Parameters:
rim Pointer to a RIM structure
fp Pointer to destination of the report

References RIM_mapTags().

void RIM_report ( const RIM rim,
unsigned int  secs,
const char *  title,
FILE *  fp 
)

Print a report of the contents of the RIM to a file.

Parameters:
rim RIM structure to use as a source
secs The time to display at the top of the report, in Unix time, or 0 if no time wanted.
title The address of the title to display at the top of the report, or NULL to display the default title - "LAT Configuration".
fp Pointer to destination of the report

References checkBit(), and CptDescription::width.

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

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
level Printing level, as follows:
  • 0: Print only row segments with an unignored non-zero entry.
  • 1: Print only complete components with an unignored non-zero entry.
  • 2: Print everything.

References checkBit(), and _RIM_addr::cpt.


Generated on Tue Sep 27 16:06:31 2011 by  doxygen 1.5.8