Configuration node definition macros

Overview

Macros to define configuration nodes supported by te_agents. More…

// macros

#define RCF_PCH_CFG_NODE_COLLECTION(_name, _subid, _son, _brother, _f_add, _f_del, _f_list, _f_commit)
#define RCF_PCH_CFG_NODE_NA(_name, _subid, _son, _brother)
#define RCF_PCH_CFG_NODE_NA_COMMIT(_name, _subid, _son, _brother, _f_commit)
#define RCF_PCH_CFG_NODE_RO(_name, _subid, _son, _brother, _f_get)
#define RCF_PCH_CFG_NODE_RO_COLLECTION(_name, _subid, _son, _brother, _f_get, _f_list)
#define RCF_PCH_CFG_NODE_RW(_name, _subid, _son, _brother, _f_get, _f_set)
#define RCF_PCH_CFG_NODE_RWC(_name, _subid, _son, _brother, _f_get, _f_set, _commit)
#define RCF_PCH_CFG_NODE_RWC_COLLECTION(_name, _subid, _son, _brother, _f_get, _f_set, _f_add, _f_del, _f_list, _commit)
#define RCF_PCH_CFG_NODE_RW_COLLECTION(_name, _subid, _son, _brother, _f_get, _f_set, _f_add, _f_del, _f_list, _f_commit)
#define RCF_PCH_CFG_NODE_RW_COLLECTION_WITH_SUBST(_name, _subid, _son, _brother, _f_get, _f_set, _f_add, _f_del, _f_list, _f_commit, _subst)
#define RCF_PCH_CFG_NODE_RW_WITH_SUBST(_name, _subid, _son, _brother, _f_get, _f_set, _subst)

Detailed Documentation

Macros to define configuration nodes supported by te_agents. Read more information on how to support new nodes at te_agents_conf.

Macros

#define RCF_PCH_CFG_NODE_COLLECTION(_name, _subid, _son, _brother, _f_add, _f_del, _f_list, _f_commit)

Define node collection.

Parameters:

_name	node name (rcf_pch_cfg_object)
_subid	subidentifier name (const char *)
_son	pointer to the first son node
_brother	pointer to the next brother node
_f_add	add accessor
_f_del	delete accessor
_f_list	list accessor
_f_commit	commit function

#define RCF_PCH_CFG_NODE_NA(_name, _subid, _son, _brother)

Define non-accessible configuration tree node.

Parameters:

_name	node name (rcf_pch_cfg_object)
_subid	subidentifier name (const char *)
_son	pointer to the first son node
_brother	pointer to the next brother node

#define RCF_PCH_CFG_NODE_NA_COMMIT(_name, _subid, _son, _brother, _f_commit)

Define non-accessible configuration tree node with commit capability.

Parameters:

_name	node name (rcf_pch_cfg_object)
_subid	subidentifier name (const char *)
_son	pointer to the first son node
_brother	pointer to the next brother node
_f_commit	commit function

#define RCF_PCH_CFG_NODE_RO(_name, _subid, _son, _brother, _f_get)

Define read-only singleton.

Parameters:

_name	node name (rcf_pch_cfg_object)
_subid	subidentifier name (const char *)
_son	pointer to the first son node
_brother	pointer to the next brother node
_f_get	get accessor

#define RCF_PCH_CFG_NODE_RO_COLLECTION(_name, _subid, _son, _brother, _f_get, _f_list)

Define read-only node collection.

Parameters:

_name	node name (rcf_pch_cfg_object)
_subid	subidentifier name (const char *)
_son	pointer to the first son node
_brother	pointer to the next brother node
_f_get	add accessor
_f_list	list accessor

#define RCF_PCH_CFG_NODE_RW(_name, _subid, _son, _brother, _f_get, _f_set)

Define read-write singleton w/o commit support.

Parameters:

_name	node name (rcf_pch_cfg_object)
_subid	subidentifier name (const char *)
_son	pointer to the first son node
_brother	pointer to the next brother node
_f_get	get accessor
_f_set	set accessor

#define RCF_PCH_CFG_NODE_RWC(_name, _subid, _son, _brother, _f_get, _f_set, _commit)

Define read-write singleton with on-parent commit support.

Parameters:

_name	node name (rcf_pch_cfg_object)
_subid	subidentifier name (const char *)
_son	pointer to the first son node
_brother	pointer to the next brother node
_f_get	get accessor
_f_set	set accessor
_commit	pointer to parent with commit function

#define RCF_PCH_CFG_NODE_RWC_COLLECTION(_name, _subid, _son, _brother, _f_get, _f_set, _f_add, _f_del, _f_list, _commit)

Define node collection that can be set. Unlike RCF_PCH_CFG_NODE_RW_COLLECTION(), this macro allows to specify a parent with commit function instead of commit function for the current node.

Parameters:

_name	name of the declared node variable
_subid	subidentifier name (const char *)
_son	pointer to the first son node
_brother	pointer to the next brother node
_f_get	get accessor
_f_set	set accessor
_f_add	add accessor
_f_del	delete accessor
_f_list	list accessor
_commit	parent with commit function

#define RCF_PCH_CFG_NODE_RW_COLLECTION(_name, _subid, _son, _brother, _f_get, _f_set, _f_add, _f_del, _f_list, _f_commit)

Define node collection that can be set

Parameters:

_name	node name (rcf_pch_cfg_object)
_subid	subidentifier name (const char *)
_son	pointer to the first son node
_brother	pointer to the next brother node
_f_get	get accessor
_f_set	set accessor
_f_add	add accessor
_f_del	delete accessor
_f_list	list accessor
_f_commit	commit function

#define RCF_PCH_CFG_NODE_RW_COLLECTION_WITH_SUBST(_name, _subid, _son, _brother, _f_get, _f_set, _f_add, _f_del, _f_list, _f_commit, _subst)

Define node collection that can be set with an array of substitutions

Parameters:

_name	node name (rcf_pch_cfg_object)
_subid	subidentifier name (const char *)
_son	pointer to the first son node
_brother	pointer to the next brother node
_f_add	add accessor
_f_del	delete accessor
_f_list	list accessor
_f_commit	commit function
_subst	array of substitutions (rcf_pch_cfg_substitution)

#define RCF_PCH_CFG_NODE_RW_WITH_SUBST(_name, _subid, _son, _brother, _f_get, _f_set, _subst)

Define read-write singleton w/o commit support and with an array of substitutions.

Parameters:

_name	node name (rcf_pch_cfg_object)
_subid	subidentifier name (const char *)
_son	pointer to the first son node
_brother	pointer to the next brother node
_f_get	get accessor
_f_set	set accessor
_subst	array of substitutions (rcf_pch_cfg_substitution)