Cortex  10.0.0-a4
ObjectPool.h
1 //
3 // Copyright (c) 2013, Image Engine Design Inc. All rights reserved.
4 //
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions are
7 // met:
8 //
9 // * Redistributions of source code must retain the above copyright
10 // notice, this list of conditions and the following disclaimer.
11 //
12 // * Redistributions in binary form must reproduce the above copyright
13 // notice, this list of conditions and the following disclaimer in the
14 // documentation and/or other materials provided with the distribution.
15 //
16 // * Neither the name of Image Engine Design nor the names of any
17 // other contributors to this software may be used to endorse or
18 // promote products derived from this software without specific prior
19 // written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
22 // IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
23 // THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
25 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
28 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 //
34 
35 #ifndef IECORE_OBJECTPOOL_H
36 #define IECORE_OBJECTPOOL_H
37 
38 #include "boost/shared_ptr.hpp"
39 
40 #include "IECore/Export.h"
41 #include "IECore/Object.h"
42 #include "IECore/MurmurHash.h"
43 
44 namespace IECore
45 {
46 
47 IE_CORE_FORWARDDECLARE( ObjectPool );
48 
54 
60 class IECORE_API ObjectPool : public RefCounted
61 {
62  public:
63 
64  IE_CORE_DECLAREMEMBERPTR( ObjectPool );
65 
66  ObjectPool( size_t maxMemory );
67  ~ObjectPool() override;
68 
69  // Clears all the objects in the pool
70  void clear();
71 
72  // Erases the Object with the given hash if it is held in the pool. Returns whether any item was removed.
73  bool erase( const MurmurHash &hash );
74 
76  void setMaxMemoryUsage( size_t maxMemory );
77 
79  size_t getMaxMemoryUsage() const;
80 
82  size_t memoryUsage() const;
83 
86  bool contains( const MurmurHash &hash ) const;
87 
89  ConstObjectPtr retrieve( const MurmurHash &hash ) const;
90 
92  enum StoreMode
93  {
94  StoreCopy = 0,
95  StoreReference,
96  };
97 
102  ConstObjectPtr store( const Object *obj, StoreMode mode );
103 
111  static ObjectPool *defaultObjectPool();
112 
113  private:
114 
115  struct MemberData;
116  boost::shared_ptr<MemberData> m_data;
117 };
118 
119 } // namespace IECore
120 
121 #endif // IECORE_OBJECTPOOL_H
122 
Definition: ObjectPool.h:60
Definition: Object.h:104
Definition: MurmurHash.h:64
StoreMode
Enum used to specify how to store the pointer passed to the store() function.
Definition: ObjectPool.h:92
Definition: RefCounted.h:124
This namespace contains all components of the core library.
Definition: AddSmoothSkinningInfluencesOp.h:43