基础队列类，提供固定大小的循环缓冲区 (Base queue class providing a fixed-size circular buffer). More...

#include <queue.hpp>

Inheritance diagram for LibXR::BaseQueue:

Public Member Functions
	BaseQueue (uint16_t element_size, size_t length, uint8_t *buffer)
	构造函数，初始化队列 (Constructor to initialize the queue).

	BaseQueue (uint16_t element_size, size_t length)
	构造函数，初始化队列 (Constructor to initialize the queue).

	~BaseQueue ()
	析构函数，释放队列内存 (Destructor to free queue memory).

void *	operator[] (uint32_t index)
	访问指定索引的元素 (Access an element at a specified index).

ErrorCode	Push (const void *data)
	向队列中添加一个元素 (Push an element into the queue).

ErrorCode	Peek (void *data)
	获取队列头部的元素但不移除 (Peek at the front element without removing it).

ErrorCode	Pop (void *data=nullptr)
	移除队列头部的元素 (Pop the front element from the queue).

int	GetLastElementIndex () const
	获取队列中最后一个元素的索引 (Get the index of the last element in the queue).

int	GetFirstElementIndex () const
	获取队列中第一个元素的索引 (Get the index of the first element in the queue).

ErrorCode	PushBatch (const void *data, size_t size)
	批量推入多个元素 (Push multiple elements into the queue).

ErrorCode	PopBatch (void *data, size_t size)
	批量移除多个元素 (Pop multiple elements from the queue).

ErrorCode	PeekBatch (void *data, size_t size)
	批量获取多个元素但不移除 (Peek at multiple elements without removing them).

ErrorCode	Overwrite (const void *data)
	覆盖队列中的数据 (Overwrite the queue with new data).

void	Reset ()
	重置队列，清空所有数据 (Reset the queue and clear all data).

size_t	Size () const
	获取队列中的元素个数 (Get the number of elements in the queue).

size_t	EmptySize () const
	获取队列的空闲空间 (Get the available space in the queue).

	BaseQueue (const BaseQueue &)=delete

BaseQueue &	operator= (const BaseQueue &)=delete

BaseQueue &	operator= (BaseQueue &)=delete

BaseQueue &	operator= (const BaseQueue &&)=delete

BaseQueue &	operator= (BaseQueue &&)=delete

Data Fields
uint8_t *	queue_array_
	存储队列数据的数组 (Array storing queue data).

const uint16_t	ELEMENT_SIZE
	每个元素的大小 (Size of each element).

size_t	head_ = 0
	头部索引 (Head index).

size_t	tail_ = 0
	尾部索引 (Tail index).

bool	is_full_ = false
	队列是否已满 (Indicates if the queue is full).

size_t	length_
	队列最大容量 (Maximum queue capacity).

bool	own_buffer_ = false
	是否由队列自己管理缓冲区 (Owns buffer memory).

Detailed Description

基础队列类，提供固定大小的循环缓冲区 (Base queue class providing a fixed-size circular buffer).

This class implements a circular queue that supports element insertion, retrieval, and batch operations. 该类实现了一个循环队列，支持元素插入、读取和批量操作。

Definition at line 19 of file queue.hpp.

Constructor & Destructor Documentation

◆ BaseQueue() [1/2]

BaseQueue::BaseQueue	(	uint16_t	element_size,
		size_t	length,
		uint8_t *	buffer )

构造函数，初始化队列 (Constructor to initialize the queue).

Parameters

element_size	队列中每个元素的大小 (Size of each element in the queue).
length	队列的最大容量 (Maximum capacity of the queue).
buffer	指向缓冲区的指针 (Pointer to the buffer).

Definition at line 5 of file queue.cpp.

    : queue_array_(buffer),
      ELEMENT_SIZE(element_size),
      length_(length),
      own_buffer_(false)
{
}

◆ BaseQueue() [2/2]

BaseQueue::BaseQueue	(	uint16_t	element_size,
		size_t	length )

构造函数，初始化队列 (Constructor to initialize the queue).

Parameters

