apollo::cyber::data::CacheBuffer< T > 模板类 参考

#include <cache_buffer.h>

apollo::cyber::data::CacheBuffer< T > 的协作图:

Public 类型
using	value_type = T
using	size_type = std::size_t
using	FusionCallback = std::function< void(const T &)>

Public 成员函数
	CacheBuffer (uint64_t size)
	CacheBuffer (const CacheBuffer &rhs)
T &	operator[] (const uint64_t &pos)
const T &	at (const uint64_t &pos) const
uint64_t	Head () const
uint64_t	Tail () const
uint64_t	Size () const
const T &	Front () const
const T &	Back () const
bool	Empty () const
bool	Full () const
uint64_t	Capacity () const
void	SetFusionCallback (const FusionCallback &callback)
void	Fill (const T &value)
std::mutex &	Mutex ()

详细描述

template<typename T>
class apollo::cyber::data::CacheBuffer< T >

在文件 cache_buffer.h 第 30 行定义.

成员类型定义说明

FusionCallback

template<typename T >

using apollo::cyber::data::CacheBuffer< T >::FusionCallback = std::function<void(const T&)>

在文件 cache_buffer.h 第 34 行定义.

size_type

template<typename T >

using apollo::cyber::data::CacheBuffer< T >::size_type = std::size_t

在文件 cache_buffer.h 第 33 行定义.

value_type

template<typename T >

using apollo::cyber::data::CacheBuffer< T >::value_type = T

在文件 cache_buffer.h 第 32 行定义.

构造及析构函数说明

CacheBuffer() [1/2]

template<typename T >

apollo::cyber::data::CacheBuffer< T >::CacheBuffer ( uint64_t  size )

inlineexplicit

在文件 cache_buffer.h 第 36 行定义.

                                      {
    capacity_ = size + 1;
    buffer_.resize(capacity_);
  }

CacheBuffer() [2/2]

template<typename T >

apollo::cyber::data::CacheBuffer< T >::CacheBuffer ( const CacheBuffer< T > &  rhs )

inline

在文件 cache_buffer.h 第 41 行定义.

                                      {
    std::lock_guard<std::mutex> lg(rhs.mutex_);
    head_ = rhs.head_;
    tail_ = rhs.tail_;
    buffer_ = rhs.buffer_;
    capacity_ = rhs.capacity_;
    fusion_callback_ = rhs.fusion_callback_;
  }

成员函数说明

at()

template<typename T >

const T & apollo::cyber::data::CacheBuffer< T >::at ( const uint64_t &  pos ) const

inline

在文件 cache_buffer.h 第 51 行定义.

{ return buffer_[GetIndex(pos)]; }

Back()

template<typename T >

const T & apollo::cyber::data::CacheBuffer< T >::Back ( ) const

inline

在文件 cache_buffer.h 第 58 行定义.

{ return buffer_[GetIndex(tail_)]; }

Capacity()

template<typename T >

uint64_t apollo::cyber::data::CacheBuffer< T >::Capacity ( ) const

inline

在文件 cache_buffer.h 第 62 行定义.

{ return capacity_; }

Empty()

template<typename T >

bool apollo::cyber::data::CacheBuffer< T >::Empty ( ) const

inline

在文件 cache_buffer.h 第 60 行定义.

{ return tail_ == 0; }

Fill()

template<typename T >

void apollo::cyber::data::CacheBuffer< T >::Fill ( const T &  value )

inline

在文件 cache_buffer.h 第 68 行定义.

                            {
    if (fusion_callback_) {
      fusion_callback_(value);
    } else {
      if (Full()) {
        buffer_[GetIndex(head_)] = value;
        ++head_;
        ++tail_;
      } else {
        buffer_[GetIndex(tail_ + 1)] = value;
        ++tail_;
      }
    }
  }

Front()

template<typename T >

const T & apollo::cyber::data::CacheBuffer< T >::Front ( ) const

inline

在文件 cache_buffer.h 第 57 行定义.

{ return buffer_[GetIndex(head_ + 1)]; }

Full()

template<typename T >

bool apollo::cyber::data::CacheBuffer< T >::Full ( ) const

inline

在文件 cache_buffer.h 第 61 行定义.

{ return capacity_ - 1 == tail_ - head_; }

Head()

template<typename T >

uint64_t apollo::cyber::data::CacheBuffer< T >::Head ( ) const

inline

在文件 cache_buffer.h 第 53 行定义.

{ return head_ + 1; }

Mutex()

template<typename T >

std::mutex & apollo::cyber::data::CacheBuffer< T >::Mutex ( )

inline

在文件 cache_buffer.h 第 83 行定义.

{ return mutex_; }

operator[]()

template<typename T >

T & apollo::cyber::data::CacheBuffer< T >::operator[] ( const uint64_t &  pos )

inline

在文件 cache_buffer.h 第 50 行定义.

{ return buffer_[GetIndex(pos)]; }

SetFusionCallback()

template<typename T >

void apollo::cyber::data::CacheBuffer< T >::SetFusionCallback ( const FusionCallback &  callback )

inline

在文件 cache_buffer.h 第 64 行定义.

                                                         {
    fusion_callback_ = callback;
  }

Size()

template<typename T >

uint64_t apollo::cyber::data::CacheBuffer< T >::Size ( ) const

inline

在文件 cache_buffer.h 第 55 行定义.

{ return tail_ - head_; }

Tail()

template<typename T >

uint64_t apollo::cyber::data::CacheBuffer< T >::Tail ( ) const

inline

在文件 cache_buffer.h 第 54 行定义.

{ return tail_; }

---

该类的文档由以下文件生成:

• cyber/data/cache_buffer.h