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>
4.2 KiB
| title | weight |
|---|---|
| ipool | 1 |
{{< callout >}}
Header: ipool.h
{{< /callout >}}
The base of all fixed capacity object pools.
Exceptions classes
class pool_exception : public exception
Description
The base class for pool exceptions.
class pool_no_allocation : public pool_exception
Description
The exception thrown when the pool has no more free items.
class pool_object_not_in_pool : public pool_exception
Description
The exception thrown when an object is released which does not belong to the pool.
class pool_element_size : public pool_exception
Description
The exception thrown when an the type requested is larger than the element size.
Member Types
size_type = size_t
Iterators
ipool_iterator
Description
Supports increment, dereference and comparison.
const_ipool_iterator
Description
Supports increment, dereference and comparison.
Member funcctions
iterator begin()
iterator end()
const_iterator begin() const
const_iterator end() const
const_iterator cbegin() const
const_iterator cend() const
template <typename T>
T* allocate()
Description
Allocates storage for an object from the pool.
If asserts or exceptions are enabled and there are no more free items an etl::pool_no_allocation if emitted, otherwise a null pointer is returned.
C++03
template <typename T>
T* create()
Description
Emplace with no parameters.
template <typename T, typename T1>
T* create(const T1& value1)
Description
Emplace with 1 parameter.
template <typename T, typename T1, typename T2>
T* create(const T1& value1, const T2& value2)
Description
Emplace with 2 parameters.
template <typename T, typename T1, typename T2, typename T3>
T* create(const T1& value1, const T2& value2, const T3& value3)
Description
Emplace with 3 parameters.
template <typename T, typename T1, typename T2, typename T3, typename T4>
T* create(const T1& value1, const T2& value2, const T3& value3, const T4& value4)
Description
Emplace with 4 parameters.
C++11 and above
template <typename T, typename... Args>
T* create(Args&&... args)
Description
Emplace with variadic constructor parameters.
template <typename T>
void destroy(const T* const p_object)
Description
Destroys the object.
Undefined behaviour if the pool does not contain a T.
Parameters
p_object A pointer to the object to be destroyed.
void release(const void* const p_object)
Description
Release an object in the pool.
If asserts or exceptions are enabled and the object does not belong to this pool then an etl::pool_object_not_in_pool is thrown.
Parameters
p_object A pointer to the object to be released.
void release_all()
Description
Release all objects in the pool.
bool is_in_pool(const void* const p_object) const
Description
Check to see if the object belongs to the pool.
Parameters
p_object A pointer to the object to be checked.
Return
true if it does, otherwise false.
size_t max_size() const
Description
Returns the maximum number of items in the pool.
size_t max_item_size() const
Description
Returns the maximum size of an item in the pool.
size_t capacity() const
Description
Returns the maximum number of items in the pool.
size_t available() const
Description
Returns the number of free items in the pool.
size_t size() const
Description
Returns the number of allocated items in the pool.
bool empty() const
Description
Checks to see if there are no allocated items in the pool.
Return
true if there are none allocated.
bool full() const
Description
Checks to see if there are no free items in the pool.
Return
true if there are none free.