property.h
const byte valueType
The type of value the property represents.
Definition: property.h:98
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.
const byte componentIndex
Index of the component.
Definition: property.h:87
const byte isList
True if the property is a list can return multiple values.
Definition: property.h:92
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:107
const uint32_t firstValueIndex
Index of the first possible value.
Definition: property.h:109
fiftyoneDegreesPropertyValueType
Enum of property types.
Definition: property.h:70
const byte show
True if the property should be shown in GUIs.
Definition: property.h:97
const uint32_t firstMapIndex
The first index in the list of maps the property is associated with.
Definition: property.h:112
Single precision floating point value.
Definition: property.h:76
const uint32_t descriptionOffset
The offset in the strings structure to the property description.
Definition: property.h:103
const uint32_t nameOffset
The offset in the strings structure to the property name.
Definition: property.h:101
const byte isObsolete
True if the property is obsolete and will be removed from future data sets.
Definition: property.h:95
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:86
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:90
const byte showValues
True if the values should be shown in GUIs.
Definition: property.h:94
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:105
const uint32_t defaultValueIndex
The default value index for the property.
Definition: property.h:99
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.
const uint32_t lastValueIndex
Index of the last possible value.
Definition: property.h:110
const uint32_t mapCount
Number of maps the property is associated with.
Definition: property.h:111
const byte displayOrder
The order the property should be displayed in relative to other properties.
Definition: property.h:88
All the shared methods and fields required by file, memory and cached collections.
Definition: collection.h:408