CopperSpice API  1.7.2
QCache< Key, T > Class Template Reference

Provides a cache. More...

Public Methods

 QCache (int maxCost=100)
 
 ~QCache ()
 
void clear ()
 
bool contains (const Key &key) const
 
int count () const
 
bool insert (const Key &key, T *object, int cost=1)
 
bool isEmpty () const
 
QList< Key > keys () const
 
int maxCost () const
 
T * object (const Key &key) const
 
T * operator[] (const Key &key) const
 
bool remove (const Key &key)
 
void setMaxCost (int m)
 
int size () const
 
T * take (const Key &key)
 
int totalCost () const
 

Detailed Description

template<class Key, class T>
class QCache< Key, T >

The QCache class is a template which provides a cache. QCache<Key, T> defines a cache which stores objects of type T associated with keys of type Key.

For example, the following is a definition of a cache that stores objects of type Employee associated with an integer key:

Here is how to insert an object in the cache:

Employee *employee = new Employee;
employee->setId(37);
employee->setName("Richard Smith");
cache.insert(employee->id(), employee);

The advantage of using QCache over some other key-based data structure (such as QMap or QHash) is that QCache automatically takes ownership of the objects that are inserted into the cache and deletes them to make room for new objects, if necessary. When inserting an object into the cache, you can specify a cost, which should bear some approximate relationship to the amount of memory taken by the object. When the sum of all objects' costs (totalCost()) exceeds the cache's limit (maxCost()), QCache starts deleting objects in the cache to keep under the limit, starting with less recently accessed objects.

By default QCache's maxCost() is 100. You can specify a different value in the QCache constructor.

Each time you call insert(), you can specify a cost as third argument (after the key and a pointer to the object to insert). After the call, the inserted object is owned by the QCache, which may delete it at any time to make room for other objects.

To look up objects in the cache, use object() or operator[](). This function looks up an object by its key, and returns either a pointer to the cached object (which is owned by the cache) or 0.

If you want to remove an object from the cache for a particular key, call remove(). This will also delete the object. If you want to remove an object from the cache without the QCache deleting it, use take().

See also
QPixmapCache, QHash, QMap

Constructor & Destructor Documentation

template<class Key , class T >
QCache< Key, T >::QCache ( int  maxCost = 100)
inlineexplicit

Constructs a cache whose contents will never have a total cost greater than maxCost.

template<class Key , class T >
QCache< Key, T >::~QCache ( )
inline

Destroys the cache. Deletes all the objects in the cache.

Method Documentation

template<class Key , class T >
void QCache< Key, T >::clear ( )
inline

Deletes all the objects in the cache.

See also
remove(), take()
template<class Key , class T >
bool QCache< Key, T >::contains ( const Key &  key) const
inline

Returns true if the cache contains an object associated with key key, otherwise returns false.

See also
take(), remove()
template<class Key , class T >
int QCache< Key, T >::count ( ) const
inline

Equivalent to calling size().

template<class Key , class T >
bool QCache< Key, T >::insert ( const Key &  key,
T *  object,
int  cost = 1 
)

Inserts object into the cache with key key and associated cost cost. Any object with the same key already in the cache will be removed. After this call, object is owned by the QCache and may be deleted at any time. In particular, if cost is greater than maxCost(), the object will be deleted immediately.

The function returns true if the object was inserted into the cache, otherwise it returns false.

See also
take(), remove()
template<class Key , class T >
bool QCache< Key, T >::isEmpty ( ) const
inline

Returns true if the cache contains no objects, otherwise returns false.

See also
size()
template<class Key , class T >
QList< Key > QCache< Key, T >::keys ( ) const
inline

Returns a list of the keys in the cache.

template<class Key , class T >
int QCache< Key, T >::maxCost ( ) const
inline

Returns the maximum allowed total cost of the cache.

See also
setMaxCost(), totalCost()
template<class Key , class T >
T * QCache< Key, T >::object ( const Key &  key) const
inline

Returns the object associated with key key, or 0 if the key does not exist in the cache.

Warning
The returned object is owned by QCache and may be deleted at any time.
See also
take(), remove()
template<class Key , class T >
T * QCache< Key, T >::operator[] ( const Key &  key) const
inline

Returns the object associated with the given key or nullptr if the key does not exist in the cache. Equivalent to calling object().

Warning
The returned object is owned by QCache and may be deleted at any time.
template<class Key , class T >
bool QCache< Key, T >::remove ( const Key &  key)
inline

Deletes the object associated with key key. Returns true if the object was found in the cache, otherwise returns false.

See also
take(), clear()
template<class Key , class T >
void QCache< Key, T >::setMaxCost ( int  m)
inline

Sets the maximum allowed total cost of the cache to cost. If the current total cost is greater than cost, some objects are deleted immediately.

See also
maxCost(), totalCost()
template<class Key , class T >
int QCache< Key, T >::size ( ) const
inline

Returns the number of objects in the cache.

See also
isEmpty()
template<class Key , class T >
T * QCache< Key, T >::take ( const Key &  key)
inline

Takes the object associated with key key out of the cache without deleting it. Returns a pointer to the object taken out, or 0 if the key does not exist in the cache.

The ownership of the returned object is passed to the caller.

See also
remove()
template<class Key , class T >
int QCache< Key, T >::totalCost ( ) const
inline

Returns the total cost of the objects in the cache.

This value is normally below maxCost(), but QCache makes an exception for the CopperSpice implicitly shared classes. If a cached object shares its internal data with another instance, QCache may keep the object lying around, possibly contributing to making totalCost() larger than maxCost().

See also
setMaxCost()