1 /* *********************************************************************

2 * This Source Code Form is copyright of 51 Degrees Mobile Experts Limited.

4 * Caversham, Reading, Berkshire, United Kingdom RG4 7BY

5 *

6 * This Source Code Form is subject to the terms of the Mozilla Public

7 * License, v. 2.0.

8 *

9 * If a copy of the MPL was not distributed with this file, You can obtain

10 * one at http://mozilla.org/MPL/2.0/.

11 *

12 * This Source Code Form is "Incompatible With Secondary Licenses", as

13 * defined by the Mozilla Public License, v. 2.0.

14 * ******************************************************************** */

15

16 #ifndef FIFTYONE_DEGREES_RESULTS_INCLUDED

17 #define FIFTYONE_DEGREES_RESULTS_INCLUDED

18

41 #include "data.h"

42 #include "status.h"

43 #include "dataset.h"

44

45 #ifdef __cplusplus

46 #define EXTERNAL extern "C"

47 #else

48 #define EXTERNAL

49 #endif

50

54 typedef enum e_fiftyone_degrees_results_no_value_reason {

55 FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_DIFFERENCE,

59 FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_NO_MATCHED_NODES,

63 FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_INVALID_PROPERTY,

68 FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_NO_RESULT_FOR_PROPERTY,

75 FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_NO_RESULTS,

78 FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_TOO_MANY_VALUES,

82 FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_UNKNOWN

83 } fiftyoneDegreesResultsNoValueReason;

84

88 typedef struct fiftyone_degrees_results_base_t {

89 void *dataSet;

90 } fiftyoneDegreesResultsBase;

91

98 EXTERNAL fiftyoneDegreesResultsBase* fiftyoneDegreesResultsInit(

99 fiftyoneDegreesResultsBase *results,

100 void *dataSet);

101

106 #endif

FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_NO_MATCHED_NODES

No hash nodes were matched, see the Hash API.

Definition: results.h:59

FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_TOO_MANY_VALUES

There are too many values to be expressed as the requested type.

Definition: results.h:78

FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_NO_RESULTS

There are no results to get a value from.

Definition: results.h:75

FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_UNKNOWN

None of the above.

Definition: results.h:82

fiftyoneDegreesResultsInit

EXTERNAL fiftyoneDegreesResultsBase * fiftyoneDegreesResultsInit(fiftyoneDegreesResultsBase *results, void *dataSet)

Initialise a set of results by setting the data set they are associated with.

Definition: results.c:20

FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_INVALID_PROPERTY

The requested property does not exist, or is not a required property.

Definition: results.h:63

fiftyoneDegreesResultsNoValueReason

Enum containing reasons which cause a value to not be present or valid.

Definition: results.h:54

FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_DIFFERENCE

The difference value is higher than the threshold, see the Pattern API.

Definition: results.h:55

fiftyoneDegreesResultsBase::dataSet

void * dataSet

Pointer to the data set associated with the results.

Definition: results.h:89

FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_NO_RESULT_FOR_PROPERTY

There is no result which contains a value for the requested property.

Definition: results.h:68

fiftyoneDegreesResultsBase

Base results structure which any processing results should extend.

Definition: results.h:88

51Degrees Common C/C++ 4.1

results.h