element_size	队列中每个元素的大小 (Size of each element in the queue).
length	队列的最大容量 (Maximum capacity of the queue).

Definition at line 13 of file queue.cpp.

    : queue_array_(new uint8_t[length * element_size]),
      ELEMENT_SIZE(element_size),
      length_(length),
      own_buffer_(true)
{
}

◆ ~BaseQueue()

BaseQueue::~BaseQueue ( )

析构函数，释放队列内存 (Destructor to free queue memory).

Definition at line 21 of file queue.cpp.

{
  if (own_buffer_)
  {
    delete[] queue_array_;
  }
}

Member Function Documentation

◆ EmptySize()

size_t BaseQueue::EmptySize ( ) const

nodiscard

获取队列的空闲空间 (Get the available space in the queue).

Returns: 队列中可存储的元素个数 (Number of available slots in the queue).

Definition at line 226 of file queue.cpp.

226{ return length_ - Size(); }

LibXR::BaseQueue::Size

size_t Size() const

获取队列中的元素个数 (Get the number of elements in the queue).

Definition queue.cpp:210

◆ GetFirstElementIndex()

int BaseQueue::GetFirstElementIndex ( ) const

获取队列中第一个元素的索引 (Get the index of the first element in the queue).

Returns: 如果队列非空，返回第一个元素的索引，否则返回 -1 (Returns the index of the first element if the queue is not empty, otherwise -1).

Definition at line 94 of file queue.cpp.

{
  if (Size() == 0)
  {
    return -1;
  }
  return static_cast<int>(head_);
}

◆ GetLastElementIndex()

int BaseQueue::GetLastElementIndex ( ) const

获取队列中最后一个元素的索引 (Get the index of the last element in the queue).

Returns: 如果队列非空，返回最后一个元素的索引，否则返回 -1 (Returns the index of the last element if the queue is not empty, otherwise -1).

Definition at line 85 of file queue.cpp.

{
  if (Size() == 0)
  {
    return -1;
  }
  return static_cast<int>((tail_ + length_ - 1) % length_);
}

◆ operator[]()

void * BaseQueue::operator[] ( uint32_t index )

nodiscard

访问指定索引的元素 (Access an element at a specified index).

Parameters

index 目标索引 (Target index).

Returns: 指向该索引处元素的指针 (Pointer to the element at the specified index).

Definition at line 29 of file queue.cpp.

{
  return &queue_array_[static_cast<size_t>(index * ELEMENT_SIZE)];
}

◆ Overwrite()

ErrorCode BaseQueue::Overwrite ( const void * data )

覆盖队列中的数据 (Overwrite the queue with new data).

Parameters

data	指向新数据的缓冲区 (Pointer to the new data buffer).

Returns: 操作结果，成功返回 ErrorCode::OK (Operation result: ErrorCode::OK on success).

Definition at line 186 of file queue.cpp.

{
  ASSERT(data != nullptr);
 
  head_ = tail_ = 0;
  is_full_ = false;
 
  memcpy(queue_array_, data, ELEMENT_SIZE * length_);
 
  tail_ = (tail_ + 1) % length_;
  if (head_ == tail_)
  {
    is_full_ = true;
  }
 
  return ErrorCode::OK;
}

◆ Peek()

ErrorCode BaseQueue::Peek ( void * data )

获取队列头部的元素但不移除 (Peek at the front element without removing it).

Parameters

data	指向存储数据的缓冲区 (Pointer to buffer where the data is stored).

Returns: 操作结果，成功返回 ErrorCode::OK，队列为空时返回 ErrorCode::EMPTY (Operation result: ErrorCode::OK on success, ErrorCode::EMPTY if empty).

Definition at line 54 of file queue.cpp.

{
  ASSERT(data != nullptr);
 
  if (Size() > 0)
  {
    memcpy(data, &queue_array_[head_ * ELEMENT_SIZE], ELEMENT_SIZE);
    return ErrorCode::OK;
  }
  else
  {
    return ErrorCode::EMPTY;
  }
}

◆ PeekBatch()

ErrorCode BaseQueue::PeekBatch	(	void *	data,
		size_t	size )

