etl/docs/types/type-lookup.md
John Wellbelove 4a88884b39
Issue/add hugo support for documentation (#1449)
* Add ranges

* Initial Hugo setup

* Work in progress

* Added selection for local or remote site

* Updated to 'light' theme

* Changed to using Hextra Hugo theme

* Changed to using Hextra Hugo theme

* Changed to Hextra Hugo theme

* Change to Hextra Hugo theme

* Updated Hugo setup.

* Updated Hugo setup.

# Conflicts:
#	docs/releases/_index.md

* Work in progress

* Added new fonts

Added new documentation

* Latest documentation updates

* Latest documentation updates

# Conflicts:
#	docs/containers/array.md
#	docs/containers/array_view.md
#	docs/containers/array_wrapper.md
#	docs/containers/bip_buffer_spsc_atomic.md
#	docs/containers/bitset.md
#	docs/containers/indirect_vector.md
#	docs/containers/vector.md
#	docs/getting-started/compilers.md

* Added bloom_filter markdown doc

* Added more documentation

Updated CSS for light and dark modes

* Fixed some menus

Added mode documentation files

* Updated CSS rules

Added badges to home page
Added uniqur_ptr + pool tutorial

* Fixed formatting on the home page markdown

Modified light amd dark code formatting

* Updated unique_ptr-with-pool

* Added container and shared message tutorials

* Updates to documentation

* Added const_multimap

* Updated source-formatting.md

* Added initial raw text files form Web site editor

* Innore coverage build directory

* Exported raw text documentation files from the web site editor

* Hugo updates

* Added Hugo intalation and markdown descriptions

* More addition to the documentation

* Added closure.md and updates to delegate.md

* Added format.md

* Added documentation for etl::delegate_observable, etl::function, Base64 codec

* Added io_port documentation

* Added basic_format_spec

* Added documentation for string_stream and string utilities.

* Added more documentation

Updated the documentation CSS

* Added documentation for clocks, day, duration

* Added more documentation for chrono classes

Updated callouts

* More chrono documentation

* Completed chrono documentation

* Maths functions documentation

* Completed maths documentation

* Completed maths documentation

* Completed maths documentation

* Completed maths documentation

* Added multiple documentation files

* Added iterator.md

* Added debug_count.md and versions.md

* Added debug_count.md and versions.md

* Added more documentation

* More documentation

* Added some design pattern documentation

Modified some of the layout files
Modified the About documentation

* Converted more documentation pages

Modified the site CSS

* Added more documentation

Moced some documentation files to new directories

* Added more documentation

Tweaks to CSS

* Added callback_timer_deferred_locked documentation

* Added callback_timer_locked documentation

* More documentation updates

* More documentation updates

* More documentation updates

* New documentation files.

Harmonised file name format

* New documentation files.

* Multiple document updates

* Multiple document updates

* Final conversion of web pages

* Updates before PR

* Updates before PR

* Updates before PR

# Conflicts:
#	docs/blog/_index.md

* Final pre PR updates

* Updates to message framework documentation

* Renamed directory

* Fix spelling

* Added author and date to blog files

Moved documentation files merged from development

* Fixed 'Description' typo

* Fix typos

# Conflicts:
#	docs/IO/io_port.md
#	docs/containers/sets/const-multiset.md
#	docs/containers/sets/const-set.md
#	docs/maths/correlation.md
#	docs/maths/gamma.md

* Renamed two files to lower case

* Minor renaming

* Added author and date

* Updated callout on bresenham_line.md

Added support for showing the ETL version on the documentation first page, by copying the version.txt file as a hugo asset.
Updated the Python 'update_release.py' to copy 'version.txt'

* Replace space in filename with hyphen.

Added more information to hugo-commands.md

* Replace space in filename with hyphen.

Added more information to hugo-commands.md

# Conflicts:
#	docs/getting-started/view-the-docs-locally/hugo-commands.md

* Added a link to pseudo_moving_average.md

* Updated title pages for groups

* Fixed missing 404 for non-existent pages

* Fixed coordinate variable names in the 'Calculating the intersection' example

---------

Co-authored-by: Roland Reichwein <Roland.Reichwein@bmw.de>
Co-authored-by: John Wellbelove <john.wellbelove@etlcpp.com>
Co-authored-by: John Wellbelove <john.wellbelove@etlcpp.co.uk>
2026-06-06 13:12:44 +01:00

3.9 KiB

title
type-lookup

{{< callout type="info">}} Header: type_lookup.h
{{< /callout >}}

Compile time mapping of id to type, type to id and type to type.
This file is generated from type_lookup_generator.h and can be created by running generate_type_lookup.bat.

For a less complex solution for simple id to type lookup, see etl::type_select.

type_id_pair

Support structure for type_id_lookup.

etl::type_id_pair<typename T, size_t ID>

Defines
type The type.
ID The id associated with the type.

type_type_pair

Support structure for type_type_lookup.

etl::type_type_pair<typename T1, typename T2>

Defines
type1 The indexing type. type2 The associated type.

type_id_lookup

Creates a class for compile time id to type and type to id mappings.

etl::type_id_lookup<typename T1, ...>

The number of types that can be handled is determined by the generator.
Each template parameter is a type_id_pair.


The class contains two nested templates.

type_from_id

Gets the type from the id.

type_from_id<size_t ID>

Defines
type The associated type.

C++14 and above

template <int ID>
using type_from_id_t = typename type_from_id<ID>::type;

id_from_type

id_from_type<typename T>

Gets the id from the type.

Defines
ID The associated id.

C++ 17 and above

template <typename T>
constexpr size_t id_from_type_v = id_from_type<T>::value;

Static functions

template <typename T>
static unsigned int get_id_from_type(const T&)

Gets the id from the type.

template <typename T>
static unsigned int get_id_from_type()

Gets the id from the type.

type_type_lookup

Creates a class for compile time type to type mapping.

etl::type_id_lookup<typename T1, ...>

The number of types that can be handled is determined by the generator.
Each template parameter is a type_id_pair.


The class contains one nested template.

type_from_type

type_from_type<typename T>

Defines
type The associated type.

C++14 and above

template <typename T>
using type_from_type_t = typename type_from_type<T>::type;

nth_type

Gets the nth type in a variadic type list.

template <size_t N, typename... TTypes>
struct nth_type

Defines member type as the nth type in the variadic type list.

template <size_t N, typename... TTypes>
using nth_type_t = typename nth_type<N, TTypes...>::type;

Type alias defined as the nth type in the variadic type list.

Examples

enum
{
  INT32  = 32,
  STRING = 1,
  UINT8  = 8,
  OTHER  = 0
};

typedef etl::type_id_pair<int32_t,     INT32>  TypeIdInt32;
typedef etl::type_id_pair<uint8_t,     UINT8>  TypeIdUint8;
typedef etl::type_id_pair<std::string, STRING> TypeIdString;

// Type from Id / Id from Type.
typedef etl::type_id_lookup<TypeIdInt32, TypeIdString, TypeIdUint8> TypeIdLookup;

// int32_t
typename TypeIdLookup::type_from_id_t<INT32>

// uint8_t
typename TypeIdLookup::type_from_id_t<UINT8>

// std::string
typename TypeIdLookup::type_from_id_t<STRING>

// Compile error
typename TypeIdLookup::type_from_id_t<OTHER>

// INT32
TypeIdLookup::id_from_type_v<int32_t>

// UINT8
TypeIdLookup::id_from_type_v<uint8_t>

// STRING
TypeIdLookup::id_from_type_v<std::string>

// Compile error
TypeIdLookup::id_from_type_v<double>
---
type_type_lookup
// Get the next larger type.
typedef etl::type_type_pair<int16_t, int32_t>  TypeInt16;
typedef etl::type_type_pair<uint8_t, uint16_t> TypeUint8;
typedef etl::type_type_pair<float,   double>   TypeFloat;

// Type from Type.
etl::type_type_lookup<TypeInt16, TypeUint8, TypeFloat> TypeTypeLookup;

// int32_t
typename TypeTypeLookup::type_from_type_t<int16_t>

// uint16_t
typename TypeTypeLookup::type_from_type_t<uint8_t>

// double
typename TypeTypeLookup::type_from_type_t<float>

// Compile error
typename TypeTypeLookup::type_from_type_t<int32_t>