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

Description

Represents constraint and validity information for a double setting.

Inheritance diagram for kInfo64f:
Inheritance graph

Public Member Functions

kStatus kInfo64f_Init (kInfo64f *info, k64f min, k64f max)
 Initializes a kInfo64f structure to default values. More...
 
kStatus kInfo64f_Validate (kInfo64f *info, k64f value)
 Validates an input value against min/max values. More...
 

Public Attributes

k64f absoluteMax
 Maximum valid value under any circumstances.
 
k64f absoluteMin
 Minimum valid value under any circumstances.
 
k64f accurate
 Accurate representation of current value, typically used for display in meaningful units (optional).
 
k64f granularity
 Value step size (provided only if available; otherwise, k64F_NULL).
 
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).
 
k64f next
 Next valid value (provided only if available; otherwise, k64F_NULL).
 
k64f previous
 Previous valid value (provided only if available; otherwise, k64F_NULL).
 
k64f relativeMax
 Maximum valid value, limited by current values of other (more dominant) settings.
 
k64f 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: