Developer Documentation
ObjectIDPointerManagerT.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 * $Revision$ *
45 * $LastChangedBy$ *
46 * $Date$ *
47 * *
48 \*===========================================================================*/
49 
50 
51 
52 
53 //=============================================================================
54 //
55 // CLASS ObjectIDPointerManagerT
56 //
57 //
58 // Author: Henrik Zimmer <henrik@zimmer.to>
59 //
60 // Version: $Revision: 1$
61 // Date: $Author$
62 // $Date: XX-XX-200X$
63 //
64 //=============================================================================
65 
66 
67 #ifndef OBJECTIDPOINTERMANAGERT_HH
68 #define OBJECTIDPOINTERMANAGERT_HH
69 
70 
71 //== INCLUDES =================================================================
72 
73 #include <map>
74 #include <vector>
75 #include <iostream>
76 
77 #ifndef WIN32
78 #warning Included deprecated Header ObjectIDPointerManger
79 #warning You can attach data to objects by using the perObjectData class!
80 #warning Derive from perObjectData and use setObjectData on an Object
81 #warning to attach the data to it. You can read the data by using
82 #warning the objectData function of each object.
83 #endif
84 
85 //== FORWARDDECLARATIONS ======================================================
86 
87 //== NAMESPACES ===============================================================
88 
89 //== CLASS DEFINITION =========================================================
90 
93 template < class Pointer >
95 {
96 
97 public:
98 
100  typedef std::map< int, Pointer > PointerObjectIDMap;
101 
103  typedef std::pair< int, Pointer > PointerObjectIDPair;
104 
107 
110 
116  bool get_pointer(int _identifier, Pointer & _pointer);
117 
122  Pointer get_pointer(int _identifier);
123 
128  bool add_pointer(int _identifier, const Pointer & _pointer);
129 
131  bool delete_object(int _identifier);
132 
133  void get_object_ids(std::vector<int> & _ids);
134 
135 private:
136 
139 
142 
144  PointerObjectIDMap pointer_objectID_map_;
145 };
146 
147 
148 //=============================================================================
149 #if defined(INCLUDE_TEMPLATES) && !defined(OBJECTIDPOINTERMANAGERT_C)
150 #define OBJECTIDPOINTERMANAGERT_TEMPLATES
151 #include "ObjectIDPointerManagerT.cc"
152 #endif
153 //=============================================================================
154 #endif // OBJECTIDPOINTERMANAGERT_HH defined
155 //=============================================================================
156 
std::map< int, Pointer > PointerObjectIDMap
typedef for the idmap
std::pair< int, Pointer > PointerObjectIDPair
typedef for the pairs
bool delete_object(int _identifier)
Doesn&#39;t actually delete object (pointed to by pointer) only clears entry from the map...
ObjectIDPointerManagerT & operator=(const ObjectIDPointerManagerT &_rhs)
Assignment operator (not used)
bool get_pointer(int _identifier, Pointer &_pointer)
bool add_pointer(int _identifier, const Pointer &_pointer)
PointerObjectIDMap pointer_objectID_map_
mapping