Developer Documentation

Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
ObjectIDPointerManagerT< Pointer > Class Template Reference

`#include <OpenFlipper/common/ObjectIDPointerManagerT.hh>`

## Public Types
typedef std::map< int, Pointer > | PointerObjectIDMap
| typedef for the idmap
typedef std::pair< int, Pointer > | PointerObjectIDPair
| typedef for the pairs

## Public Member Functions
| ObjectIDPointerManagerT ()
| Constructor.
| ~ObjectIDPointerManagerT ()
| Destructor.
bool | get_pointer (int _identifier, Pointer &_pointer)
Pointer | get_pointer (int _identifier)
bool | add_pointer (int _identifier, const Pointer &_pointer)
bool | delete_object (int _identifier)
| Doesn't actually delete object (pointed to by pointer) only clears entry from the map.
void | get_object_ids (std::vector< int > &_ids)

## Private Member Functions
| ObjectIDPointerManagerT (const ObjectIDPointerManagerT &_rhs)
| Copy constructor (not used)
ObjectIDPointerManagerT & | operator= (const ObjectIDPointerManagerT &_rhs)
| Assignment operator (not used)

## Private Attributes
PointerObjectIDMap | pointer_objectID_map_
| mapping

## Detailed Description

### template<class Pointer>
class ObjectIDPointerManagerT< Pointer >

Use this class to manage pointers associated with an object in the framework.

Definition at line 68 of file ObjectIDPointerManagerT.hh.

## Member Function Documentation

## ◆ add_pointer()

template<class Pointer >

bool ObjectIDPointerManagerT< Pointer >::add_pointer | ( | int | _identifier,
|  | const Pointer & | _pointer
| ) |  |

Add a pointer to the map

Parameters

  _identifier | identifier of corresponding object
  _pointer | pointer to be added

Definition at line 89 of file ObjectIDPointerManagerT_impl.hh.

## ◆ get_pointer() [1/2]

template<class Pointer >

bool ObjectIDPointerManagerT< Pointer >::get_pointer | ( | int | _identifier,
|  | Pointer & | _pointer
| ) |  |

try to get a pointer with the given id

Parameters

  _identifier | identifier of corresponding object
  _pointer | The returned pointer

Returns
  true if object exists

Definition at line 60 of file ObjectIDPointerManagerT_impl.hh.

## ◆ get_pointer() [2/2]

template<class Pointer >

Pointer ObjectIDPointerManagerT< Pointer >::get_pointer | ( | int | _identifier | ) |

try to get a pointer with the given id

Parameters

  _identifier | identifier of corresponding object

Returns
  returns either a pointer or if the id does not exist NULL

Definition at line 78 of file ObjectIDPointerManagerT_impl.hh.

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

- OpenFlipper/common/ObjectIDPointerManagerT.hh
- OpenFlipper/common/ObjectIDPointerManagerT_impl.hh