apollo::localization::msf::BaseMapNodePool类 参考

The memory pool for the data structure of BaseMapNode. 更多...

#include <base_map_pool.h>

类 apollo::localization::msf::BaseMapNodePool 继承关系图:

apollo::localization::msf::BaseMapNodePool 的协作图:

Public 成员函数
	BaseMapNodePool (unsigned int pool_size, unsigned int thread_size)
	Constructor
virtual	~BaseMapNodePool ()
	Destructor
void	Initial (const BaseMapConfig *map_config, bool is_fixed_size=true)
	Initialize the pool.
void	Release ()
	Release the pool.
BaseMapNode *	AllocMapNode ()
	Get a MapNode object from memory pool.
void	FreeMapNode (BaseMapNode *map_node)
	Release MapNode object to memory pool.
unsigned int	GetPoolSize ()
	Get the size of pool.

Protected 属性
bool	is_fixed_size_
	The flag of pool auto expand.
std::list< BaseMapNode * >	free_list_
	The list for free node.
std::set< BaseMapNode * >	busy_nodes_
	The set for used node.
unsigned int	pool_size_
	The size of memory pool.
std::future< void >	node_reset_workers_
	The thread pool for release node.
boost::mutex	mutex_
	The mutex for release thread.
const BaseMapConfig *	map_config_
	The mutex for release thread.

详细描述

The memory pool for the data structure of BaseMapNode.

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

构造及析构函数说明

BaseMapNodePool()

apollo::localization::msf::BaseMapNodePool::BaseMapNodePool	(	unsigned int	pool_size,
		unsigned int	thread_size
	)

Constructor

参数

<pool_size>	The memory pool size.
<thread_size>	The thread pool size.

在文件 base_map_pool.cc 第 28 行定义.

    : pool_size_(pool_size) {}

~BaseMapNodePool()

apollo::localization::msf::BaseMapNodePool::~BaseMapNodePool ( )

virtual

Destructor

在文件 base_map_pool.cc 第 32 行定义.

{ Release(); }

成员函数说明

AllocMapNode()

BaseMapNode * apollo::localization::msf::BaseMapNodePool::AllocMapNode

(

)

Get a MapNode object from memory pool.

参数

<return>

The MapNode object.

在文件 base_map_pool.cc 第 62 行定义.

                                           {
  if (free_list_.empty()) {
    if (node_reset_workers_.valid()) {
      node_reset_workers_.wait();
    }
  }
  boost::unique_lock<boost::mutex> lock(mutex_);
  if (free_list_.empty()) {
    if (is_fixed_size_) {
      return nullptr;
    }
    BaseMapNode* node = AllocNewMapNode();
    InitNewMapNode(node);
    pool_size_++;
    busy_nodes_.insert(node);
    return node;
  } else {
    BaseMapNode* node = free_list_.front();
    free_list_.pop_front();
    busy_nodes_.insert(node);
    return node;
  }
}

FreeMapNode()

void apollo::localization::msf::BaseMapNodePool::FreeMapNode

(

BaseMapNode *

map_node

)

Release MapNode object to memory pool.

参数

<map_node>

The released MapNode object.

在文件 base_map_pool.cc 第 86 行定义.

                                                       {
  node_reset_workers_ =
      cyber::Async(&BaseMapNodePool::FreeMapNodeTask, this, map_node);
}

GetPoolSize()

unsigned int apollo::localization::msf::BaseMapNodePool::GetPoolSize ( )

inline

Get the size of pool.

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

{ return pool_size_; }

Initial()

void apollo::localization::msf::BaseMapNodePool::Initial	(	const BaseMapConfig *	map_config,
		bool	is_fixed_size = true
	)

Initialize the pool.

参数

<map_config>	The map option.
<is_fixed_size>	The flag of pool auto expand.

在文件 base_map_pool.cc 第 34 行定义.

                                                  {
  is_fixed_size_ = is_fixed_size;
  map_config_ = map_config;
  for (unsigned int i = 0; i < pool_size_; ++i) {
    BaseMapNode* node = AllocNewMapNode();
    InitNewMapNode(node);
    free_list_.push_back(node);
  }
}

Release()

void apollo::localization::msf::BaseMapNodePool::Release

(

)

Release the pool.

在文件 base_map_pool.cc 第 45 行定义.

                              {
  if (node_reset_workers_.valid()) {
    node_reset_workers_.get();
  }
  for (BaseMapNode* node : free_list_) {
    FinalizeMapNode(node);
    DellocMapNode(node);
  }
  free_list_.clear();
  for (BaseMapNode* node : busy_nodes_) {
    FinalizeMapNode(node);
    DellocMapNode(node);
  }
  busy_nodes_.clear();
  pool_size_ = 0;
}

类成员变量说明

busy_nodes_

std::set<BaseMapNode*> apollo::localization::msf::BaseMapNodePool::busy_nodes_

protected

The set for used node.

在文件 base_map_pool.h 第 81 行定义.

free_list_

std::list<BaseMapNode*> apollo::localization::msf::BaseMapNodePool::free_list_

protected

The list for free node.

在文件 base_map_pool.h 第 79 行定义.

is_fixed_size_

bool apollo::localization::msf::BaseMapNodePool::is_fixed_size_

protected

The flag of pool auto expand.

在文件 base_map_pool.h 第 77 行定义.

map_config_

const BaseMapConfig* apollo::localization::msf::BaseMapNodePool::map_config_

protected

The mutex for release thread.

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

mutex_

boost::mutex apollo::localization::msf::BaseMapNodePool::mutex_

protected

The mutex for release thread.

在文件 base_map_pool.h 第 87 行定义.

node_reset_workers_

std::future<void> apollo::localization::msf::BaseMapNodePool::node_reset_workers_

protected

The thread pool for release node.

在文件 base_map_pool.h 第 85 行定义.

pool_size_

unsigned int apollo::localization::msf::BaseMapNodePool::pool_size_

protected

The size of memory pool.

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

---

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

• modules/localization/msf/local_map/base_map/base_map_pool.h
• modules/localization/msf/local_map/base_map/base_map_pool.cc