lci_host_p.h File Reference

Definitions for the LCI host functions. More...

#include <lci_p.h>

Typedefs
typedef struct _LCI_compilation	LCI_compilation
	Declaration of the opaque compilation structure.
Functions
unsigned	LCI_compile (const char *mode, const char *infile, const char *outfile, unsigned vol)
	Compile an XML "source" file into a LCI binary configuration file.
unsigned	LCI_create (LCI_configuration *cnf, const char *filename, int mode)
	Open the file and associate it with this configuration structure.
unsigned	LCI_finish (LCI_configuration *cnf)
	Close the configuration file.
unsigned	LCI_write (LCI_configuration *cnf)
	Write the configuration structure to its file.
unsigned	LCI_writeHdr (LCI_configuration *cnf)
	Write the configuration header to its file.

---

Detailed Description

Definitions for the LCI host functions.

Author:

James Swain & Owen Saxton

$Id: lci_host_p.h,v 1.2 2011/03/29 19:32:57 saxton Exp $

---

Function Documentation

unsigned LCI_compile	(	const char *	mode,
		const char *	infile,
		const char *	outfile,
		unsigned	vol
	)

Compile an XML "source" file into a LCI binary configuration file.

Parameters:

mode	Type of configuration file to process (ACD, CAL or TKR)
infile	Name of the input file
outfile	Name of the output file
vol	Set the level of verbosity for the parser

Return values:

LCI_SUCCESS	If all goes well
LCI_MEMERROR	If the create of a compilation object fails
LCI_XMLPARSE	If there is an error within the XLX routines.
LCI_FOPEN	If the output file fails to open

References _LCI_compilation::cnf, _LCI_compilation::doc, LCI_create(), LCI_deleteCompilation(), LCI_finish(), LCI_newCompilation(), LCI_procDoctype(), LCI_setMode(), _LCI_compilation::mode, _LCI_compilation::nCfgIn, _LCI_compilation::nCfgOut, _LCI_compilation::status, STS_NODOCTYPE, and _LCI_compilation::xst.

unsigned LCI_create	(	LCI_configuration *	cnf,
		const char *	filename,
		int	mode
	)

Open the file and associate it with this configuration structure.

Parameters:

cnf	Pointer to an initialised configuration structure
filename	Name of the file to create
mode	Calibration mode

Return values:

LCI_SUCCESS	if the file opens successfully
LCI_FOPEN	if the file failed to open successfully
LCI_TYPE	if the specified type is not one of ACD, CAL or TKR
LCI_FWRITE	if an error occurs writing the file verion information

References _LCI_configuration::fd, LCI_version::maj, LCI_version::min, LCI_version::mode, and _LCI_configuration::ver.

Referenced by LCI_compile().

unsigned LCI_finish

(

LCI_configuration *

cnf

)

Close the configuration file.

Parameters:

cnf	Pointer to an opened configuration

Return values:

LCI_SUCCESS	If the file closes successfully
LCI_FCLOSE	If there is an error closing the file

References _LCI_configuration::fd.

Referenced by LCI_compile().

unsigned LCI_write

(

LCI_configuration *

cnf

)

Write the configuration structure to its file.

Parameters:

cnf	Pointer to an opened configuration

Return values:

LCI_SUCCESS	if a configuration was written successfully
LCI_FWRITE	if there was an error during the write
LCI_TYPE	if the configuration type is bad (not reported)

References LCI_cnfInput::acd, LCI_cnfInput::cal, _LCI_configuration::fd, LCI_cnfInput::gem, _LCI_configuration::inp, LCI_version::mode, LCI_cnfInput::tkr, and _LCI_configuration::ver.

Referenced by LCI_writeOnExit().

unsigned LCI_writeHdr

(

LCI_configuration *

cnf

)

Write the configuration header to its file.

Parameters:

cnf	Pointer to an opened configuration

Return values:

LCI_SUCCESS	if a configuration was written successfully
LCI_FWRITE	if there was an error during the write

References _LCI_configuration::fd, and _LCI_configuration::ver.

Referenced by LCI_writeOnExit().