/MapView/Map/RMTileCache.h

 1//
 2//  RMTileCache.h
 3//
 4// Copyright (c) 2008-2009, Route-Me Contributors
 5// All rights reserved.
 6//
 7// Redistribution and use in source and binary forms, with or without
 8// modification, are permitted provided that the following conditions are met:
 9//
10// * Redistributions of source code must retain the above copyright notice, this
11//   list of conditions and the following disclaimer.
12// * Redistributions in binary form must reproduce the above copyright notice,
13//   this list of conditions and the following disclaimer in the documentation
14//   and/or other materials provided with the distribution.
15//
16// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
20// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26// POSSIBILITY OF SUCH DAMAGE.
27
28#import <Foundation/Foundation.h>
29#import "RMTile.h"
30#import "RMTileSource.h"
31
32@class RMTileImage;
33
34typedef enum {
35	RMCachePurgeStrategyLRU,
36	RMCachePurgeStrategyFIFO,
37} RMCachePurgeStrategy;
38
39
40@protocol RMTileCache<NSObject>
41
42/// Returns the cached image if it exists. nil otherwise.
43-(RMTileImage*) cachedImage:(RMTile)tile;
44-(void)didReceiveMemoryWarning;
45
46@optional
47
48-(void)addTile: (RMTile)tile WithImage: (RMTileImage*)image;
49/// removes all tile images from the memory and disk subcaches
50-(void)removeAllCachedImages;
51
52@end
53
54
55@interface RMTileCache : NSObject<RMTileCache>
56{
57	NSMutableArray *caches;
58}
59
60-(id)initWithTileSource: (id<RMTileSource>) tileSource;
61
62+(NSNumber*) tileHash: (RMTile)tile;
63
64/// Add tile to cache
65/*! 
66 \bug Calls -makeSpaceInCache for every tile/image addition. -makeSpaceInCache does a linear scan of its contents at each call.
67
68 \bug Since RMTileImage has an RMTile ivar, this API should be simplified to just -addImage:.
69 */
70-(void)addTile: (RMTile)tile WithImage: (RMTileImage*)image;
71
72/// Add another cache to the chain
73-(void)addCache: (id<RMTileCache>)cache;
74
75-(void)didReceiveMemoryWarning;
76
77@end