C-Types and Structures for Database Objects

These Types are used as Parameters in Calls to the Database-API and should be used in Database Objects if possible. More...

Data Structures
struct	kogmo_rtdb_obj_info_t
	Data Block that contains Object-Metadata. The Metadata of an Object should not (or only very slowly) change during its livetime. More...
Defines
#define	KOGMO_RTDB_DEFAULT_HISTORY_INTERVAL   10.0
	see kogmo_rtdb_obj_info_t
#define	KOGMO_RTDB_DEFAULT_MAX_CYCLETIME   0.030
	see kogmo_rtdb_obj_info_t
#define	KOGMO_RTDB_KEEP_DELETED_INTERVAL   0.25
	how long to keep deleted objects if history is shorter (the manager has an additional purge interval of 0.25 sec)
#define	KOGMO_RTDB_OBJMETA_NAME_MAXLEN   32
	maximum size for object names in kogmo_rtdb_obj_info_t (including terminating null-byte)
#define	KOGMO_RTDB_OBJIDLIST_MAX   1000
	see
Typedefs
typedef int32_t	kogmo_rtdb_objid_t
	ID for Objects within the Database that are unique during database runtime. IDs are not unique between database restarts (so far).
typedef int32_t	kogmo_rtdb_objtype_t
	Type-Identifier for Objects within the Database that is unique forever. This is to avoid missinterpretation when using old data sets.
typedef int32_t	kogmo_rtdb_objsize_t
	Size-Specification for Objects within the Database.
typedef char	kogmo_rtdb_objname_t [KOGMO_RTDB_OBJMETA_NAME_MAXLEN]
	Type for a Object-Name (see kogmo_rtdb_obj_info_t).
typedef kogmo_rtdb_objid_t	kogmo_rtdb_objid_list_t [KOGMO_RTDB_OBJIDLIST_MAX+1]
	Type for a pre-allocated Array to receive the results of kogmo_rtdb_obj_readdatameta(). It is terminated by a 0-element.

---

Detailed Description

These Types are used as Parameters in Calls to the Database-API and should be used in Database Objects if possible.

---

Define Documentation

#define KOGMO_RTDB_DEFAULT_HISTORY_INTERVAL   10.0

see kogmo_rtdb_obj_info_t

Definition at line 96 of file kogmo_rtdb_types.h.

#define KOGMO_RTDB_DEFAULT_MAX_CYCLETIME   0.030

see kogmo_rtdb_obj_info_t

Definition at line 98 of file kogmo_rtdb_types.h.

#define KOGMO_RTDB_KEEP_DELETED_INTERVAL   0.25

how long to keep deleted objects if history is shorter (the manager has an additional purge interval of 0.25 sec)

Definition at line 101 of file kogmo_rtdb_types.h.

#define KOGMO_RTDB_OBJIDLIST_MAX   1000

see

Definition at line 112 of file kogmo_rtdb_types.h.

#define KOGMO_RTDB_OBJMETA_NAME_MAXLEN   32

maximum size for object names in kogmo_rtdb_obj_info_t (including terminating null-byte)

Definition at line 105 of file kogmo_rtdb_types.h.

---

Typedef Documentation

typedef kogmo_rtdb_objid_t kogmo_rtdb_objid_list_t[KOGMO_RTDB_OBJIDLIST_MAX+1]

Type for a pre-allocated Array to receive the results of kogmo_rtdb_obj_readdatameta(). It is terminated by a 0-element.

Definition at line 117 of file kogmo_rtdb_types.h.

typedef int32_t kogmo_rtdb_objid_t

ID for Objects within the Database that are unique during database runtime. IDs are not unique between database restarts (so far).

Please note:

• This could become int64_t some day
• So please use this type and print it with

   printf("%lli",(long long int)oid) 
  

• 0 is always invalid and may represent unused entries or "not found" as return value
• <0 represents errors as return value

TODO:

• Decide what to for Object-Interchange between Vehicles:
  • Define separate ID-Ranges
  • When synchronizing (and security checking!) foreign objects, use ID mapping

Definition at line 54 of file kogmo_rtdb_types.h.

typedef char kogmo_rtdb_objname_t[KOGMO_RTDB_OBJMETA_NAME_MAXLEN]

Type for a Object-Name (see kogmo_rtdb_obj_info_t).

Definition at line 109 of file kogmo_rtdb_types.h.

typedef int32_t kogmo_rtdb_objsize_t

Size-Specification for Objects within the Database.

Please note:

• This could become int64_t some day
• So please use this type and print it with

   printf("%lli",(long long int)osize) 
  

• <0 represents errors as return value

TODO:

• use consequently

Definition at line 90 of file kogmo_rtdb_types.h.

typedef int32_t kogmo_rtdb_objtype_t

Type-Identifier for Objects within the Database that is unique forever. This is to avoid missinterpretation when using old data sets.

Please note:

• This could become int64_t some day
• So please use this type and print it with

   printf("%lli",(long long int)otype) 
  

• 0 is always invalid and may represent unused entries or "not found" as return value. As search parameter it means "any type".
• 1 is "unknown object" (only basedata ist specified, length of additional data is free
• <0 represents errors as return value

TODO:

• Define
• Define Ranges for separate Sub-Projects
• Define Version-Information

Definition at line 76 of file kogmo_rtdb_types.h.