批量获取多个元素但不移除 (Peek at multiple elements without removing them).

Parameters

data	指向存储数据的缓冲区 (Pointer to buffer where the data is stored).
size	要获取的元素个数 (Number of elements to retrieve).

Returns: 操作结果，成功返回 ErrorCode::OK，队列为空时返回 ErrorCode::EMPTY (Operation result: ErrorCode::OK on success, ErrorCode::EMPTY if empty).

Definition at line 161 of file queue.cpp.

{
  ASSERT(data != nullptr);
 
  if (Size() < size)
  {
    return ErrorCode::EMPTY;
  }
 
  auto index = head_;
 
  auto tmp = reinterpret_cast<uint8_t *>(data);
 
  size_t first_part = LibXR::min(size, length_ - index);
  memcpy(tmp, &queue_array_[index * ELEMENT_SIZE], first_part * ELEMENT_SIZE);
 
  if (first_part < size)
  {
    memcpy(&tmp[first_part * ELEMENT_SIZE], queue_array_,
           (size - first_part) * ELEMENT_SIZE);
  }
 
  return ErrorCode::OK;
}

◆ Pop()

ErrorCode BaseQueue::Pop ( void * data = nullptr )

移除队列头部的元素 (Pop the front element from the queue).

Parameters

data	指向存储数据的缓冲区 (Pointer to buffer where the removed data is stored).

Returns: 操作结果，成功返回 ErrorCode::OK，队列为空时返回 ErrorCode::EMPTY (Operation result: ErrorCode::OK on success, ErrorCode::EMPTY if empty).

Definition at line 69 of file queue.cpp.

{
  if (Size() == 0)
  {
    return ErrorCode::EMPTY;
  }
 
  if (data != nullptr)
  {
    memcpy(data, &queue_array_[head_ * ELEMENT_SIZE], ELEMENT_SIZE);
  }
  head_ = (head_ + 1) % length_;
  is_full_ = false;
  return ErrorCode::OK;
}

◆ PopBatch()

ErrorCode BaseQueue::PopBatch	(	void *	data,
		size_t	size )

批量移除多个元素 (Pop multiple elements from the queue).

Parameters

data	指向存储数据的缓冲区 (Pointer to buffer where the removed data is stored).
size	要移除的元素个数 (Number of elements to remove).

Returns: 操作结果，成功返回 ErrorCode::OK，队列为空时返回 ErrorCode::EMPTY (Operation result: ErrorCode::OK on success, ErrorCode::EMPTY if empty).

Definition at line 132 of file queue.cpp.

{
  if (Size() < size)
  {
    return ErrorCode::EMPTY;
  }
 
  if (size == 0)
  {
    return ErrorCode::OK;
  }
  is_full_ = false;
 
  size_t first_part = LibXR::min(size, length_ - head_);
  if (data != nullptr)
  {
    auto tmp = reinterpret_cast<uint8_t *>(data);
    memcpy(tmp, &queue_array_[head_ * ELEMENT_SIZE], first_part * ELEMENT_SIZE);
    if (size > first_part)
    {
      memcpy(&tmp[first_part * ELEMENT_SIZE], queue_array_,
             (size - first_part) * ELEMENT_SIZE);
    }
  }
 
  head_ = (head_ + size) % length_;
  return ErrorCode::OK;
}

◆ Push()

ErrorCode BaseQueue::Push ( const void * data )

向队列中添加一个元素 (Push an element into the queue).

Parameters

data	指向要添加的数据 (Pointer to the data to be added).

Returns: 操作结果，成功返回 ErrorCode::OK，队列满时返回 ErrorCode::FULL (Operation result: ErrorCode::OK on success, ErrorCode::FULL if full).

Definition at line 34 of file queue.cpp.

{
  ASSERT(data != nullptr);
 
  if (is_full_)
  {
    return ErrorCode::FULL;
  }
 
  memcpy(&queue_array_[tail_ * ELEMENT_SIZE], data, ELEMENT_SIZE);
 
  tail_ = (tail_ + 1) % length_;
  if (head_ == tail_)
  {
    is_full_ = true;
  }
 
  return ErrorCode::OK;
}

