actionlib::ManagedList< T >::Handle Class Reference

#include <managed_list.h>

List of all members.

Public Member Functions

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

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 114 of file managed_list.h.


Constructor & Destructor Documentation

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

Construct an empty handle.

Definition at line 120 of file managed_list.h.

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

Definition at line 165 of file managed_list.h.


Member Function Documentation

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 146 of file managed_list.h.

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

Definition at line 122 of file managed_list.h.

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

Checks if two handles point to the same list elem.

Definition at line 155 of file managed_list.h.

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 134 of file managed_list.h.


Friends And Related Function Documentation

template<class T>
friend class iterator [friend]

Definition at line 163 of file managed_list.h.

template<class T>
friend class ManagedList [friend]

Definition at line 160 of file managed_list.h.


Member Data Documentation

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

Definition at line 170 of file managed_list.h.

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

Definition at line 169 of file managed_list.h.

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

Definition at line 171 of file managed_list.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


actionlib
Author(s): Eitan Marder-Eppstein, Vijay Pradeep
autogenerated on Fri Jan 11 09:41:44 2013