4a88884b39
* 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>
3.9 KiB
| title |
|---|
| flags |
{{< callout type="info">}}
Header: flags.h
Since: TBC
{{< /callout >}}
Provides a wrapper around a set of binary flags.
Supports compile time and runtime variants
template <typename T, T MASK = etl::integral_limits<T>::max>
class flags
T must be an unsigned integral type.
MASK is used to exclude unused or undefined bits from operations of the flags. By default, all bits are included.
Most member functions may be chained.
bool isF5Set = flags.set(bitPattern, true).flip().test(F5);
Constructor
ETL_CONSTEXPR flags() ETL_NOEXCEPT
Description
Constructs a flag set with all elements set to 0 (false).
ETL_CONSTEXPR flags(value_type pattern) ETL_NOEXCEPT
Description Constructs a flag set with elements set to pattern.
ETL_CONSTEXPR flags(const flags<T, MASK>& pattern) ETL_NOEXCEPT
Description Constructs a flag set with elements set to pattern.
Modifiers
ETL_CONSTEXPR14 flags<T, MASK>& operator=(flags<T, MASK> other) ETL_NOEXCEPT
Description Assigns from another flags object.
ETL_CONSTEXPR14 flags<T, MASK>& operator=(value_type pattern) ETL_NOEXCEPT
Description Assigns from a bit pattern.
template <value_type pattern, bool value>
ETL_CONSTEXPR14 flags<T, MASK>& set() ETL_NOEXCEPT
template <value_type pattern>
ETL_CONSTEXPR14 flags<T, MASK>& set(bool value) ETL_NOEXCEPT
template <value_type pattern>
ETL_CONSTEXPR14 flags<T, MASK>& set() ETL_NOEXCEPT
ETL_CONSTEXPR14 flags<T, MASK>& set(value_type pattern) ETL_NOEXCEPT
ETL_CONSTEXPR14 flags<T, MASK>& set(value_type pattern, bool value) ETL_NOEXCEPT
ETL_CONSTEXPR14 flags<T, MASK>& clear() ETL_NOEXCEPT
template <value_type pattern> ETL_CONSTEXPR14 flags<T, MASK>& reset() ETL_NOEXCEPT
ETL_CONSTEXPR14 flags<T, MASK>& reset(value_type pattern) ETL_NOEXCEPT
ETL_CONSTEXPR14 flags<T, MASK>& flip() ETL_NOEXCEPT
template <value_type pattern> ETL_CONSTEXPR14 flags<T, MASK>& flip() ETL_NOEXCEPT
ETL_CONSTEXPR14 flags<T, MASK>& flip(value_type pattern) ETL_NOEXCEPT
Access
template <value_type pattern> ETL_CONSTEXPR bool test() const ETL_NOEXCEPT Test the bits for the compile time pattern.
ETL_CONSTEXPR bool test(value_type pattern) const ETL_NOEXCEPT Test the bits for the run time pattern.
ETL_CONSTEXPR value_type value() const ETL_NOEXCEPT ETL_CONSTEXPR operator value_type() const ETL_NOEXCEPT Returns the value of the flags as a value_type.
Operations
Non-member functions
template <typename T, T MASK> void swap(flags<T, MASK>& lhs, flags<T, MASK>& rhs) Swaps two flags.
template <typename T, T MASK> bool operator == (flags<T, MASK>& lhs, flags<T, MASK>& rhs) Checks equality of two flags.
template <typename T, T MASK> bool operator != (flags<T, MASK>& lhs, flags<T, MASK>& rhs) Checks inequality of two flags.