environment_cache.h

Go to the documentation of this file.

 
#ifndef TESSERACT_ENVIRONMENT_ENVIRONMENT_CACHE_H
#define TESSERACT_ENVIRONMENT_ENVIRONMENT_CACHE_H
 
#include <tesseract_common/macros.h>
TESSERACT_COMMON_IGNORE_WARNINGS_PUSH
#include <memory>
#include <deque>
#include <shared_mutex>
TESSERACT_COMMON_IGNORE_WARNINGS_POP
 
namespace tesseract_environment
{
class Environment;
class EnvironmentCache
{
public:
  using Ptr = std::shared_ptr<EnvironmentCache>;
  using ConstPtr = std::shared_ptr<const EnvironmentCache>;
  using UPtr = std::unique_ptr<EnvironmentCache>;
  using ConstUPtr = std::unique_ptr<const EnvironmentCache>;
 
  EnvironmentCache() = default;
  virtual ~EnvironmentCache() = default;
  EnvironmentCache(const EnvironmentCache&) = delete;
  EnvironmentCache& operator=(const EnvironmentCache&) = delete;
  EnvironmentCache(EnvironmentCache&&) = delete;
  EnvironmentCache& operator=(EnvironmentCache&&) = delete;
 
  virtual void setCacheSize(long size) = 0;
 
  virtual long getCacheSize() const = 0;
 
  virtual void refreshCache() const = 0;
 
  virtual std::unique_ptr<Environment> getCachedEnvironment() const = 0;
};
 
class DefaultEnvironmentCache : public EnvironmentCache
{
public:
  using Ptr = std::shared_ptr<DefaultEnvironmentCache>;
  using ConstPtr = std::shared_ptr<const DefaultEnvironmentCache>;
 
  DefaultEnvironmentCache(std::shared_ptr<const Environment> env, std::size_t cache_size = 5);
 
  void setCacheSize(long size) override final;
 
  long getCacheSize() const override final;
 
  void refreshCache() const override final;
 
  std::unique_ptr<Environment> getCachedEnvironment() const override final;
 
protected:
  std::shared_ptr<const Environment> env_;
 
  std::size_t cache_size_{ 5 };
 
  mutable int cache_env_revision_{ 0 };
 
  mutable std::deque<std::unique_ptr<Environment>> cache_;
 
  mutable std::shared_mutex cache_mutex_;
 
  void refreshCacheHelper() const;
};
}  // namespace tesseract_environment
 
#endif  // TESSERACT_ENVIRONMENT_ENVIRONMENT_CACHE_H