Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
actionlib::ManagedList< T >::Handle Class Reference

#include <managed_list.h>

Public Member Functions

T & getElem ()
 get the list element that this handle points to fails/asserts if this is an empty handle More...
 
const T & getElem () const
 
 Handle ()
 Construct an empty handle. More...
 
 Handle (const Handle &rhs)
 
Handleoperator= (const Handle &rhs)
 
bool operator== (const Handle &rhs) const
 Checks if two handles point to the same list elem. More...
 
void reset ()
 stop tracking the list element with this handle, even though the Handle hasn't gone out of scope More...
 

Private Member Functions

 Handle (const boost::shared_ptr< void > &handle_tracker, iterator it)
 

Private Attributes

boost::shared_ptr< void > handle_tracker_
 
iterator it_
 
bool valid_
 

Friends

class iterator
 
class ManagedList
 

Detailed Description

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

Definition at line 185 of file managed_list.h.

Constructor & Destructor Documentation

◆ Handle() [1/3]

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

Construct an empty handle.

Definition at line 191 of file managed_list.h.

◆ Handle() [2/3]

template<class T >
actionlib::ManagedList< T >::Handle::Handle ( const Handle rhs)
inline

Definition at line 204 of file managed_list.h.

◆ Handle() [3/3]

template<class T >
actionlib::ManagedList< T >::Handle::Handle ( const boost::shared_ptr< void > &  handle_tracker,
iterator  it 
)
inlineprivate

Definition at line 269 of file managed_list.h.

Member Function Documentation

◆ getElem() [1/2]

template<class T >
T& actionlib::ManagedList< T >::Handle::getElem ( )
inline

get the list element that this handle points to fails/asserts if this is an empty handle

Returns
Reference to the element this handle points to

Definition at line 229 of file managed_list.h.

◆ getElem() [2/2]

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

Definition at line 238 of file managed_list.h.

◆ operator=()

template<class T >
Handle& actionlib::ManagedList< T >::Handle::operator= ( const Handle rhs)
inline

Definition at line 194 of file managed_list.h.

◆ operator==()

template<class T >
bool actionlib::ManagedList< T >::Handle::operator== ( const Handle rhs) const
inline

Checks if two handles point to the same list elem.

Definition at line 250 of file managed_list.h.

◆ reset()

template<class T >
void actionlib::ManagedList< T >::Handle::reset ( )
inline

stop tracking the list element with this handle, even though the Handle hasn't gone out of scope

Definition at line 213 of file managed_list.h.

Friends And Related Function Documentation

◆ iterator

template<class T >
friend class iterator
friend

Definition at line 266 of file managed_list.h.

◆ ManagedList

template<class T >
friend class ManagedList
friend

Definition at line 263 of file managed_list.h.

Member Data Documentation

◆ handle_tracker_

template<class T >
boost::shared_ptr<void> actionlib::ManagedList< T >::Handle::handle_tracker_
private

Definition at line 274 of file managed_list.h.

◆ it_

template<class T >
iterator actionlib::ManagedList< T >::Handle::it_
private

Definition at line 273 of file managed_list.h.

◆ valid_

template<class T >
bool actionlib::ManagedList< T >::Handle::valid_
private

Definition at line 275 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