:orphan:

.. index:: pair: struct; te_unit_list
.. _doxid-structte__unit__list:

struct te_unit_list
===================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Customizable unit type :ref:`More...<details-structte__unit__list>`


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

	#include <te_units.h>
	
	struct te_unit_list {
		// fields
	
		unsigned int :ref:`scale<doxid-structte__unit__list_1a875a3e30e2c17471a9409432672a735a>`;
		const double* :ref:`non_uniform_scale<doxid-structte__unit__list_1a4eff7afac1f86c061396afee31ff7cd1>`;
		int :ref:`start_pow<doxid-structte__unit__list_1a020ab6ecb2708eb0785a148ce7294c10>`;
		const char*const* :ref:`units<doxid-structte__unit__list_1afa725f5e331551a4cafc62e3e9a56230>`;
	};
.. _details-structte__unit__list:

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

Customizable unit type

Fields
------

.. index:: pair: variable; scale
.. _doxid-structte__unit__list_1a875a3e30e2c17471a9409432672a735a:

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

	unsigned int scale

Relative scaling factor of each unit.

If *non_uniform_scale* is not ``NULL``, the scale must not be greater than ``1`` (basically, it is not used in this case)

.. index:: pair: variable; non_uniform_scale
.. _doxid-structte__unit__list_1a4eff7afac1f86c061396afee31ff7cd1:

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

	const double* non_uniform_scale

A set of non-uniform scale factors.

Unlike *scale*, those are absolute factors applied to a base value

If the field is not ``NULL``, the array must contain at least as many elements as *units*.

.. index:: pair: variable; start_pow
.. _doxid-structte__unit__list_1a020ab6ecb2708eb0785a148ce7294c10:

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

	int start_pow

The initial power of ``scale`` which the first unit in the list corresponds to. If the value is negative, first ``-start_pow`` units denote fractions of the base unit.

The value should be 0 if *non_uniform_scale* is provided.

.. index:: pair: variable; units
.. _doxid-structte__unit__list_1afa725f5e331551a4cafc62e3e9a56230:

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

	const char*const* units

NULL-terminated list of unit names