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 #pragma once
43
44
45 //== INCLUDES =================================================================
46
47 #include <map>
48 #include <vector>
49 #include <iostream>
50
51 #ifndef WIN32
52 #warning Included deprecated Header ObjectIDPointerManger
53 #warning You can attach data to objects by using the perObjectData class!
54 #warning Derive from perObjectData and use setObjectData on an Object
55 #warning to attach the data to it. You can read the data by using
56 #warning the objectData function of each object.
57 #endif
58
59 //== FORWARDDECLARATIONS ======================================================
60
61 //== NAMESPACES ===============================================================
62
63 //== CLASS DEFINITION =========================================================
64
67 template < class Pointer >
68 class ObjectIDPointerManagerT
69 {
70
71 public:
72
74 typedef std::map< int, Pointer > PointerObjectIDMap;
75
77 typedef std::pair< int, Pointer > PointerObjectIDPair;
78
80 ObjectIDPointerManagerT() {}
81
83 ~ObjectIDPointerManagerT() {}
84
90 bool get_pointer(int _identifier, Pointer & _pointer);
91
96 Pointer get_pointer(int _identifier);
97
102 bool add_pointer(int _identifier, const Pointer & _pointer);
103
105 bool delete_object(int _identifier);
106
107 void get_object_ids(std::vector<int> & _ids);
108
109 private:
110
112 ObjectIDPointerManagerT(const ObjectIDPointerManagerT& _rhs);
113
115 ObjectIDPointerManagerT& operator=(const ObjectIDPointerManagerT& _rhs);
116
118 PointerObjectIDMap pointer_objectID_map_;
119 };
120
121
122 //=============================================================================
123 #if defined(INCLUDE_TEMPLATES) && !defined(OBJECTIDPOINTERMANAGERT_C)
124 #define OBJECTIDPOINTERMANAGERT_TEMPLATES
125 #include "ObjectIDPointerManagerT_impl.hh"
126 #endif
127
128
ObjectIDPointerManagerT::PointerObjectIDMap
std::map< int, Pointer > PointerObjectIDMap
typedef for the idmap
Definition: ObjectIDPointerManagerT.hh:74
ObjectIDPointerManagerT::add_pointer
bool add_pointer(int _identifier, const Pointer &_pointer)
Definition: ObjectIDPointerManagerT_impl.hh:89
ObjectIDPointerManagerT::operator=
ObjectIDPointerManagerT & operator=(const ObjectIDPointerManagerT &_rhs)
Assignment operator (not used)
ObjectIDPointerManagerT::get_pointer
bool get_pointer(int _identifier, Pointer &_pointer)
Definition: ObjectIDPointerManagerT_impl.hh:60
ObjectIDPointerManagerT::PointerObjectIDPair
std::pair< int, Pointer > PointerObjectIDPair
typedef for the pairs
Definition: ObjectIDPointerManagerT.hh:77
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::ObjectIDPointerManagerT
ObjectIDPointerManagerT()
Constructor.
Definition: ObjectIDPointerManagerT.hh:80
ObjectIDPointerManagerT::pointer_objectID_map_
PointerObjectIDMap pointer_objectID_map_
mapping
Definition: ObjectIDPointerManagerT.hh:118
ObjectIDPointerManagerT::~ObjectIDPointerManagerT
~ObjectIDPointerManagerT()
Destructor.
Definition: ObjectIDPointerManagerT.hh:83
ObjectIDPointerManagerT
Definition: ObjectIDPointerManagerT.hh:68