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

2 * This Original Work is copyright of 51 Degrees Mobile Experts Limited.

4 * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.

5 *

6 * This Original Work is licensed under the European Union Public Licence

7 * (EUPL) v.1.2 and is subject to its terms as set out below.

8 *

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

10 * one at https://opensource.org/licenses/EUPL-1.2.

11 *

12 * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be

13 * amended by the European Commission) shall be deemed incompatible for

14 * the purposes of the Work and the provisions of the compatibility

15 * clause in Article 5 of the EUPL shall not apply.

16 *

17 * If using the Work as, or as part of, a network application, by

18 * including the attribution notice(s) required under Article 5 of the EUPL

19 * in the end user terms of the application under an appropriate heading,

20 * such notice(s) shall fulfill the requirements of that article.

21 * ********************************************************************* */

22

23 #ifndef FIFTYONE_DEGREES_RESULTS_INCLUDED

24 #define FIFTYONE_DEGREES_RESULTS_INCLUDED

25

48 #include "data.h"

49 #include "status.h"

50 #include "dataset.h"

51 #include "common.h"

52

56 typedef enum e_fiftyone_degrees_results_no_value_reason {

57 FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_DIFFERENCE,

61 FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_NO_MATCHED_NODES,

65 FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_INVALID_PROPERTY,

70 FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_NO_RESULT_FOR_PROPERTY,

77 FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_NO_RESULTS,

80 FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_TOO_MANY_VALUES,

84 FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_NULL_PROFILE,

88 FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_UNKNOWN

89 } fiftyoneDegreesResultsNoValueReason;

90

94 typedef struct fiftyone_degrees_results_base_t {

95 void *dataSet;

96 } fiftyoneDegreesResultsBase;

97

104 EXTERNAL fiftyoneDegreesResultsBase* fiftyoneDegreesResultsInit(

105 fiftyoneDegreesResultsBase *results,

106 void *dataSet);

107

112 #endif

fiftyoneDegreesResultsInit

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

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

FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_NO_MATCHED_NODES

No hash nodes were matched, see the Hash API.

Definition: results.h:61

FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_NULL_PROFILE

The results contain a null profile for the required component.

Definition: results.h:84

FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_TOO_MANY_VALUES

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

Definition: results.h:80

FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_NO_RESULTS

There are no results to get a value from.

Definition: results.h:77

FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_UNKNOWN

None of the above.

Definition: results.h:88

FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_INVALID_PROPERTY

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

Definition: results.h:65

fiftyoneDegreesResultsNoValueReason

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

Definition: results.h:56

FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_DIFFERENCE

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

Definition: results.h:57

fiftyoneDegreesResultsBase::dataSet

void * dataSet

Pointer to the data set associated with the results.

Definition: results.h:95

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:70

fiftyoneDegreesResultsBase

Base results structure which any processing results should extend.

Definition: results.h:94

51Degrees Device Detection C/C++ 4.4

results.h