apollo::cyber::transport::History< MessageT > 模板类 参考

#include <history.h>

apollo::cyber::transport::History< MessageT > 的协作图:

类
struct	CachedMessage

Public 类型
using	MessagePtr = std::shared_ptr< MessageT >

Public 成员函数
	History (const HistoryAttributes &attr)
virtual	~History ()
void	Enable ()
void	Disable ()
void	Add (const MessagePtr &msg, const MessageInfo &msg_info)
void	Clear ()
void	GetCachedMessage (std::vector< CachedMessage > *msgs) const
size_t	GetSize () const
uint32_t	depth () const
uint32_t	max_depth () const

详细描述

template<typename MessageT>
class apollo::cyber::transport::History< MessageT >

在文件 history.h 第 35 行定义.

成员类型定义说明

MessagePtr

template<typename MessageT >

using apollo::cyber::transport::History< MessageT >::MessagePtr = std::shared_ptr<MessageT>

在文件 history.h 第 37 行定义.

构造及析构函数说明

History()

template<typename MessageT >

apollo::cyber::transport::History< MessageT >::History ( const HistoryAttributes &  attr )

explicit

在文件 history.h 第 69 行定义.

    : enabled_(false), max_depth_(1000) {
  auto& global_conf = common::GlobalData::Instance()->Config();
  if (global_conf.has_transport_conf() &&
      global_conf.transport_conf().has_resource_limit()) {
    max_depth_ =
        global_conf.transport_conf().resource_limit().max_history_depth();
  }
 
  if (attr.history_policy == proto::QosHistoryPolicy::HISTORY_KEEP_ALL) {
    depth_ = max_depth_;
  } else {
    depth_ = attr.depth;
    if (depth_ > max_depth_) {
      depth_ = max_depth_;
    }
  }
}

~History()

template<typename MessageT >

apollo::cyber::transport::History< MessageT >::~History ( )

virtual

在文件 history.h 第 89 行定义.

                            {
  Clear();
}

成员函数说明

Add()

template<typename MessageT >

void apollo::cyber::transport::History< MessageT >::Add	(	const MessagePtr &	msg,
		const MessageInfo &	msg_info
	)

在文件 history.h 第 94 行定义.

                                                         {
  if (!enabled_) {
    return;
  }
  std::lock_guard<std::mutex> lock(msgs_mutex_);
  msgs_.emplace_back(msg, msg_info);
  while (msgs_.size() > depth_) {
    msgs_.pop_front();
  }
}

Clear()

template<typename MessageT >

void apollo::cyber::transport::History< MessageT >::Clear

(

)

在文件 history.h 第 107 行定义.

                              {
  std::lock_guard<std::mutex> lock(msgs_mutex_);
  msgs_.clear();
}

depth()

template<typename MessageT >

uint32_t apollo::cyber::transport::History< MessageT >::depth ( ) const

inline

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

{ return depth_; }

Disable()

template<typename MessageT >

void apollo::cyber::transport::History< MessageT >::Disable ( )

inline

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

{ enabled_ = false; }

Enable()

template<typename MessageT >

void apollo::cyber::transport::History< MessageT >::Enable ( )

inline

在文件 history.h 第 49 行定义.

{ enabled_ = true; }

GetCachedMessage()

template<typename MessageT >

void apollo::cyber::transport::History< MessageT >::GetCachedMessage

(

std::vector< CachedMessage > *

msgs

)

const

在文件 history.h 第 113 行定义.

                                          {
  if (msgs == nullptr) {
    return;
  }
 
  std::lock_guard<std::mutex> lock(msgs_mutex_);
  msgs->reserve(msgs_.size());
  msgs->insert(msgs->begin(), msgs_.begin(), msgs_.end());
}

GetSize()

template<typename MessageT >

size_t apollo::cyber::transport::History< MessageT >::GetSize

(

)

const

在文件 history.h 第 125 行定义.

                                        {
  std::lock_guard<std::mutex> lock(msgs_mutex_);
  return msgs_.size();
}

max_depth()

template<typename MessageT >

uint32_t apollo::cyber::transport::History< MessageT >::max_depth ( ) const

inline

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

{ return max_depth_; }

---

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

• cyber/transport/message/history.h