/usr/include/osgEarth/Cache is in libosgearth-dev 2.5.0+dfsg-8build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 | /* -*-c++-*- */
/* osgEarth - Dynamic map generation toolkit for OpenSceneGraph
* Copyright 2008-2013 Pelican Mapping
* http://osgearth.org
*
* osgEarth is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>
*/
#ifndef OSGEARTH_CACHE_H
#define OSGEARTH_CACHE_H 1
#include <osgEarth/Common>
#include <osgEarth/CacheBin>
#include <osgEarth/Config>
#include <osgEarth/TileKey>
#include <osgEarth/ThreadingUtils>
namespace osgEarth
{
/**
* Base class for Cache implementation options.
*/
class OSGEARTH_EXPORT CacheOptions : public DriverConfigOptions
{
public:
CacheOptions( const ConfigOptions& options =ConfigOptions() )
: DriverConfigOptions( options )
{
fromConfig( _conf );
}
/** dtor */
virtual ~CacheOptions();
public:
virtual Config getConfig() const {
return ConfigOptions::getConfig();
}
virtual void mergeConfig( const Config& conf ) {
ConfigOptions::mergeConfig( conf );
fromConfig( conf );
}
private:
void fromConfig( const Config& conf ) {
//nop
}
};
//--------------------------------------------------------------------
typedef Threading::PerObjectRefMap<std::string, CacheBin> ThreadSafeCacheBinMap;
/**
* Cache is a container for local storage of keyed data elements.
*/
class OSGEARTH_EXPORT Cache : public osg::Object
{
protected:
Cache( const CacheOptions& options =CacheOptions() );
Cache( const Cache& rhs, const osg::CopyOp& op =osg::CopyOp::DEEP_COPY_ALL );
META_Object( osgEarth, Cache );
/** dtor */
virtual ~Cache();
public:
/**
* Whether this cache is valid and available for use
*/
bool isOK() const { return _ok; }
/**
* Gets a caching bin within this cache.
* @param name Name of the caching bin
* @param rw Read/write driver for the bin (can be null)
*/
CacheBin* getBin( const std::string& name );
/**
* Gets the default caching bin within this cache. This may or may not
* be supported by the implementation, so be sure to check the result
* before using it.
*/
virtual CacheBin* getOrCreateDefaultBin() { return _defaultBin.get(); }
/**
* Creates (and returns a pointer to) a new Cache Bin.
* @param binID Name of the new bin
* @param rw Read/write driver that will handle serialization for the bin
*/
virtual CacheBin* addBin( const std::string& binID ) { return 0L; }
/**
* Removes a cache bin from the cache.
* @param bin Bin to remove.
*/
virtual void removeBin( CacheBin* bin );
/**
* Gets an Options structure representing this cache's configuration.
*/
const CacheOptions& getCacheOptions() const { return _options; }
/**
* Store this to an osgDB::Options
*/
void apply( osgDB::Options* options ) {
if ( options ) options->setPluginData( "osgEarth::Cache", this );
}
/**
* Fetch pointer from a osgDB::Options
*/
static Cache* get( const osgDB::Options* options ) {
return options ? const_cast<Cache*>( static_cast<const Cache*>( options->getPluginData("osgEarth::Cache") ) ) : 0L;
}
protected:
bool _ok;
CacheOptions _options;
ThreadSafeCacheBinMap _bins;
osg::ref_ptr<CacheBin> _defaultBin;
};
//----------------------------------------------------------------------
/**
* Base class for a cache driver plugin.
*/
class OSGEARTH_EXPORT CacheDriver : public osgDB::ReaderWriter
{
public:
const CacheOptions& getCacheOptions( const osgDB::ReaderWriter::Options* options ) const;
/** dtor */
virtual ~CacheDriver();
};
//----------------------------------------------------------------------
/**
* Factory class that can load and instantiate a Cache implementation based on the
* information in the CacheOptions settings.
*/
class OSGEARTH_EXPORT CacheFactory
{
public:
static Cache* create( const CacheOptions& options);
};
}
#endif // OSGEARTH_CACHE_H
|