FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kInfo32u Struct Reference

Description

Represents constraint and validity information for a 32-bit unsigned integer setting.

Inheritance diagram for kInfo32u:
Inheritance graph

Public Member Functions

kStatus kInfo32s_AppendErrors (const kInfo32s *info, kArrayList list, const kChar *source, const kChar *field, k32s value)
 Appends violation descriptions to the given list. More...
 
k32u kInfo32u_Adjust (kInfo32u *info, k32u value, kAdjust style)
 Adjusts the specified value based on min/max/granularity constaints. More...
 
kStatus kInfo32u_AppendErrors (const kInfo32u *info, kArrayList list, const kChar *source, const kChar *field, k32u value)
 Appends violation descriptions to the given list. More...
 
kStatus kInfo32u_Init (kInfo32u *info, k32u min, k32u max, k32u granularity)
 Initializes a kInfo32u structure to default values. More...
 
kStatus kInfo32u_Validate (kInfo32u *info, k32u value)
 Validates an input value against min/max/granularity values. More...
 
kStatus kInfo64f_AppendErrors (const kInfo64f *info, kArrayList list, const kChar *source, const kChar *field, k64f value)
 Appends violation descriptions to the given list. More...
 
kStatus kInfo64s_AppendErrors (const kInfo64s *info, kArrayList list, const kChar *source, const kChar *field, k64s value)
 Appends violation descriptions to the given list. More...
 
kStatus kInfo64u_AppendErrors (const kInfo64u *info, kArrayList list, const kChar *source, const kChar *field, k64u value)
 Appends violation descriptions to the given list. More...
 
kStatus kInfoBits_AppendErrors (const kInfoBits *info, kArrayList list, const kChar *source, const kChar *field, k32u value)
 Appends violation descriptions to the given list. More...
 
kStatus kInfoBool_AppendErrors (const kInfoBool *info, kArrayList list, const kChar *source, const kChar *field, kBool value)
 Appends violation descriptions to the given list. More...
 
kStatus kInfoSize_AppendErrors (const kInfoSize *info, kArrayList list, const kChar *source, const kChar *field, kSize value)
 Appends violation descriptions to the given list. More...
 

Public Attributes

k32u absoluteMax
 Maximum valid value under any circumstances.
 
k32u absoluteMin
 Minimum valid value under any circumstances.
 
k64f accurate
 Accurate representation of current value, typically used for display in meaningful units (optional).
 
k32u granularity
 Value must be evenly divisible by this number.
 
kBool isGrouped
 Value is constrained to be the same as its peers within a group. (e.g. periods of states belonging to a camera might be constrained to be equal).
 
kBool isReadOnly
 Value is read-only (cannot be modified).
 
k32u relativeMax
 Maximum valid value, limited by current values of other (more dominant) settings.
 
k32u relativeMin
 Minimum valid value, limited by current values of other (more dominant) settings.
 
kViolation violations
 Constraints violated by the current value.
 

The documentation for this struct was generated from the following file: