Tesseract 0.28.4
Loading...
Searching...
No Matches
tesseract::environment::EnvironmentCache Class Referenceabstract
Inheritance diagram for tesseract::environment::EnvironmentCache:

Public Types

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>

Public Member Functions

 EnvironmentCache (const EnvironmentCache &)=delete
EnvironmentCache & operator= (const EnvironmentCache &)=delete
 EnvironmentCache (EnvironmentCache &&)=delete
EnvironmentCache & operator= (EnvironmentCache &&)=delete
virtual void setCacheSize (long size)=0
 Set the cache size used to hold tesseract objects for motion planning.
virtual long getCacheSize () const =0
 Get the cache size used to hold tesseract objects for motion planning.
virtual void refreshCache () const =0
 If the environment has changed it will rebuild the cache of tesseract objects.
virtual std::unique_ptr< Environment > getCachedEnvironment () const =0
 This will pop an Environment object from the queue.

Member Function Documentation

◆ setCacheSize()

virtual void tesseract::environment::EnvironmentCache::setCacheSize ( long size)
pure virtual

Set the cache size used to hold tesseract objects for motion planning.

Parameters
sizeThe size of the cache.

Implemented in tesseract::environment::DefaultEnvironmentCache.

◆ getCacheSize()

virtual long tesseract::environment::EnvironmentCache::getCacheSize ( ) const
pure virtual

Get the cache size used to hold tesseract objects for motion planning.

Returns
The size of the cache.

Implemented in tesseract::environment::DefaultEnvironmentCache.

◆ refreshCache()

virtual void tesseract::environment::EnvironmentCache::refreshCache ( ) const
pure virtual

If the environment has changed it will rebuild the cache of tesseract objects.

Implemented in tesseract::environment::DefaultEnvironmentCache.

◆ getCachedEnvironment()

virtual std::unique_ptr< Environment > tesseract::environment::EnvironmentCache::getCachedEnvironment ( ) const
pure virtual

This will pop an Environment object from the queue.

This will first call refreshCache to ensure it has an updated tesseract then proceed

Implemented in tesseract::environment::DefaultEnvironmentCache.