Skip to main content

Classes

Lauren Wheeler
  • Updated

lqtServer

Static Public Member Functions

static lqtServer* create ()

This member function returns a pointer to a newly created lqtServer instance.

static void destroy (lqtServer* pServer)

This member function destroys all resources associated with the supplied lqtServer pointer.

Public Member Functions

void init (const char* path)

This member function initializes a server instance using the loqate.ini configuration file located at the supplied path.

void shutdown ()

This member function shuts down the current server instance

int open ()

This member function creates a new session and returns the session ID.

void close (int ID)

This member function closes the session referenced by the supplied session ID.

serverStatus getStatus ()

This member function returns a serverStatus enumeration value giving the current server status.

const char* getLastError ()

This member function returns a string containing textual detail of the outcome of the most recent member function call.

const char* getOption (const char* option)

This member function returns the string value associated with the supplied option name.

void setOption (const char* option, const char* value)

This member function sets the supplied option name with the supplied option value.

void log (const char* msg)

This member function logs the supplied string to the Loqate log.

void process (const lqtInputRecord* inputRecord, const lqtProcessList* processList, lqtProcessResult* processResult)

This member function performs the supplied lqtProcessList on the supplied lqtInputRecord, returning results in the supplied lqtProcessResult.

const char* getVersion ()

This member function returns the version number of the Loqate server.

const char* readRegistry (const char* tableName, const char* key)

This member function returns the value of the key from the given Loqate table.

 

lqtProcessList

Static Public Member Functions

static lqtProcessList* create ()

This member function returns a pointer to a newly created lqtProcessList instance.

static void destroy (lqtProcessList* pProcessList)

This member function destroys all resources associated with the supplied lqtProcessList pointer.

Public Member Functions

void add (const char* process, const lqtProcessOptions* options)

This member function adds the provided process name and process options to the process list. Click here for a list of available processes.

 

lqtProcessOptions

Static Public Member Functions

static lqtProcessOptions* create ()

This member function returns a pointer to a newly created lqtProcessOptions instance.

static void destroy (lqtProcessOptions* pProcessOptions)

This member function destroys all resources associated with the supplied lqtProcessOptions pointer.

Public Member Functions

const char* get (const char* option)

This member function returns the string value associated with the supplied option name.

void set (const char* option, const char* value)

This member function sets the supplied option name with the supplied option value.

 

 

lqtInputRecord

Static Public Member Functions

static lqtInputRecord* create ()

This member function returns a pointer to a newly created lqtInputRecord instance.

static void destroy (lqtInputRecord* pInputRecord)

This member function destroys all resources associated with the supplied lqtInputRecord pointer.

Public Member Functions

const char* get (const char* field)

This member function returns the string value associated with the supplied field name.

void set (const char* field, const char* value)

This member function sets the supplied field name with the supplied field value

void clear ()

This member function clears the contents of the lqtInputRecord.

 

 

lqtProcessResult

Static Public Member Functions

static lqtProcessResult* create ()

This member function returns a pointer to a newly created lqtProcessResult instance.

static void destroy (lqtProcessResult* pProcessResult)

This member function destroys all resources associated with the supplied lqtProcessResult pointer.

Public Member Functions

processStatus getStatus ()

This member function returns a processStatus enumeration value giving the status of the most recent process that used this lqtProcessResult as a parameter.

const char* getLastError ()

This member function returns a string containing textual detail of the outcome of the most recent process that used this lqtProcessResult as a parameter.

uint getCount ()

This member function returns the number of records within the lqtProcessResult object.

uint getFieldCount (uint record)

This member function return the number of fields within the requested record number.

const char* getField (uint record, const char* field)

This member function return a string value containing the contents of the requested field name from the requested record number.

const char* getField (uint record, uint field)

This member function return a string value containing the contents of the requested field number from the requested record number.

const char* getFieldName (uint record, uint field)

This member function return a string value containing the field name of the requested field number from the requested record number.

fieldStatus getFieldStatus (uint record, const char* field)

This member function returns a fieldStatus enumeration value giving the status of the requested field name from the requested record number.

int getFieldConfidence (uint record, const char* field)

This member function returns a numeric confidence value for the requested field name from the requested record number. This is primarily intended for debugging purposes.

const char* getFieldInfo (uint record, const char* field)

This member function returns a string value containing debug tool information regarding the steps the server took to conclude that this field interpretation is correct. This is primarily intended for debugging purposes.

float getFieldMatchscore (uint record, const char* field)

This member function returns a numeric value between 0 and 100 giving the similarity between the identified input data, and the output data in this field. A result of 100 means that no changes other than alias, casing, or diacritic changes have been made to the input data. A result of 0 means there is no similarity between the input data identified as the specified field, and the output data provided.

lqtMatchInfo getMatchInfo (uint record)

This member function returns a lqtMatchInfo instance containing information regarding the specified record.

const char* getAccuracyCode ()

* DEPRECATED *. Please use getField([Record], “AVC”) in order to retrieve the individual Address Verification Code for each result record. (This member function returns the accuracy code for this process result.)

 
 

lqtMatchInfo

Public Attributes

string type

This string value gives the type of data item described by this record.

size_t start

This numeric value gives the start character location of the data item described by this record.

size_t end

This numeric value gives the end character location of the data item described by this record.

string info

This string value gives debug tool information regarding the steps the server took to conclude that this record interpretation is correct. This is primarily intended for debugging purposes.

int confidence

This numeric value gives the confidence associated with the servers choice of this interpretation. This is primarily intended for debugging purposes.

int matchscore

This numeric value between 0 and 100 giving the similarity between the identified input data, and the output data in this record. A result of 100 means that no changes other than additions, alias, casing, or diacritic changes have been made to the input data. A result of 0 means there is no similarity between the input data identified as the specified data item, and the output data provided.