annotate audioDBws.h @ 171:bb934f91d85c powertable

Web services interface to the powertable functionality.

* Implemented as a completely new SOAP method, called sequenceQuery
* lightly tested with http://doc.gold.ac.uk/~mas01cr/poweradb.php

(lacuna: need to pass relative-threshold and absolute-threshold always,
even when they don't make sense.)

Several uglinesses in the code, some of which will be resolved once all
the various branches are merged into the trunk.

// audioDBws.h -- web services interface to audioDB
//
//FIXME: this hard-coding of the service location might be right for
//its internal use at Goldsmiths (for now) but really isn't in
//general.  Find a way to bind this later (at install time?  Or maybe
//just require that the installer edit the resulting wsdl file?)
//
//gsoap adb service location: http://gibbons.doc.gold.ac.uk:20703/

typedef int xsd__int;
typedef double xsd__double;
typedef char* xsd__string;

// Supports result lists of arbitrary length
struct adb__queryResult{
  int __sizeRlist;
  char **Rlist; // Maximum size of result list
  int __sizeDist;  
  double *Dist;
  int __sizeQpos;  
  unsigned int *Qpos;
  int __sizeSpos;
  unsigned int *Spos;
};

struct adb__statusResult {
  unsigned numFiles;
  unsigned dim;
  unsigned length;
  unsigned dudCount;
  unsigned nullCount;
  unsigned flags;
};

struct adb__statusResponse {
  struct adb__statusResult result;
};

struct adb__queryResponse {
  struct adb__queryResult result;
};

// Print the status of an existing adb database
int adb__status(xsd__string dbName, struct adb__statusResponse &adbStatusResponse);

// Query an existing adb database
int adb__query(xsd__string dbName, xsd__string qKey, xsd__string keyList, xsd__string timesFileName, xsd__int qType, xsd__int qPos, xsd__int pointNN, xsd__int segNN, xsd__int segLen, struct adb__queryResponse &adbQueryResponse);

struct adb__sequenceQueryParms {
  xsd__string keyList;
  xsd__string timesFileName;
  xsd__string powerFileName;
  xsd__int qPos;
  xsd__int pointNN;
  xsd__int segNN;
  xsd__int segLen;
  xsd__double relative_threshold;
  xsd__double absolute_threshold;
};

// Perform a sequence query
int adb__sequenceQuery(xsd__string dbName, xsd__string qKey, 
		       struct adb__sequenceQueryParms *parms, 
		       struct adb__queryResponse &adbQueryResponse);