:orphan: .. index:: pair: group; Configuration node definition macros .. _doxid-group__rcf__ch__cfg__node__def: Configuration node definition macros ==================================== .. toctree:: :hidden: Overview ~~~~~~~~ Macros to define configuration nodes supported by te_agents. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // macros #define :ref:`RCF_PCH_CFG_NODE_COLLECTION`(_name, _subid, _son, _brother, _f_add, _f_del, _f_list, _f_commit) #define :ref:`RCF_PCH_CFG_NODE_NA`(_name, _subid, _son, _brother) #define :ref:`RCF_PCH_CFG_NODE_NA_COMMIT`(_name, _subid, _son, _brother, _f_commit) #define :ref:`RCF_PCH_CFG_NODE_RO`(_name, _subid, _son, _brother, _f_get) #define :ref:`RCF_PCH_CFG_NODE_RO_COLLECTION`(_name, _subid, _son, _brother, _f_get, _f_list) #define :ref:`RCF_PCH_CFG_NODE_RW`(_name, _subid, _son, _brother, _f_get, _f_set) #define :ref:`RCF_PCH_CFG_NODE_RWC`(_name, _subid, _son, _brother, _f_get, _f_set, _commit) #define :ref:`RCF_PCH_CFG_NODE_RWC_COLLECTION`(_name, _subid, _son, _brother, _f_get, _f_set, _f_add, _f_del, _f_list, _commit) #define :ref:`RCF_PCH_CFG_NODE_RW_COLLECTION`(_name, _subid, _son, _brother, _f_get, _f_set, _f_add, _f_del, _f_list, _f_commit) #define :ref:`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 :ref:`RCF_PCH_CFG_NODE_RW_WITH_SUBST`(_name, _subid, _son, _brother, _f_get, _f_set, _subst) .. _details-group__rcf__ch__cfg__node__def: 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 ------ .. index:: pair: define; RCF_PCH_CFG_NODE_COLLECTION .. _doxid-group__rcf__ch__cfg__node__def_1ga9142487f7b4d62dbb94d741a85241eba: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define RCF_PCH_CFG_NODE_COLLECTION(_name, _subid, _son, _brother, _f_add, _f_del, _f_list, _f_commit) Define node collection. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _name - node name (:ref:`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 .. index:: pair: define; RCF_PCH_CFG_NODE_NA .. _doxid-group__rcf__ch__cfg__node__def_1gafd392c1def068feae045f3d14a505c67: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define RCF_PCH_CFG_NODE_NA(_name, _subid, _son, _brother) Define non-accessible configuration tree node. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _name - node name (:ref:`rcf_pch_cfg_object `) * - _subid - subidentifier name (const char \*) * - _son - pointer to the first son node * - _brother - pointer to the next brother node .. index:: pair: define; RCF_PCH_CFG_NODE_NA_COMMIT .. _doxid-group__rcf__ch__cfg__node__def_1ga81001448c9a65db3fbe1124eb459b0ff: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define RCF_PCH_CFG_NODE_NA_COMMIT(_name, _subid, _son, _brother, _f_commit) Define non-accessible configuration tree node with commit capability. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _name - node name (:ref:`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 .. index:: pair: define; RCF_PCH_CFG_NODE_RO .. _doxid-group__rcf__ch__cfg__node__def_1ga4af715be4c66ba04e6bfe2156262c6d3: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define RCF_PCH_CFG_NODE_RO(_name, _subid, _son, _brother, _f_get) Define read-only singleton. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _name - node name (:ref:`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 .. index:: pair: define; RCF_PCH_CFG_NODE_RO_COLLECTION .. _doxid-group__rcf__ch__cfg__node__def_1ga8661e793204749d057c914e876123e67: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define RCF_PCH_CFG_NODE_RO_COLLECTION(_name, _subid, _son, _brother, _f_get, _f_list) Define read-only node collection. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _name - node name (:ref:`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 .. index:: pair: define; RCF_PCH_CFG_NODE_RW .. _doxid-group__rcf__ch__cfg__node__def_1ga53151cc4e91101a256ab20cbccf7e037: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define RCF_PCH_CFG_NODE_RW(_name, _subid, _son, _brother, _f_get, _f_set) Define read-write singleton w/o commit support. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _name - node name (:ref:`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 .. index:: pair: define; RCF_PCH_CFG_NODE_RWC .. _doxid-group__rcf__ch__cfg__node__def_1ga62bd1bcfb958d8bc6bb88486bdc7477f: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define RCF_PCH_CFG_NODE_RWC(_name, _subid, _son, _brother, _f_get, _f_set, _commit) Define read-write singleton with on-parent commit support. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _name - node name (:ref:`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 .. index:: pair: define; RCF_PCH_CFG_NODE_RWC_COLLECTION .. _doxid-group__rcf__ch__cfg__node__def_1ga501bb34353455860fdf94a418d08fdc6: .. ref-code-block:: cpp :class: doxyrest-title-code-block #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 :ref:`RCF_PCH_CFG_NODE_RW_COLLECTION() `, this macro allows to specify a parent with commit function instead of commit function for the current node. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _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 .. index:: pair: define; RCF_PCH_CFG_NODE_RW_COLLECTION .. _doxid-group__rcf__ch__cfg__node__def_1ga526b5aeab723c3f83bc4f08951145c35: .. ref-code-block:: cpp :class: doxyrest-title-code-block #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 .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _name - node name (:ref:`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 .. index:: pair: define; RCF_PCH_CFG_NODE_RW_COLLECTION_WITH_SUBST .. _doxid-group__rcf__ch__cfg__node__def_1ga4da837f77246c8fb3a5d33a8a0b7b2f7: .. ref-code-block:: cpp :class: doxyrest-title-code-block #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 .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _name - node name (:ref:`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 (:ref:`rcf_pch_cfg_substitution `) .. index:: pair: define; RCF_PCH_CFG_NODE_RW_WITH_SUBST .. _doxid-group__rcf__ch__cfg__node__def_1ga52756d69693aa5ce89523da206f5f092: .. ref-code-block:: cpp :class: doxyrest-title-code-block #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. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _name - node name (:ref:`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 (:ref:`rcf_pch_cfg_substitution `)