Add, delete and modify attributes for messages, signals and nodes.
More...
|
KvaDbStatus | kvaDbGetNodeAttributeIntByName (KvaDbNodeHnd nh, const char *attrName, int *val) |
|
KvaDbStatus | kvaDbGetFirstAttributeDefinition (KvaDbHnd dh, KvaDbAttributeDefHnd *adh) |
|
KvaDbStatus | kvaDbGetAttributeDefinitionByName (KvaDbHnd dh, const char *attrName, KvaDbAttributeDefHnd *adh) |
|
KvaDbStatus | kvaDbGetNextAttributeDefinition (KvaDbAttributeDefHnd adh, KvaDbAttributeDefHnd *nadh) |
|
KvaDbStatus | kvaDbGetAttributeDefinitionType (KvaDbAttributeDefHnd adh, KvaDbAttributeType *at) |
|
KvaDbStatus | kvaDbGetAttributeDefinitionOwner (KvaDbAttributeDefHnd adh, KvaDbAttributeOwner *ao) |
|
KvaDbStatus | kvaDbGetAttributeDefinitionName (KvaDbAttributeDefHnd adh, char *buf, size_t buflen) |
|
KvaDbStatus | kvaDbGetAttributeDefinitionInt (KvaDbAttributeDefHnd adh, int *def, int *min, int *max) |
|
KvaDbStatus | kvaDbGetAttributeDefinitionFloat (KvaDbAttributeDefHnd adh, float *def, float *min, float *max) |
|
KvaDbStatus | kvaDbGetAttributeDefinitionString (KvaDbAttributeDefHnd adh, char *buf, size_t buflen) |
|
KvaDbStatus | kvaDbGetAttributeDefinitionEnumeration (KvaDbAttributeDefHnd adh, int *def) |
|
KvaDbStatus | kvaDbAddAttributeDefinition (KvaDbHnd dh, KvaDbAttributeDefHnd *adh) |
|
KvaDbStatus | kvaDbSetAttributeDefinitionName (KvaDbAttributeDefHnd adh, const char *adName) |
|
KvaDbStatus | kvaDbSetAttributeDefinitionType (KvaDbAttributeDefHnd adh, KvaDbAttributeType adType) |
|
KvaDbStatus | kvaDbSetAttributeDefinitionOwner (KvaDbAttributeDefHnd adh, KvaDbAttributeOwner adOwner) |
|
KvaDbStatus | kvaDbAddAttributeDefinitionEnum (KvaDbAttributeDefHnd adh, const char *eName, int eValue) |
|
KvaDbStatus | kvaDbGetAttributeDefinitionEnumValueByName (KvaDbAttributeDefHnd adh, const char *eName, int *eValue) |
|
KvaDbStatus | kvaDbGetAttributeDefinitionEnumNameByValue (KvaDbAttributeDefHnd adh, int eValue, char *buf, size_t *buflen) |
|
KvaDbStatus | kvaDbSetAttributeDefinitionEnumDefault (KvaDbAttributeDefHnd adh, int dValue) |
|
KvaDbStatus | kvaDbSetAttributeDefinitionInt (KvaDbAttributeDefHnd adh, int def, int min, int max) |
|
KvaDbStatus | kvaDbSetAttributeDefinitionFloat (KvaDbAttributeDefHnd adh, float def, float min, float max) |
|
KvaDbStatus | kvaDbSetAttributeDefinitionString (KvaDbAttributeDefHnd adh, const char *buf) |
|
KvaDbStatus | kvaDbAddMsgAttribute (KvaDbMessageHnd mh, KvaDbAttributeDefHnd adh, KvaDbAttributeHnd *ah) |
|
KvaDbStatus | kvaDbDeleteMsgAttribute (KvaDbMessageHnd mh, KvaDbAttributeHnd ah) |
|
KvaDbStatus | kvaDbAddSignalAttribute (KvaDbSignalHnd sh, KvaDbAttributeDefHnd adh, KvaDbAttributeHnd *ah) |
|
KvaDbStatus | kvaDbDeleteSignalAttribute (KvaDbSignalHnd sh, KvaDbAttributeHnd ah) |
|
KvaDbStatus | kvaDbAddNodeAttribute (KvaDbNodeHnd nh, KvaDbAttributeDefHnd adh, KvaDbAttributeHnd *ah) |
|
KvaDbStatus | kvaDbDeleteNodeAttribute (KvaDbNodeHnd nh, KvaDbAttributeHnd ah) |
|
KvaDbStatus | kvaDbGetFirstMsgAttribute (KvaDbMessageHnd mh, KvaDbAttributeHnd *ah) |
|
KvaDbStatus | kvaDbGetMsgAttributeByName (KvaDbMessageHnd mh, const char *attrName, KvaDbAttributeHnd *ah) |
|
KvaDbStatus | kvaDbGetFirstSignalAttribute (KvaDbSignalHnd sh, KvaDbAttributeHnd *ah) |
|
KvaDbStatus | kvaDbGetSignalAttributeByName (KvaDbSignalHnd sh, const char *attrName, KvaDbAttributeHnd *ah) |
|
KvaDbStatus | kvaDbGetFirstNodeAttribute (KvaDbNodeHnd nh, KvaDbAttributeHnd *ah) |
|
KvaDbStatus | kvaDbGetNodeAttributeByName (KvaDbNodeHnd nh, const char *attrName, KvaDbAttributeHnd *ah) |
|
KvaDbStatus | kvaDbGetNextAttribute (KvaDbAttributeHnd ah, KvaDbAttributeHnd *nah) |
|
KvaDbStatus | kvaDbGetAttributeType (KvaDbAttributeHnd ah, KvaDbAttributeType *at) |
|
KvaDbStatus | kvaDbGetAttributeName (KvaDbAttributeHnd ah, char *buf, size_t buflen) |
|
KvaDbStatus | kvaDbSetAttributeValueInt (KvaDbAttributeHnd ah, int val) |
|
KvaDbStatus | kvaDbGetAttributeValueInt (KvaDbAttributeHnd ah, int *val) |
|
KvaDbStatus | kvaDbSetAttributeValueFloat (KvaDbAttributeHnd ah, float val) |
|
KvaDbStatus | kvaDbGetAttributeValueFloat (KvaDbAttributeHnd ah, float *val) |
|
KvaDbStatus | kvaDbSetAttributeValueString (KvaDbAttributeHnd ah, const char *buf, int buflen) |
|
KvaDbStatus | kvaDbGetAttributeValueString (KvaDbAttributeHnd ah, char *buf, size_t buflen) |
|
KvaDbStatus | kvaDbSetAttributeValueEnumeration (KvaDbAttributeHnd ah, int val) |
|
KvaDbStatus | kvaDbGetAttributeValueEnumeration (KvaDbAttributeHnd ah, int *val) |
|
Add, delete and modify attributes for messages, signals and nodes.
◆ kvaDbAddAttributeDefinition()
Add a new attribute definition to a database.
- Parameters
-
[in] | dh | A handle to a database |
[out] | adh | A handle to a new attribute definition |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
◆ kvaDbAddAttributeDefinitionEnum()
Add a enumeration value to an attribute definition of enumeration type. If enumeration entry with specified value already exists, it will be overwritten. Enumeration entries assume to start with value zero, which is then incremented by one for consequent entries.
- Note
- In case eValue is out of order, i.e. exceeds maximum value by more than one, or was not started at zero, additional dummy entries with name "reserved" will be added to enumeration.
- Parameters
-
[in] | adh | A handle to a attribute definition |
[in] | eName | The name of the enumeration entry |
[in] | eValue | The value of the enumeration entry |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
◆ kvaDbAddMsgAttribute()
Add an attribute to a message.
- Parameters
-
[in] | mh | A handle to a message |
[in] | adh | A handle to an attribute definition |
[out] | ah | An attribute handle |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
- See also
- kvaDbDeleteMsgAttribute()
◆ kvaDbAddNodeAttribute()
Add an attribute to a node.
- Parameters
-
[in] | nh | A handle to a node |
[in] | adh | A handle to an attribute definition |
[out] | ah | An attribute handle |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
- See also
- kvaDbDeleteNodeAttribute()
◆ kvaDbAddSignalAttribute()
Add an attribute to a signal.
- Parameters
-
[in] | sh | A handle to a signal |
[in] | adh | A handle to an attribute definition |
[out] | ah | An attribute handle |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
- See also
- kvaDbDeleteSignalAttribute()
◆ kvaDbDeleteMsgAttribute()
◆ kvaDbDeleteNodeAttribute()
◆ kvaDbDeleteSignalAttribute()
◆ kvaDbGetAttributeDefinitionByName()
Get a handle to an attribute definition with specified name.
- Parameters
-
[in] | dh | A handle to a database |
[in] | attrName | The attribute name to search for |
[out] | adh | An attribute definition handle |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
◆ kvaDbGetAttributeDefinitionEnumeration()
Get default value for an attribute definition of type enumeration.
- Parameters
-
[in] | adh | A handle to an attribute definition |
[out] | def | The default value of the attribute definition |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
◆ kvaDbGetAttributeDefinitionEnumNameByValue()
Get name of an enumeration entry by its value in attribute definition. Name is written to a buffer provided by user. If buffer size is insufficient to fit enumeration name, buffer size parameter will contain required buffer size.
- Parameters
-
[in] | adh | A handle to a attribute definition |
[in] | eValue | The value of the enumeration entry |
[out] | buf | Buffer to receive enumeration name |
[out] | buflen | Buffer size in bytes |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
◆ kvaDbGetAttributeDefinitionEnumValueByName()
Get value of an enumeration entry by its name in attribute definition.
- Note
- If there are several entries with same name, the minimum value of the entries with the name eName is returned.
- Parameters
-
[in] | adh | A handle to a attribute definition |
[in] | eName | The name of the enumeration entry |
[out] | eValue | The value of the enumeration entry |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
◆ kvaDbGetAttributeDefinitionFloat()
Get limits and default value for an attribute definition of type float.
- Parameters
-
[in] | adh | A handle to an attribute definition |
[out] | def | The default value of the attribute definition |
[out] | min | The min value of the attribute definition |
[out] | max | The max value of the attribute definition |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
◆ kvaDbGetAttributeDefinitionInt()
Get limits and default value for an attribute definition of type integer.
- Parameters
-
[in] | adh | A handle to an attribute definition |
[out] | def | The default value of the attribute definition |
[out] | min | The min value of the attribute definition |
[out] | max | The max value of the attribute definition |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
◆ kvaDbGetAttributeDefinitionName()
Get the name for an attribute definition.
- Parameters
-
[in] | adh | A handle to an attribute |
[out] | buf | The buffer that will hold the attribute name |
[in] | buflen | The length of the buffer. |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
- See also
- kvaDbGetAttributeDefinitionType()
◆ kvaDbGetAttributeDefinitionOwner()
◆ kvaDbGetAttributeDefinitionString()
Get default value for an attribute definition of type string.
- Parameters
-
[in] | adh | A handle to an attribute definition |
[out] | buf | The buffer that holds the default value of the attribute |
[out] | buflen | The length of the buffer. |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
◆ kvaDbGetAttributeDefinitionType()
◆ kvaDbGetAttributeName()
Get the name for an attribute.
- Parameters
-
[in] | ah | A handle to an attribute |
[out] | buf | The buffer that will hold the attribute name |
[in] | buflen | The length of the buffer. |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
- See also
- kvaDbGetAttributeType()
◆ kvaDbGetAttributeType()
◆ kvaDbGetAttributeValueEnumeration()
◆ kvaDbGetAttributeValueFloat()
◆ kvaDbGetAttributeValueInt()
◆ kvaDbGetAttributeValueString()
Get the value for an attribute of type string.
- Parameters
-
[in] | ah | A handle to an attribute |
[out] | buf | The buffer that holds the attribute value |
[out] | buflen | The length of the buffer. |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
- See also
- kvaDbSetAttributeValueString()
◆ kvaDbGetFirstAttributeDefinition()
◆ kvaDbGetFirstMsgAttribute()
Get a handle to the first attribute for a message.
- Parameters
-
[in] | mh | A handle to a message |
[out] | ah | An attribute definition handle |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
- See also
- kvaDbGetNextAttribute()
◆ kvaDbGetFirstNodeAttribute()
Get a handle to the first attribute for a node.
- Parameters
-
[in] | nh | A handle to a node |
[out] | ah | An attribute definition handle |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
- See also
- kvaDbGetNextAttribute()
◆ kvaDbGetFirstSignalAttribute()
Get a handle to the first attribute for a signal.
- Parameters
-
[in] | sh | A handle to a signal |
[out] | ah | An attribute handle |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
- See also
- kvaDbGetNextAttribute()
◆ kvaDbGetMsgAttributeByName()
Get a handle to an attribute with specified name for a message.
- Parameters
-
[in] | mh | A handle to a message |
[in] | attrName | The attribute name to search for |
[out] | ah | An attribute definition handle |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
◆ kvaDbGetNextAttribute()
◆ kvaDbGetNextAttributeDefinition()
Get a handle to the following attribute defined.
- Parameters
-
[in] | adh | An existing handle to an attribute definition |
[out] | nadh | Handle to next attribute definition |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
- See also
- kvaDbGetFirstAttributeDefinition()
◆ kvaDbGetNodeAttributeByName()
Get a handle to an attribute with specified name for a node.
- Parameters
-
[in] | nh | A handle to a node |
[in] | attrName | The attribute name to search for |
[out] | ah | An attribute definition handle |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
◆ kvaDbGetNodeAttributeIntByName()
◆ kvaDbGetSignalAttributeByName()
Get a handle to an attribute with specified name for a signal.
- Parameters
-
[in] | sh | A handle to a signal |
[in] | attrName | The attribute name to search for |
[out] | ah | An attribute definition handle |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
◆ kvaDbSetAttributeDefinitionEnumDefault()
Set the default enumeration value of an attribute definition of enumeration type.
- Parameters
-
[in] | adh | A handle to a attribute definition |
[in] | dValue | The default value of the enumeration entry |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
◆ kvaDbSetAttributeDefinitionFloat()
Set max, min and default value of an attribute definition of floating point type.
- Parameters
-
[in] | adh | A handle to a attribute definition |
[in] | def | The default value |
[in] | min | The minimum value |
[in] | max | The maximum value |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
◆ kvaDbSetAttributeDefinitionInt()
Set max, min and default value of an attribute definition of integer type.
- Parameters
-
[in] | adh | A handle to a attribute definition |
[in] | def | The default value |
[in] | min | The minimum value |
[in] | max | The maximum value |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
◆ kvaDbSetAttributeDefinitionName()
Set the name of an attribute definition. It is not allowed to have several attribute definitions with same name.
- Parameters
-
[in] | adh | A handle to a attribute definition |
[in] | adName | The name of the attribute definition |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
◆ kvaDbSetAttributeDefinitionOwner()
Set the owner of an attribute definition.
- Parameters
-
[in] | adh | A handle to a attribute definition |
[in] | adOwner | The owner of the attribute definition |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
◆ kvaDbSetAttributeDefinitionString()
Set the default value of an attribute definition of string.
- Parameters
-
[in] | adh | A handle to a attribute definition |
[in] | buf | The default value |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
◆ kvaDbSetAttributeDefinitionType()
Set the type of an attribute definition.
- Parameters
-
[in] | adh | A handle to a attribute definition |
[in] | adType | The type of the attribute definition |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
◆ kvaDbSetAttributeValueEnumeration()
◆ kvaDbSetAttributeValueFloat()
◆ kvaDbSetAttributeValueInt()
◆ kvaDbSetAttributeValueString()
Set the value for an attribute of type string.
- Parameters
-
[in] | ah | A handle to an attribute |
[in] | buf | The buffer that holds the attribute value |
[in] | buflen | The length of the buffer. |
- Returns
- kvaDbOK (zero) if success
-
kvaDbErr_xxx (negative) if failure
- See also
- kvaDbGetAttributeValueString()