51Degrees Device Detection C/C++  4.1

A device detection library that is used natively or by 51Degrees products

property.h

1 /* *********************************************************************
2  * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
3  * Copyright 2019 51 Degrees Mobile Experts Limited, 5 Charlotte Close,
4  * Caversham, Reading, Berkshire, United Kingdom RG4 7BY.
5  *
6  * This Original Work is licensed under the European Union Public Licence (EUPL)
7  * 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_PROPERTY_H_INCLUDED
24 #define FIFTYONE_DEGREES_PROPERTY_H_INCLUDED
25 
52 #include <stdint.h>
53 #ifdef _MSC_VER
54 #include <windows.h>
55 #endif
56 #include "data.h"
57 #include "exceptions.h"
58 #include "collection.h"
59 #include "string.h"
60 
61 #ifdef __cplusplus
62 #define EXTERNAL extern "C"
63 #else
64 #define EXTERNAL
65 #endif
66 
70 typedef enum e_fiftyone_degrees_property_value_type {
77 
81 #pragma pack(push, 1)
82 typedef struct property_t {
83  const byte componentIndex;
84  const byte displayOrder;
86  const byte isMandatory;
88  const byte isList;
90  const byte showValues;
91  const byte isObsolete;
93  const byte show;
94  const byte valueType;
95  const uint32_t defaultValueIndex;
97  const uint32_t nameOffset;
99  const uint32_t descriptionOffset;
101  const uint32_t categoryOffset;
103  const uint32_t urlOffset;
105  const uint32_t firstValueIndex;
106  const uint32_t lastValueIndex;
107  const uint32_t mapCount;
108  const uint32_t firstMapIndex;
111 #pragma pack(pop)
112 
125  fiftyoneDegreesCollection *stringsCollection,
126  fiftyoneDegreesProperty *property,
128  fiftyoneDegreesException *exception);
129 
142  fiftyoneDegreesCollection *stringsCollection,
143  fiftyoneDegreesProperty *property,
145  fiftyoneDegreesException *exception);
146 
159  fiftyoneDegreesCollection *stringsCollection,
160  fiftyoneDegreesProperty *property,
162  fiftyoneDegreesException *exception);
163 
176  fiftyoneDegreesCollection *stringsCollection,
177  fiftyoneDegreesProperty *property,
179  fiftyoneDegreesException *exception);
180 
190  fiftyoneDegreesCollection *properties,
191  uint32_t index,
192  fiftyoneDegreesException *exception);
193 
205  fiftyoneDegreesCollection *properties,
206  uint32_t index,
208  fiftyoneDegreesException *exception);
209 
222  fiftyoneDegreesCollection *properties,
223  fiftyoneDegreesCollection *strings,
224  const char *requiredPropertyName,
226  fiftyoneDegreesException *exception);
227 
232 #endif
const byte valueType
The type of value the property represents.
Definition: property.h:94
JavaScript string.
Definition: property.h:75
Used to store a handle to the underlying item that could be used to release the item when it's finish...
Definition: collection.h:309
fiftyoneDegreesString * fiftyoneDegreesPropertyGetCategory(fiftyoneDegreesCollection *stringsCollection, fiftyoneDegreesProperty *property, fiftyoneDegreesCollectionItem *item, fiftyoneDegreesException *exception)
Returns the string category of the property using the item provided.
Double.
Definition: property.h:73
const byte componentIndex
Index of the component.
Definition: property.h:83
const byte isList
True if the property is a list can return multiple values.
Definition: property.h:88
String.
Definition: property.h:71
fiftyoneDegreesString * fiftyoneDegreesPropertyGetDescription(fiftyoneDegreesCollection *stringsCollection, fiftyoneDegreesProperty *property, fiftyoneDegreesCollectionItem *item, fiftyoneDegreesException *exception)
Returns the string description of the property using the item provided.
const uint32_t urlOffset
The offset in the strings structure to the property URL.
Definition: property.h:103
const uint32_t firstValueIndex
Index of the first possible value.
Definition: property.h:105
String structure containing its value and size.
Definition: string.h:87
fiftyoneDegreesPropertyValueType
Enum of property types.
Definition: property.h:70
const byte show
True if the property should be shown in GUIs.
Definition: property.h:93
const uint32_t firstMapIndex
The first index in the list of maps the property is associated with.
Definition: property.h:108
Integer.
Definition: property.h:72
const uint32_t descriptionOffset
The offset in the strings structure to the property description.
Definition: property.h:99
const uint32_t nameOffset
The offset in the strings structure to the property name.
Definition: property.h:97
const byte isObsolete
True if the property is obsolete and will be removed from future data sets.
Definition: property.h:91
fiftyoneDegreesProperty * fiftyoneDegreesPropertyGet(fiftyoneDegreesCollection *properties, uint32_t index, fiftyoneDegreesCollectionItem *item, fiftyoneDegreesException *exception)
Gets the property at the requested index from the properties collection provided.
Property structure containing all the meta data relating to a property.
Definition: property.h:82
fiftyoneDegreesString * fiftyoneDegreesPropertyGetName(fiftyoneDegreesCollection *stringsCollection, fiftyoneDegreesProperty *property, fiftyoneDegreesCollectionItem *item, fiftyoneDegreesException *exception)
Returns the string name of the property using the item provided.
const byte isMandatory
True if the property is mandatory and must be provided.
Definition: property.h:86
const byte showValues
True if the values should be shown in GUIs.
Definition: property.h:90
fiftyoneDegreesString * fiftyoneDegreesPropertyGetUrl(fiftyoneDegreesCollection *stringsCollection, fiftyoneDegreesProperty *property, fiftyoneDegreesCollectionItem *item, fiftyoneDegreesException *exception)
Returns the string URL of the property using the item provided.
const uint32_t categoryOffset
The offset in the strings structure to the property category.
Definition: property.h:101
const uint32_t defaultValueIndex
The default value index for the property.
Definition: property.h:95
Structure used to represent a 51Degrees exception and passed into methods that might generate excepti...
Definition: exceptions.h:116
fiftyoneDegreesProperty * fiftyoneDegreesPropertyGetByName(fiftyoneDegreesCollection *properties, fiftyoneDegreesCollection *strings, const char *requiredPropertyName, fiftyoneDegreesCollectionItem *item, fiftyoneDegreesException *exception)
Gets the property with the requested name from the properties collection provided.
byte fiftyoneDegreesPropertyGetValueType(fiftyoneDegreesCollection *properties, uint32_t index, fiftyoneDegreesException *exception)
Gets the value type for the property at the index in the collection.
Boolean.
Definition: property.h:74
const uint32_t lastValueIndex
Index of the last possible value.
Definition: property.h:106
const uint32_t mapCount
Number of maps the property is associated with.
Definition: property.h:107
const byte displayOrder
The order the property should be displayed in relative to other properties.
Definition: property.h:84
All the shared methods and fields required by file, memory and cached collections.
Definition: collection.h:407