apollo::planning::IndexedList< I, T > 模板类 参考

#include <indexed_list.h>

类 apollo::planning::IndexedList< I, T > 继承关系图:

apollo::planning::IndexedList< I, T > 的协作图:

Public 成员函数
T *	Add (const I id, const T &object)
	copy object into the container.
T *	Find (const I id)
	Find object by id in the container
const T *	Find (const I id) const
	Find object by id in the container
const std::vector< const T * > &	Items () const
	List all the items in the container.
const std::unordered_map< I, T > &	Dict () const
	List all the items in the container.
IndexedList &	operator= (const IndexedList &other)
	Copy the container with objects.

详细描述

template<typename I, typename T>
class apollo::planning::IndexedList< I, T >

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

成员函数说明

Add()

template<typename I , typename T >

T * apollo::planning::IndexedList< I, T >::Add ( const I  id, const T &  object  )

inline

copy object into the container.

If the id is already exist, overwrite the object in the container.

参数

id	the id of the object
object	the const reference of the objected to be copied to the container.

返回

The pointer to the object in the container.

在文件 indexed_list.h 第 45 行定义.

                                      {
    auto obs = Find(id);
    if (obs) {
      AWARN << "object " << id << " is already in container";
      *obs = object;
      return obs;
    } else {
      object_dict_.insert({id, object});
      auto* ptr = &object_dict_.at(id);
      object_list_.push_back(ptr);
      return ptr;
    }
  }

Dict()

template<typename I , typename T >

const std::unordered_map< I, T > & apollo::planning::IndexedList< I, T >::Dict ( ) const

inline

List all the items in the container.

返回

the unordered_map of ids and objects in the container.

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

{ return object_dict_; }

Find() [1/2]

template<typename I , typename T >

T * apollo::planning::IndexedList< I, T >::Find ( const I  id )

inline

Find object by id in the container

参数

id	the id of the object

返回

the raw pointer to the object if found.

nullptr if the object is not found.

在文件 indexed_list.h 第 65 行定义.

                      {
    return apollo::common::util::FindOrNull(object_dict_, id);
  }

Find() [2/2]

template<typename I , typename T >

const T * apollo::planning::IndexedList< I, T >::Find ( const I  id ) const

inline

Find object by id in the container

参数

id	the id of the object

返回

the raw pointer to the object if found.

nullptr if the object is not found.

在文件 indexed_list.h 第 75 行定义.

                                  {
    return apollo::common::util::FindOrNull(object_dict_, id);
  }

Items()

template<typename I , typename T >

const std::vector< const T * > & apollo::planning::IndexedList< I, T >::Items ( ) const

inline

List all the items in the container.

返回

the list of const raw pointers of the objects in the container.

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

{ return object_list_; }

operator=()

template<typename I , typename T >

IndexedList & apollo::planning::IndexedList< I, T >::operator= ( const IndexedList< I, T > &  other )

inline

Copy the container with objects.

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

                                                   {
    this->object_list_.clear();
    this->object_dict_.clear();
    for (const auto& item : other.Dict()) {
      Add(item.first, item.second);
    }
    return *this;
  }

---

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

• modules/planning/planning_base/common/indexed_list.h