ALPAKA/sta-core
1
0
Fork 0
mirror of https://git.intern.spaceteamaachen.de/ALPAKA/sta-core.git synced 2025-08-06 10:27:34 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updated: Doxygen Documentation

Browse Source
This commit is contained in:
@CarlWachter
2024-01-06 17:17:40 +01:00
committed by CarlWachter
parent b3ed26e288
commit 16b9e6135c
26 changed files with 331 additions and 306 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
include/sta/bus/can/iter.hpp
View File

@@ -18,9 +18,13 @@ namespace sta
class CanPendingRxFifos
{
public:
/// @brief Value type.
using value_type = uint8_t;
/// @brief Pointer to value type.
using reference = value_type &;
/// @brief Const pointer to value type.
using const_reference = const value_type &;
/// @brief Size of type.
using size_type = uint8_t;
/**
@@ -29,21 +33,42 @@ namespace sta
class const_iterator
{
public:
/// @brief Value type.
using value_type = CanPendingRxFifos::value_type;
/// @brief Const pointer to value type.
using reference = const_reference;
/// @brief Pointer to value type.
using pointer = const value_type *;
public:
/// @brief Default constructor.
const_iterator(const const_iterator & iter);
/// @brief Copies the contents of the given iterator.
/// @param iter Iterator to be copied.
const_iterator & operator=(const const_iterator & iter);
/**
* @brief Compare iterators by flags, index and end index.
*/
bool operator==(const const_iterator & iter) const;
/**
* @brief Compare iterators by flags, index and end index.
*/
bool operator!=(const const_iterator & iter) const;
/**
* @brief Increment iterator to next pending RX queue.
*/
const_iterator & operator++();
/**
* @brief Increment iterator to next pending RX queue.
*/
const_iterator operator++(int);
/**
* @brief Dereference iterator at index.
*/
reference operator*() const;
private:
@@ -69,7 +94,13 @@ namespace sta
*/
CanPendingRxFifos(uint32_t rxFlags, uint8_t numFifos);
/**
* @brief Get iterator to first pending RX queue.
*/
const_iterator begin() const;
/**
* @brief Get iterator to end of RX queues.
*/
const_iterator end() const;
private: