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)
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_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.

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.

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.

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.