Developer Documentation

ObjectIDPointerManagerT_impl.hh
1 /*===========================================================================*\
2 * *
3 * OpenFlipper *
4 * Copyright (c) 2001-2015, RWTH-Aachen University *
5 * Department of Computer Graphics and Multimedia *
6 * All rights reserved. *
7 * www.openflipper.org *
8 * *
9 *---------------------------------------------------------------------------*
10 * This file is part of OpenFlipper. *
11 *---------------------------------------------------------------------------*
12 * *
13 * Redistribution and use in source and binary forms, with or without *
14 * modification, are permitted provided that the following conditions *
15 * are met: *
16 * *
17 * 1. Redistributions of source code must retain the above copyright notice, *
18 * this list of conditions and the following disclaimer. *
19 * *
20 * 2. Redistributions in binary form must reproduce the above copyright *
21 * notice, this list of conditions and the following disclaimer in the *
22 * documentation and/or other materials provided with the distribution. *
23 * *
24 * 3. Neither the name of the copyright holder nor the names of its *
25 * contributors may be used to endorse or promote products derived from *
26 * this software without specific prior written permission. *
27 * *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39 * *
40 \*===========================================================================*/
41
42
43 //=============================================================================
44 //
45 // CLASS ObjectIDPointerManagerT - IMPLEMENTATION
46 //
47 //=============================================================================
48
49 #define OBJECTIDPOINTERMANAGERT_C
50
51 //== INCLUDES =================================================================
52
53 #include "ObjectIDPointerManagerT.hh"
54
55 //== NAMESPACES ===============================================================
56
57 //== IMPLEMENTATION ==========================================================
58
59 template< class Pointer >
60 bool ObjectIDPointerManagerT<Pointer>::get_pointer(int _identifier, Pointer & _pointer) {
61 typename PointerObjectIDMap::iterator po_itr;
62 typename PointerObjectIDMap::iterator po_itr_end = pointer_objectID_map_.end();
63
64 po_itr = pointer_objectID_map_.find(_identifier);
65
66 // Last position reached = no element with ID _identifier in map
67 if (po_itr == po_itr_end)
68 return false;
69
70 // Give pointer back
71 _pointer = (Pointer)po_itr->second;
72 return true;
73 }
74
75 //-----------------------------------------------------------------------------
76
77 template< class Pointer >
78 Pointer ObjectIDPointerManagerT<Pointer>::get_pointer(int _identifier) {
79 Pointer tmp;
80 if ( get_pointer(_identifier,tmp) )
81 return tmp;
82 else
83 return NULL;
84 }
85
86 //-----------------------------------------------------------------------------
87
88 template< class Pointer >
89 bool ObjectIDPointerManagerT<Pointer>::add_pointer(int _identifier, const Pointer & _pointer) {
90 typename PointerObjectIDMap::iterator po_itr;
91 typename PointerObjectIDMap::iterator po_itr_end = pointer_objectID_map_.end();
92
93 po_itr = pointer_objectID_map_.find(_identifier);
94
95 // Was already there
96 if (po_itr != po_itr_end)
97 return false;
98
99 pointer_objectID_map_.insert(PointerObjectIDPair(_identifier, _pointer));
100 return true;
101 }
102
103 //-----------------------------------------------------------------------------
104
105 template< class Pointer >
106 bool ObjectIDPointerManagerT<Pointer>::delete_object(int _identifier) {
107 typename PointerObjectIDMap::iterator po_itr;
108 typename PointerObjectIDMap::iterator po_itr_end = pointer_objectID_map_.end();
109
110 po_itr = pointer_objectID_map_.find(_identifier);
111
112 // Last position reached = no element with ID _identifier in map
113 if (po_itr == po_itr_end)
114 return false;
115
116 pointer_objectID_map_.erase(_identifier);
117 return true;
118 }
119
120 //-----------------------------------------------------------------------------
121
122 template< class Pointer >
123 void ObjectIDPointerManagerT<Pointer>::get_object_ids(std::vector<int> & _ids)
124 {
125 _ids.clear();
126
127 typename PointerObjectIDMap::iterator po_itr;
128 typename PointerObjectIDMap::iterator po_itr_end = pointer_objectID_map_.end();
129
130 for (po_itr = pointer_objectID_map_.begin(); po_itr != po_itr_end; ++po_itr)
131 _ids.push_back((*po_itr).first);
132 }
133
134 //-----------------------------------------------------------------------------
135
136 //=============================================================================
137 //=============================================================================
ObjectIDPointerManagerT::get_pointer
bool get_pointer(int _identifier, Pointer &_pointer)
Definition: ObjectIDPointerManagerT_impl.hh:60
ObjectIDPointerManagerT::delete_object
bool delete_object(int _identifier)
Doesn&#39;t actually delete object (pointed to by pointer) only clears entry from the map...
Definition: ObjectIDPointerManagerT_impl.hh:106
ObjectIDPointerManagerT::PointerObjectIDPair
std::pair< int, Pointer > PointerObjectIDPair
typedef for the pairs
Definition: ObjectIDPointerManagerT.hh:77
ObjectIDPointerManagerT
Definition: ObjectIDPointerManagerT.hh:68
ObjectIDPointerManagerT::add_pointer
bool add_pointer(int _identifier, const Pointer &_pointer)
Definition: ObjectIDPointerManagerT_impl.hh:89