Signal groups

Access signal groups. More...

KvaDbStatus kvaDbGetFirstSignalGroup (KvaDbMessageHnd mh, KvaDbSignalGroupHnd *sgh)
 
KvaDbStatus kvaDbGetNextSignalGroup (KvaDbMessageHnd mh, KvaDbSignalGroupHnd *sgh)
 
KvaDbStatus kvaDbGetSignalGroupName (KvaDbSignalGroupHnd sgh, char *buf, size_t *len)
 
KvaDbStatus kvaDbGetSignalGroupSize (KvaDbSignalGroupHnd sgh, size_t *out)
 
KvaDbStatus kvaDbIndexSignalGroup (KvaDbSignalGroupHnd sgh, size_t i, KvaDbSignalHnd *out)
 

Detailed Description

Access signal groups.

Function Documentation

◆ kvaDbGetFirstSignalGroup()

KvaDbStatus kvaDbGetFirstSignalGroup ( KvaDbMessageHnd  mh,
KvaDbSignalGroupHnd sgh 
)

Get the first signal group of a message.

Parameters
mhA message handle.
[out]sghA handle to the first signal group.
Returns
kvaDbOK (zero) if success
kvaDbErr_xxx (negative) if failure
See also
kvaDbGetNextSignalGroup()

◆ kvaDbGetNextSignalGroup()

KvaDbStatus kvaDbGetNextSignalGroup ( KvaDbMessageHnd  mh,
KvaDbSignalGroupHnd sgh 
)

Get the next signal group of a message.

Should be called after kvaDbGetFirstSignalGroup(). The order in which signal groups are returned is unspecified.

Parameters
mhA message handle.
[in,out]sghA handle to the current, and afterward, next, signal group.
Returns
kvaDbOK (zero) if success
kvaDbErr_xxx (negative) if failure
See also
kvaDbGetFirstSignalGroup

◆ kvaDbGetSignalGroupName()

KvaDbStatus kvaDbGetSignalGroupName ( KvaDbSignalGroupHnd  sgh,
char *  buf,
size_t *  len 
)

Get the name of a signal group as a null-terminated string.

A truncated string will be returned if buf is too small and status will be kvaDbOK. The actual byte size, including null-terminator, will be stored to *len.

Parameters
sghA signal group handle.
[out]bufThe signal group name.
[in,out]lenThe length of the buffer that will hold the signal group name.
Returns
kvaDbOK (zero) if success
kvaDbErr_xxx (negative) if failure

◆ kvaDbGetSignalGroupSize()

KvaDbStatus kvaDbGetSignalGroupSize ( KvaDbSignalGroupHnd  sgh,
size_t *  out 
)

Get the number of signals in the signal group sgh.

Parameters
sghA signal group handle.
[out]outThe signal group cardinality.
Returns
kvaDbOK (zero) if success
kvaDbErr_xxx (negative) if failure

◆ kvaDbIndexSignalGroup()

KvaDbStatus kvaDbIndexSignalGroup ( KvaDbSignalGroupHnd  sgh,
size_t  i,
KvaDbSignalHnd out 
)

Get the signal group signal at index i.

Indices are stable only in the absense of insertions/removals. Valid values of i are below the result of kvaDbGetSignalGroupSize.

Parameters
sghA signal group handle.
iThe signal index.
[out]outThe resulting signal.
Returns
kvaDbOK (zero) if success
kvaDbErr_xxx (negative) if failure