gimbal_settings.h File Reference

Go to the source code of this file.

Data Structures
struct	GblSettingsClass
struct	GblSettings

Macros
Type System
Type UUID and cast operators
#define	GBL_SETTINGS_TYPE
#define	GBL_SETTINGS(self)
#define	GBL_SETTINGS_CLASS(klass)
#define	GBL_SETTINGS_GET_CLASS(self)

Typedefs
typedef GblEnum	GBL_SETTINGS_STATUS

Enumerations
enum	GBL_SETTINGS_STATUS

Functions
GblType	GblSettings_type (void)
GblSettings *	GblSettings_create (void)
GblSettings *	GblSettings_ref (const GblSettings *pSelf)
GblRefCount	GblSettings_unref (GblSettings *pSelf)
const char *	GblSettings_scope (const GblSettings *pSelf)
const char *	GblSettings_pushScope (GblSettings *pSelf, const char *pPrefix)
void	GblSettings_pushArray (GblSettings *pSelf, const char *pName, size_t size)
const char *	GblSettings_pop (GblSettings *pSelf)
GBL_RESULT	GblSettings_setArrayIndex (GblSettings *pSelf, size_t index)
GBL_RESULT	GblSettings_sync (GblSettings *pSelf)
GBL_RESULT	GblSettings_variant (const GblSettings *pSelf, const char *pKey, GblVariant *pVariant)
GBL_RESULT	GblSettings_toValue (const GblSettings *pSelf, const char *pKey, GblType type,...)
GblType	GblSettings_typeOf (const GblSettings *pSelf, const char *pKey)
GblBool	GblSettings_isNil (const GblSettings *pSelf, const char *pKey)
GblBool	GblSettings_toBool (const GblSettings *pSelf, const char *pKey, GblBool defaultValue)
char	GblSettings_toChar (const GblSettings *pSelf, const char *pKey, char defaultValue)
uint8_t	GblSettings_toUint8 (const GblSettings *pSelf, const char *pKey, uint8_t defaultValue)
uint16_t	GblSettings_toUint16 (const GblSettings *pSelf, const char *pKey, uint16_t defaultValue)
int16_t	GblSettings_toInt16 (const GblSettings *pSelf, const char *pKey, int16_t defaultValue)
uint32_t	GblSettings_toUint32 (const GblSettings *pSelf, const char *pKey, uint32_t defaultValue)
int32_t	GblSettings_toInt32 (const GblSettings *pSelf, const char *pKey, int32_t defaultValue)
uint32_t	GblSettings_toUint64 (const GblSettings *pSelf, const char *pKey, uint32_t defaultValue)
int32_t	GblSettings_toInt64 (const GblSettings *pSelf, const char *pKey, int32_t defaultValue)
size_t	GblSettings_toSize (const GblSettings *pSelf, const char *pkey, size_t defaultValue)
GblEnum	GblSettings_toEnum (const GblSettings *pSelf, const char *pKey, GblEnum defaultValue)
GblFlags	GblSettings_toFlags (const GblSettings *pSelf, const char *pKey, GblFlags defaultValue)
float	GblSettings_toFloat (const GblSettings *pSelf, const char *pKey, float defaultValue)
double	GblSettings_toDouble (const GblSettings *pSelf, const char *pKey, double defaultValue)
void *	GblSettings_toPointer (const GblSettings *pSelf, const char *pKey, void *pDefaultValue)
const char *	GblSettings_toString (const GblSettings *pSelf, const char *pKey, const char *pDefValue)
GblType	GblSettings_toType (const GblSettings *pSelf, const char *pKey, GblType defaultValue)
GBL_RESULT	GblSettings_setNil (GblSettings *pSelf, const char *pKey)
GBL_RESULT	GblSettings_setBool (GblSettings *pSelf, const char *pKey, GblBool value)
GBL_RESULT	GblSettings_setChar (GblSettings *pSelf, const char *pKey, char value)
GBL_RESULT	GblSettings_setUint8 (GblSettings *pSelf, const char *pKey, uint8_t value)
GBL_RESULT	GblSettings_setUint16 (GblSettings *pSelf, const char *pKey, uint16_t value)
GBL_RESULT	GblSettings_setInt16 (GblSettings *pSelf, const char *pKey, int16_t value)
GBL_RESULT	GblSettings_setUint32 (GblSettings *pSelf, const char *pKey, uint32_t value)
GBL_RESULT	GblSettings_setInt32 (GblSettings *pSelf, const char *pKey, int32_t value)
GBL_RESULT	GblSettings_setUint64 (GblSettings *pSelf, const char *pKey, uint64_t value)
GBL_RESULT	GblSettings_setInt64 (GblSettings *pSelf, const char *pKey, int64_t value)
GBL_RESULT	GblSettings_setSize (GblSettings *pSelf, const char *pKey, size_t value)
GBL_RESULT	GblSettings_setEnum (GblSettings *pSelf, const char *pKey, GblType type, GblEnum val)
GBL_RESULT	GblSettings_setFlags (GblSettings *pSelf, const char *pKey, GblType type, GblFlags val)
GBL_RESULT	GblSettings_setFloat (GblSettings *pSelf, const char *pKey, float value)
GBL_RESULT	GblSettings_setDouble (GblSettings *pSelf, const char *pKey, double value)
GBL_RESULT	GblSettings_setPointer (GblSettings *pSelf, const char *pKey, void *pValue)
GBL_RESULT	GblSettings_setString (GblSettings *pSelf, const char *pKey, const char *pValue)
GBL_RESULT	GblSettings_setType (GblSettings *pSelf, const char *pKey, GblType value)

Detailed Description

GblSettings user configuration management and persistence.

Todo:

• marshal values to signals
• array handling
• swap GblHashSet out for GblTreeSet
• rig up properties

Author

2023 Falco Girgis

Copyright

MIT License

Definition in file gimbal_settings.h.

Macro Definition Documentation

GBL_SETTINGS_TYPE

#define GBL_SETTINGS_TYPE

Definition at line 23 of file gimbal_settings.h.

GBL_SETTINGS

#define GBL_SETTINGS

(

self

)

Definition at line 24 of file gimbal_settings.h.

GBL_SETTINGS_CLASS

#define GBL_SETTINGS_CLASS

(

klass

)

Definition at line 25 of file gimbal_settings.h.

GBL_SETTINGS_GET_CLASS

#define GBL_SETTINGS_GET_CLASS

(

self

)

Definition at line 26 of file gimbal_settings.h.

Typedef Documentation

GBL_SETTINGS_STATUS

typedef GblEnum GBL_SETTINGS_STATUS

Definition at line 36 of file gimbal_settings.h.

Enumeration Type Documentation

GBL_SETTINGS_STATUS

enum GBL_SETTINGS_STATUS

Status code for GblSettings state (GblSettings::status)

Enumerator
GBL_SETTINGS_STATUS_OK	OK.
GBL_SETTINGS_STATUS_ERROR_FILE	File Error.
GBL_SETTINGS_STATUS_ERROR_FORMAT	Format Error.

Definition at line 36 of file gimbal_settings.h.

                                      {
    GBL_SETTINGS_STATUS_OK,             //!< OK
    GBL_SETTINGS_STATUS_ERROR_FILE,     //!< File Error
    GBL_SETTINGS_STATUS_ERROR_FORMAT    //!< Format Error
};