create.c File Reference

Functions that create and display binary configuration files. More...

#include <LATC/LATC_msgs.h>
#include <create.h>
#include <addr.h>
#include <fo_p.h>
#include <data.h>
#include <data.ic>
#include <number.ic>
#include <parser_tag_p.h>
#include <AG_latcType_s.h>
#include <AG_addr_s.h>
#include <AG_xml_tags_s.h>
#include <LEM/msg_macros.h>
#include <PBS/MBA.h>

Functions
unsigned	LATC_createMap (LATC_map *map, const char *filename)
	Write out the data of a LATC_map structure.
unsigned	LATC_createCfg (LATC_imm *imm, unsigned filter, const char *stub)
	Create a set of binary configuration files based on the contents of the imm, using lcm as the first in a sequence of file IDs.
unsigned	LATC_createFile (LATC_imm *imm, LATC_type type, const char *filename)
	Create a single binary configuration file containing the data of one component (or the default data).
void	LATC_report (LATC_imm *imm, FILE *fp, unsigned noDflt)
	Print a report of the contents of the IMM to the file.
void	LATC_genxml (LATC_imm *imm, FILE *fp, unsigned noDflt)
	Generate XML source from the contents of the IMM.

---

Detailed Description

Functions that create and display binary configuration files.

Author:

James Swain & Owen Saxton

Id

create.c,v 1.8 2011/04/08 00:20:45 apw Exp

---

Function Documentation

unsigned LATC_createCfg	(	LATC_imm *	imm,
		unsigned	filter,
		const char *	stub
	)

Create a set of binary configuration files based on the contents of the imm, using lcm as the first in a sequence of file IDs.

Parameters:

	imm	IMM structure used as the basis of the binary configuration
	stub	Stub to use as a basis for the output filenames
	filter	Bitmask of LAT component files to create

Return values:

	LATC_SUCCESS	if all goes well
	LATC_BADFOPEN	if the configuration master file or any of the configuration binary files cannot be opened.
	LATC_BADWRITE	if one of the file write operations failed
	LATC_BADCLOSE	if one of the files failed to close

References LATC_createFile().

Referenced by LATC_parse().

unsigned LATC_createFile	(	LATC_imm *	imm,
		LATC_type	type,
		const char *	filename
	)

Create a single binary configuration file containing the data of one component (or the default data).

Parameters:

	imm	IMM structure used as the basis of the binary configuration
	type	Component type to write out
	filename	Name to use for this file

Return values:

	LATC_SUCCESS	if all goes well
	LATC_BADFOPEN	if the file cannot be opened.
	LATC_BADWRITE	if one of the file write operations failed
	LATC_BADCLOSE	if the file fails to close
	LATC_NOWRITE	if the selected type is not written seperately (not reported)
	LATC_NOSPECAL	if the selected type has no data specified (not reported)

References countMap(), file_create(), file_finish(), and file_write().

Referenced by LATC_createCfg().

unsigned LATC_createMap	(	LATC_map *	map,
		const char *	filename
	)

Write out the data of a LATC_map structure.

Parameters:

	map	Pointer to the LATC_map whose data should be written to file
	filename	Name of the destination file

Return values:

	LATC_SUCCESS	if all goes well
	LATC_BADFOPEN	if the file cannot be opened.
	LATC_BADWRITE	if one of the file write operations failed
	LATC_BADCLOSE	if the file fails to close

References file_create(), file_finish(), file_write(), and sizeofMap().

Referenced by LATC_parseMap().

void LATC_genxml	(	LATC_imm *	imm,
		FILE *	fp,
		unsigned	noDflt
	)

Generate XML source from the contents of the IMM.

Parameters:

	imm	Pointer to an IMM
	fp	Pointer to destination of the report
	noDflt	True if default values not present

void LATC_report	(	LATC_imm *	imm,
		FILE *	fp,
		unsigned	noDflt
	)

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

Parameters:

	imm	Pointer to an IMM
	fp	Pointer to destination of the report
	noDflt	True if default values not present

References CptDescription::width.