Classes | Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
actionlib::ManagedList< T > Class Template Reference

wrapper around an STL list to help with reference counting Provides handles elements in an STL list. When all the handles go out of scope, the element in the list is destroyed. More...

#include <managed_list.h>

Classes

class  ElemDeleter
 
class  Handle
 
class  iterator
 
struct  TrackedElem
 

Public Types

typedef boost::function< void(iterator)> CustomDeleter
 

Public Member Functions

Handle add (const T &elem)
 Add an element to the back of the ManagedList. More...
 
Handle add (const T &elem, CustomDeleter custom_deleter, const boost::shared_ptr< DestructionGuard > &guard)
 Add an element to the back of the ManagedList, along with a Custom deleter. More...
 
iterator begin ()
 
iterator end ()
 
void erase (iterator it)
 Removes an element from the ManagedList. More...
 
 ManagedList ()
 

Private Member Functions

void defaultDeleter (iterator it)
 

Private Attributes

std::list< TrackedElemlist_
 

Detailed Description

template<class T>
class actionlib::ManagedList< T >

wrapper around an STL list to help with reference counting Provides handles elements in an STL list. When all the handles go out of scope, the element in the list is destroyed.

Definition at line 88 of file managed_list.h.

Member Typedef Documentation

◆ CustomDeleter

template<class T >
typedef boost::function<void (iterator)> actionlib::ManagedList< T >::CustomDeleter

Definition at line 152 of file managed_list.h.

Constructor & Destructor Documentation

◆ ManagedList()

template<class T >
actionlib::ManagedList< T >::ManagedList ( )
inline

Definition at line 278 of file managed_list.h.

Member Function Documentation

◆ add() [1/2]

template<class T >
Handle actionlib::ManagedList< T >::add ( const T &  elem)
inline

Add an element to the back of the ManagedList.

Definition at line 283 of file managed_list.h.

◆ add() [2/2]

template<class T >
Handle actionlib::ManagedList< T >::add ( const T &  elem,
CustomDeleter  custom_deleter,
const boost::shared_ptr< DestructionGuard > &  guard 
)
inline

Add an element to the back of the ManagedList, along with a Custom deleter.

Parameters
elemThe element we want to add
deleterObject on which operator() is called when refcount goes to 0

Definition at line 293 of file managed_list.h.

◆ begin()

template<class T >
iterator actionlib::ManagedList< T >::begin ( )
inline

Definition at line 319 of file managed_list.h.

◆ defaultDeleter()

template<class T >
void actionlib::ManagedList< T >::defaultDeleter ( iterator  it)
inlineprivate

Definition at line 322 of file managed_list.h.

◆ end()

template<class T >
iterator actionlib::ManagedList< T >::end ( )
inline

Definition at line 318 of file managed_list.h.

◆ erase()

template<class T >
void actionlib::ManagedList< T >::erase ( iterator  it)
inline

Removes an element from the ManagedList.

Definition at line 313 of file managed_list.h.

Member Data Documentation

◆ list_

template<class T >
std::list<TrackedElem> actionlib::ManagedList< T >::list_
private

Definition at line 326 of file managed_list.h.


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


actionlib
Author(s): Eitan Marder-Eppstein, Vijay Pradeep, Mikael Arguedas
autogenerated on Fri May 19 2023 02:36:55