tesseract_environment::EnvironmentCache Class Reference

#include <environment_cache.h>

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 ()=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
	Set the cache size used to hold tesseract objects for motion planning. More...
virtual long	getCacheSize () const =0
	Get the cache size used to hold tesseract objects for motion planning. More...
virtual void	refreshCache () const =0
	If the environment has changed it will rebuild the cache of tesseract objects. More...
virtual Environment::UPtr	getCachedEnvironment () const =0
	This will pop an Environment object from the queue. More...

Member Typedef Documentation

ConstPtr

using tesseract_environment::EnvironmentCache::ConstPtr = std::shared_ptr<const EnvironmentCache>

ConstUPtr

using tesseract_environment::EnvironmentCache::ConstUPtr = std::unique_ptr<const EnvironmentCache>

Ptr

using tesseract_environment::EnvironmentCache::Ptr = std::shared_ptr<EnvironmentCache>

UPtr

using tesseract_environment::EnvironmentCache::UPtr = std::unique_ptr<EnvironmentCache>

Constructor & Destructor Documentation

EnvironmentCache() [1/3]

tesseract_environment::EnvironmentCache::EnvironmentCache ( )

default

~EnvironmentCache()

virtual tesseract_environment::EnvironmentCache::~EnvironmentCache ( )

virtualdefault

EnvironmentCache() [2/3]

tesseract_environment::EnvironmentCache::EnvironmentCache ( const EnvironmentCache &  )

delete

EnvironmentCache() [3/3]

tesseract_environment::EnvironmentCache::EnvironmentCache ( EnvironmentCache &&  )

delete

Member Function Documentation

getCachedEnvironment()

virtual Environment::UPtr 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.

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.

operator=() [1/2]

EnvironmentCache & tesseract_environment::EnvironmentCache::operator= ( const EnvironmentCache &  )

delete

operator=() [2/2]

EnvironmentCache & tesseract_environment::EnvironmentCache::operator= ( EnvironmentCache &&  )

delete

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.

setCacheSize()

virtual void tesseract_environment::EnvironmentCache::setCacheSize ( long  size )

pure virtual

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

Parameters

size	The size of the cache.

Implemented in tesseract_environment::DefaultEnvironmentCache.

---

The documentation for this class was generated from the following file:

• tesseract_environment/include/tesseract_environment/environment_cache.h