:orphan:

.. index:: pair: struct; ta_conf_node
.. _doxid-structta__conf__node:

struct ta_conf_node
===================

.. toctree::
	:hidden:

Overview
~~~~~~~~

One configuration tree node. :ref:`More...<details-structta__conf__node>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <rcf_pch_tree.h>
	
	struct ta_conf_node {
		// fields
	
		const char* :ref:`name<doxid-structta__conf__node_1aa460fe6a9b09aef73c6022b35678d1d6>`;
		:ref:`cfg_val_type<doxid-conf__val__type_8h_1a21c9ece7b60181bc9e8ae7a04060e872>` :ref:`type<doxid-structta__conf__node_1af41663d18682f2fa92f72b3f0132d354>`;
		const :ref:`te_enum_map<doxid-structte__enum__map>`* :ref:`map<doxid-structta__conf__node_1a6ea809ff1eb0a3290b6f002705447ed0>`;
		:ref:`ta_conf_get_fn<doxid-unionta__conf__get__fn>` :ref:`get<doxid-structta__conf__node_1a94ff2825abf0d359c2223ccb7e490dab>`;
		:ref:`ta_conf_set_fn<doxid-unionta__conf__set__fn>` :ref:`set<doxid-structta__conf__node_1a9726c23441d2e891cb1c5a95821ff3a9>`;
		:ref:`ta_conf_add_fn<doxid-unionta__conf__add__fn>` :ref:`add<doxid-structta__conf__node_1af1b0efcef247914cfd0fd36c2f41178d>`;
		:ref:`ta_conf_del_fn<doxid-rcf__pch__tree_8h_1ade8a5d883f80d0ad7832aa6f59c73659>`* :ref:`del<doxid-structta__conf__node_1a4396732099d26f1f7ec3bd530e1c0db7>`;
		:ref:`ta_conf_list_fn<doxid-rcf__pch__tree_8h_1a4c0819b1f96c878469f7fb46393cb689>`* :ref:`list<doxid-structta__conf__node_1a0912ce3ab697057a90f5f23b4a8b050e>`;
		:ref:`ta_conf_commit_fn<doxid-rcf__pch__tree_8h_1a685d7e40173f7c325fba2867283a8ab9>`* :ref:`commit<doxid-structta__conf__node_1a95a0777b381b56013cb84fbb763ec490>`;
		const :ref:`rcf_pch_cfg_substitution<doxid-structrcf__pch__cfg__substitution>`* :ref:`subst<doxid-structta__conf__node_1ab746220c57e44ccb66655e97ab232fa9>`;
		const struct ta_conf_node*const* :ref:`children<doxid-structta__conf__node_1ad6cca8d685ea7cd150ce62c5f638a072>`;
	};
.. _details-structta__conf__node:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

One configuration tree node. Normally built with the macros.

Fields
------

.. index:: pair: variable; name
.. _doxid-structta__conf__node_1aa460fe6a9b09aef73c6022b35678d1d6:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const char* name

Configurator sub-identifier

.. index:: pair: variable; type
.. _doxid-structta__conf__node_1af41663d18682f2fa92f72b3f0132d354:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`cfg_val_type<doxid-conf__val__type_8h_1a21c9ece7b60181bc9e8ae7a04060e872>` type

Value type of get/set/add

.. index:: pair: variable; map
.. _doxid-structta__conf__node_1a6ea809ff1eb0a3290b6f002705447ed0:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const :ref:`te_enum_map<doxid-structte__enum__map>`* map

Name/value map, ``CVT_STRING`` only. Its presence is what makes the node an enumeration: the value travels as a name, and the accessors used are as_enum rather than as_str

.. index:: pair: variable; get
.. _doxid-structta__conf__node_1a94ff2825abf0d359c2223ccb7e490dab:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`ta_conf_get_fn<doxid-unionta__conf__get__fn>` get

Get accessor or unset

.. index:: pair: variable; set
.. _doxid-structta__conf__node_1a9726c23441d2e891cb1c5a95821ff3a9:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`ta_conf_set_fn<doxid-unionta__conf__set__fn>` set

Set accessor or unset

.. index:: pair: variable; add
.. _doxid-structta__conf__node_1af1b0efcef247914cfd0fd36c2f41178d:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`ta_conf_add_fn<doxid-unionta__conf__add__fn>` add

Collection add or unset

.. index:: pair: variable; del
.. _doxid-structta__conf__node_1a4396732099d26f1f7ec3bd530e1c0db7:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`ta_conf_del_fn<doxid-rcf__pch__tree_8h_1ade8a5d883f80d0ad7832aa6f59c73659>`* del

Collection delete or unset

.. index:: pair: variable; list
.. _doxid-structta__conf__node_1a0912ce3ab697057a90f5f23b4a8b050e:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`ta_conf_list_fn<doxid-rcf__pch__tree_8h_1a4c0819b1f96c878469f7fb46393cb689>`* list

Collection list or unset

.. index:: pair: variable; commit
.. _doxid-structta__conf__node_1a95a0777b381b56013cb84fbb763ec490:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`ta_conf_commit_fn<doxid-rcf__pch__tree_8h_1a685d7e40173f7c325fba2867283a8ab9>`* commit

Commit covering the subtree

.. index:: pair: variable; subst
.. _doxid-structta__conf__node_1ab746220c57e44ccb66655e97ab232fa9:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const :ref:`rcf_pch_cfg_substitution<doxid-structrcf__pch__cfg__substitution>`* subst

Substitutions passed through to the mirrored node

.. index:: pair: variable; children
.. _doxid-structta__conf__node_1ad6cca8d685ea7cd150ce62c5f638a072:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const struct ta_conf_node*const* children

Children in sibling order. Arrays built by :ref:`TA_CONF_CHILDREN() <doxid-rcf__pch__tree_8h_1a72dfa9b9220ae9e50c052eb2d98f3c5a>` carry a leading NULL pad and a NULL terminator; iteration starts at index 1.