:orphan:

.. index:: pair: struct; cfg_object
.. _doxid-structcfg__object:

struct cfg_object
=================

.. toctree::
	:hidden:

Overview
~~~~~~~~




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

	
	struct cfg_object {
		// fields
	
		struct cfg_object* :ref:`father<doxid-structcfg__object_1a6d3544a35495d70f44599ffe401c41ec>`;
		struct cfg_object* :ref:`son<doxid-structcfg__object_1afc910e19f3ccb9ff98f90868c21ada7e>`;
		struct cfg_object* :ref:`brother<doxid-structcfg__object_1a2b63ac281dc01a5baf4301a5a363ec1d>`;
		unsigned :ref:`ordinal_number<doxid-structcfg__object_1a3613a1dd1088f1205885e949811a6ce9>`;
		struct :ref:`cfg_dependency<doxid-structcfg__dependency>`* :ref:`depends_on<doxid-structcfg__object_1ac3468922cf175848b62ee7c80cbdf7a4>`;
		struct :ref:`cfg_dependency<doxid-structcfg__dependency>`* :ref:`dependants<doxid-structcfg__object_1a4b53dbb4a4281718160fe892e926b053>`;
		struct cfg_object* :ref:`dep_next<doxid-structcfg__object_1aae8a14ed9876a0a51afa5c28b8fcff90>`;
		struct cfg_object* :ref:`dep_prev<doxid-structcfg__object_1a9b0ded968c952e53060477853f0ddaae>`;
		bool :ref:`substitution<doxid-structcfg__object_1a827628b1ba81bae94fdb44b92958436e>`;
		bool :ref:`unit<doxid-structcfg__object_1acda5a55ae88e0ae117ffdb353362babb>`;
		bool :ref:`unit_part<doxid-structcfg__object_1a7cc99cf45b3d0507cddac68c8c8abd1e>`;
		:ref:`cfg_handle<doxid-group__confapi__base_1gabc299401ba5bcc0edb6eab462c0a6ba4>` :ref:`handle<doxid-structcfg__object_1a307f0c69ba9c952dd1032dad161ca2bc>`;
		char* :ref:`oid<doxid-structcfg__object_1abc976fc54e5ac31aa6d637ef02c5d95b>`;
		char :ref:`subid<doxid-structcfg__object_1a0d7f72f3f71a600ddb578eac22bc2b53>`[CFG_SUBID_MAX];
		:ref:`cfg_val_type<doxid-conf__types_8h_1a21c9ece7b60181bc9e8ae7a04060e872>` :ref:`type<doxid-structcfg__object_1a9c33f6af673b61e32d071c8603ea5953>`;
		uint8_t :ref:`access<doxid-structcfg__object_1a4670d1af4fa24e33073ebc952e060ba3>`;
		char* :ref:`def_val<doxid-structcfg__object_1ae1fa3a5d59584456bac5e6e31256d588>`;
		bool :ref:`vol<doxid-structcfg__object_1a218afa3f2437f786a728978fd408bfdb>`;
	};
.. _details-structcfg__object:

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



Fields
------

.. index:: pair: variable; father
.. _doxid-structcfg__object_1a6d3544a35495d70f44599ffe401c41ec:

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

	struct cfg_object* father

Link to father

.. index:: pair: variable; son
.. _doxid-structcfg__object_1afc910e19f3ccb9ff98f90868c21ada7e:

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

	struct cfg_object* son

Link to the first son

.. index:: pair: variable; brother
.. _doxid-structcfg__object_1a2b63ac281dc01a5baf4301a5a363ec1d:

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

	struct cfg_object* brother

Link to the next brother

.. index:: pair: variable; ordinal_number
.. _doxid-structcfg__object_1a3613a1dd1088f1205885e949811a6ce9:

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

	unsigned ordinal_number

Ordinal number of this object in the topologically sorted list

.. index:: pair: variable; depends_on
.. _doxid-structcfg__object_1ac3468922cf175848b62ee7c80cbdf7a4:

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

	struct :ref:`cfg_dependency<doxid-structcfg__dependency>`* depends_on

Objects this object depends on

.. index:: pair: variable; dependants
.. _doxid-structcfg__object_1a4b53dbb4a4281718160fe892e926b053:

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

	struct :ref:`cfg_dependency<doxid-structcfg__dependency>`* dependants

Objects depending on this object

.. index:: pair: variable; dep_next
.. _doxid-structcfg__object_1aae8a14ed9876a0a51afa5c28b8fcff90:

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

	struct cfg_object* dep_next

The next object in topological order

.. index:: pair: variable; dep_prev
.. _doxid-structcfg__object_1a9b0ded968c952e53060477853f0ddaae:

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

	struct cfg_object* dep_prev

The previous object in toplogical order

.. index:: pair: variable; substitution
.. _doxid-structcfg__object_1a827628b1ba81bae94fdb44b92958436e:

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

	bool substitution

The object uses substitution

.. index:: pair: variable; unit
.. _doxid-structcfg__object_1acda5a55ae88e0ae117ffdb353362babb:

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

	bool unit

If ``true``, object should be considered as a logical unit, not simply as a loose collection of child objects. Configurator will take this into account when managing dependencies and restoring configuration from backup

.. index:: pair: variable; unit_part
.. _doxid-structcfg__object_1a7cc99cf45b3d0507cddac68c8c8abd1e:

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

	bool unit_part

``true`` means the object is a descendant of an object having unit=true

.. index:: pair: variable; handle
.. _doxid-structcfg__object_1a307f0c69ba9c952dd1032dad161ca2bc:

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

	:ref:`cfg_handle<doxid-group__confapi__base_1gabc299401ba5bcc0edb6eab462c0a6ba4>` handle

Handle of the object

.. index:: pair: variable; oid
.. _doxid-structcfg__object_1abc976fc54e5ac31aa6d637ef02c5d95b:

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

	char* oid

OID of the object

.. index:: pair: variable; subid
.. _doxid-structcfg__object_1a0d7f72f3f71a600ddb578eac22bc2b53:

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

	char subid[CFG_SUBID_MAX]

Own sub-identifier of the object

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

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

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

Type of the object instance value

.. index:: pair: variable; access
.. _doxid-structcfg__object_1a4670d1af4fa24e33073ebc952e060ba3:

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

	uint8_t access

Access rights

.. index:: pair: variable; def_val
.. _doxid-structcfg__object_1ae1fa3a5d59584456bac5e6e31256d588:

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

	char* def_val

Default value

.. index:: pair: variable; vol
.. _doxid-structcfg__object_1a218afa3f2437f786a728978fd408bfdb:

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

	bool vol

The object is volatile