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

Description

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

Inheritance diagram for kInfo64u:
Inheritance graph

Public Member Functions

k64u kInfo64u_Adjust (kInfo64u *info, k64u value, kAdjust style)
 Adjusts the specified value based on min/max/granularity constaints. More...
 
kStatus kInfo64u_Init (kInfo64u *info, k64u min, k64u max, k64u granularity)
 Initializes a kInfo64u structure to default values. More...
 
kStatus kInfo64u_Validate (kInfo64u *info, k64u value)
 Validates an input value against min/max/granularity values. More...
 

Public Attributes

k64u absoluteMax
 Maximum valid value under any circumstances.
 
k64u absoluteMin
 Minimum valid value under any circumstances.
 
k64f accurate
 Accurate representation of current value, typically used for display in meaningful units (optional).
 
k64u 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).
 
k64u relativeMax
 Maximum valid value, limited by current values of other (more dominant) settings.
 
k64u 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: