data_span.hpp

//================================================================================================
/// @file can_message_data.hpp
///
/// @brief Contains common types and functions for working with an arbitrary amount of items.
/// @author Daan Steenbergen
///
/// @copyright 2023 Open Agriculture
//================================================================================================
#ifndef DATA_SPAN_HPP
#define DATA_SPAN_HPP

#include <array>
#include <cstddef>
#include <vector>

namespace isobus
{
	//================================================================================================
	/// @class DataSpan
	///
	/// @brief A class that represents a span of data of arbitrary length.
	//================================================================================================
	template<typename T>
	class DataSpan
	{
	public:
		/// @brief Construct a new DataSpan object of a writeable array.
		/// @param ptr pointer to the buffer to use.
		/// @param len The number of elements in the buffer.
		DataSpan(T *ptr, std::size_t size) :
		  ptr(ptr),
		  _size(size)
		{
		}

		/// @brief Get the element at the given index.
		/// @param index The index of the element to get.
		/// @return The element at the given index.
		T &operator[](std::size_t index)
		{
			return ptr[index * sizeof(T)];
		}

		/// @brief Get the element at the given index.
		/// @param index The index of the element to get.
		/// @return The element at the given index.
		T const &operator[](std::size_t index) const
		{
			return ptr[index * sizeof(T)];
		}

		/// @brief Get the size of the data span.
		/// @return The size of the data span.
		std::size_t size() const
		{
			return _size;
		}

		/// @brief Get the begin iterator.
		/// @return The begin iterator.
		T *begin() const
		{
			return ptr;
		}

		/// @brief Get the end iterator.
		/// @return The end iterator.
		T *end() const
		{
			return ptr + _size * sizeof(T);
		}

	private:
		T *ptr;
		std::size_t _size;
		bool _isConst;
	};
}
#endif // DATA_SPAN_HPP