Main Page | Modules | Class List | File List | File Members

Converter API


Typedefs

typedef void * tQSL_Converter

Functions

int tqsl_beginADIFConverter (tQSL_Converter *conv, const char *filename, tQSL_Cert *certs, int ncerts, tQSL_Location loc)
int tqsl_beginCabrilloConverter (tQSL_Converter *conv, const char *filename, tQSL_Cert *certs, int ncerts, tQSL_Location loc)
int tqsl_endConverter (tQSL_Converter *conv)
int tqsl_setConverterAllowBadCall (tQSL_Converter conv, int allow)
int tqsl_setADIFConverterDateFilter (tQSL_Converter conv, tQSL_Date *start, tQSL_Date *end)
const char * tqsl_getConverterGABBI (tQSL_Converter conv)
int tqsl_getConverterCert (tQSL_Converter conv, tQSL_Cert *certp)
int tqsl_getConverterLine (tQSL_Converter conv, int *lineno)
const char * tqsl_getConverterRecordText (tQSL_Converter conv)

Detailed Description

The Converter API provides the capability of converting Cabrillo and ADIF files to GABBI output.

Function Documentation

int tqsl_beginADIFConverter tQSL_Converter *  conv,
const char *  filename,
tQSL_Cert *  certs,
int  ncerts,
tQSL_Location  loc
 

Initiates the conversion process for an ADIF file.

certs and ncerts define a set of certificates that are available to the converter for signing records. Typically, this list will be obtained by calling tqsl_selectCertificates().

tqsl_endConverter() should be called to free the resources when the conversion is finished.

int tqsl_beginCabrilloConverter tQSL_Converter *  conv,
const char *  filename,
tQSL_Cert *  certs,
int  ncerts,
tQSL_Location  loc
 

Initiates the conversion process for a Cabrillo file.

certs and ncerts define a set of certificates that are available to the converter for signing records. Typically, this list will be obtained by calling tqsl_selectCertificates().

tqsl_endConverter() should be called to free the resources when the conversion is finished.

int tqsl_endConverter tQSL_Converter *  conv  ) 
 

End the conversion process by freeing the used resources.

int tqsl_getConverterCert tQSL_Converter  conv,
tQSL_Cert *  certp
 

Get the certificate used to sign the most recent QSO record.

const char* tqsl_getConverterGABBI tQSL_Converter  conv  ) 
 

This is the main converter function. It returns a single GABBI record.

Returns the NULL pointer on error or EOF. (Test tQSL_Error to determine which.)

tQSL_Error is set to TQSL_DATE_OUT_OF_RANGE if QSO date range checking is active (see ::tqsl_useADIFConverterDateFilter) and the QSO date is outside the specified range. This is a non-fatal error.

N.B. On systems that distinguish text-mode files from binary-mode files, notably Windows, the GABBI records should be written in binary mode.

N.B. If the selected certificate has not been initialized for signing via tqsl_beginSigning(), this function will return a TQSL_SIGNINIT_ERROR. The cert that caused the error can be obtained via tqsl_getConverterCert(), initialized for signing, and then this function can be called again. No data records will be lost in this process.

int tqsl_getConverterLine tQSL_Converter  conv,
int *  lineno
 

Get the input-file line number last read by the converter, starting at line 1.

const char* tqsl_getConverterRecordText tQSL_Converter  conv  ) 
 

Get the text of the last record read by the converter.

Returns NULL on error.

int tqsl_setADIFConverterDateFilter tQSL_Converter  conv,
tQSL_Date start,
tQSL_Date end
 

Set QSO date filtering in the converter.

If start points to a valid date, QSOs prior to that date will be ignored by the converter. Similarly, if end points to a valid date, QSOs after that date will be ignored. Either or both may be NULL (or point to an invalid date) to disable date filtering for the respective range.

int tqsl_setConverterAllowBadCall tQSL_Converter  conv,
int  allow
 

Configure the converter to allow (allow != 0) or disallow (allow == 0) nonamateur call signs in the CALL field. (Note: the test for validity is fairly trivial and will allow some nonamateur calls to get through, but it does catch most common errors.)

allow defaults to 0 when tqsl_beginADIFConverter or tqsl_beginCabrilloConverter is called.


Generated on Tue Feb 22 08:15:36 2005 for TrustedQSL Library API by doxygen 1.3.4