:orphan:

.. index:: pair: struct; te_enum_bitmask_conv
.. _doxid-structte__enum__bitmask__conv:

struct te_enum_bitmask_conv
===========================

.. toctree::
	:hidden:

Overview
~~~~~~~~

A mapping between two bitmasks corresponding to each other via named bits. :ref:`More...<details-structte__enum__bitmask__conv>`


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

	#include <te_enum.h>
	
	struct te_enum_bitmask_conv {
		// fields
	
		uint64_t :ref:`bits_from<doxid-structte__enum__bitmask__conv_1a2b9762928e6ea8d15bc0a5c731fbd088>`;
		uint64_t :ref:`bits_to<doxid-structte__enum__bitmask__conv_1affae65c2fdd74da59f07a512ea8ac2fd>`;
	};
.. _details-structte__enum__bitmask__conv:

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

A mapping between two bitmasks corresponding to each other via named bits.

This structure permits the mapping of one or more bits from one side to one or more bits on the other side, with the constraint that the bits on each side do not overlap. This constraint results in the prohibition of mapping two or more set bits to the same corresponding bits on the other side.

An array of mappings should end with :ref:`TE_ENUM_BITMASK_CONV_END <doxid-group__te__tools__te__enum_1ga2678f25428942a4d76bc8051c0828b99>` and should not contain ``UINT64_MAX`` as a value of one of the fields.

Fields
------

.. index:: pair: variable; bits_from
.. _doxid-structte__enum__bitmask__conv_1a2b9762928e6ea8d15bc0a5c731fbd088:

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

	uint64_t bits_from

Left-hand side bits mask.

.. index:: pair: variable; bits_to
.. _doxid-structte__enum__bitmask__conv_1affae65c2fdd74da59f07a512ea8ac2fd:

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

	uint64_t bits_to

Right-hand side bits mask.