◆ PushBatch()

ErrorCode BaseQueue::PushBatch	(	const void *	data,
		size_t	size )

批量推入多个元素 (Push multiple elements into the queue).

Parameters

data	指向数据缓冲区 (Pointer to the data buffer).
size	要推入的元素个数 (Number of elements to push).

Returns: 操作结果，成功返回 ErrorCode::OK，队列满时返回 ErrorCode::FULL (Operation result: ErrorCode::OK on success, ErrorCode::FULL if full).

Definition at line 103 of file queue.cpp.

{
  ASSERT(data != nullptr);
 
  auto avail = EmptySize();
  if (avail < size)
  {
    return ErrorCode::FULL;
  }
 
  auto tmp = reinterpret_cast<const uint8_t *>(data);
 
  size_t first_part = LibXR::min(size, length_ - tail_);
  memcpy(&queue_array_[tail_ * ELEMENT_SIZE], tmp, first_part * ELEMENT_SIZE);
 
  if (size > first_part)
  {
    memcpy(queue_array_, &tmp[first_part * ELEMENT_SIZE],
           (size - first_part) * ELEMENT_SIZE);
  }
 
  tail_ = (tail_ + size) % length_;
  if (head_ == tail_)
  {
    is_full_ = true;
  }
  return ErrorCode::OK;
}

◆ Reset()

void BaseQueue::Reset ( )

重置队列，清空所有数据 (Reset the queue and clear all data).

Definition at line 204 of file queue.cpp.

{
  head_ = tail_ = 0;
  is_full_ = false;
}

◆ Size()

size_t BaseQueue::Size ( ) const

nodiscard

获取队列中的元素个数 (Get the number of elements in the queue).

Returns: 当前队列中的元素个数 (Current number of elements in the queue).

Definition at line 210 of file queue.cpp.

{
  if (is_full_)
  {
    return length_;
  }
  else if (tail_ >= head_)
  {
    return tail_ - head_;
  }
  else
  {
    return length_ + tail_ - head_;
  }
}

Field Documentation

◆ ELEMENT_SIZE

const uint16_t LibXR::BaseQueue::ELEMENT_SIZE

每个元素的大小 (Size of each element).

Definition at line 150 of file queue.hpp.

◆ head_

size_t LibXR::BaseQueue::head_ = 0

头部索引 (Head index).

Definition at line 151 of file queue.hpp.

◆ is_full_

bool LibXR::BaseQueue::is_full_ = false

队列是否已满 (Indicates if the queue is full).

Definition at line 153 of file queue.hpp.

◆ length_

size_t LibXR::BaseQueue::length_

队列最大容量 (Maximum queue capacity).

Definition at line 154 of file queue.hpp.

◆ own_buffer_

bool LibXR::BaseQueue::own_buffer_ = false

是否由队列自己管理缓冲区 (Owns buffer memory).

Definition at line 155 of file queue.hpp.

◆ queue_array_

uint8_t* LibXR::BaseQueue::queue_array_

存储队列数据的数组 (Array storing queue data).

Definition at line 149 of file queue.hpp.

◆ tail_

size_t LibXR::BaseQueue::tail_ = 0

尾部索引 (Tail index).

Definition at line 152 of file queue.hpp.

The documentation for this class was generated from the following files:

src/structure/queue.hpp
src/structure/queue.cpp

Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ BaseQueue() [1/2]

◆ BaseQueue() [2/2]

◆ ~BaseQueue()

Member Function Documentation

◆ EmptySize()

◆ GetFirstElementIndex()

◆ GetLastElementIndex()

◆ operator[]()

◆ Overwrite()

◆ Peek()

◆ PeekBatch()

◆ Pop()

◆ PopBatch()

◆ Push()

◆ PushBatch()

◆ Reset()

◆ Size()

Field Documentation

◆ ELEMENT_SIZE

◆ head_

◆ is_full_

◆ length_

◆ own_buffer_

◆ queue_array_

◆ tail_