g2o::Cache Class Reference

#include <cache.h>

Inheritance diagram for g2o::Cache:

Classes
class	CacheKey

Public Member Functions
	Cache (CacheContainer *container_=0, const ParameterVector &parameters_=ParameterVector())
CacheContainer *	container ()
virtual HyperGraph::HyperGraphElementType	elementType () const
OptimizableGraph *	graph ()
CacheKey	key () const
ParameterVector &	parameters ()
void	update ()
OptimizableGraph::Vertex *	vertex ()
Public Member Functions inherited from g2o::HyperGraph::HyperGraphElement
virtual	~HyperGraphElement ()

Protected Member Functions
Cache *	installDependency (const std::string &type_, const std::vector< int > &parameterIndices)
virtual bool	resolveDependancies ()
virtual void	updateImpl ()=0
	redefine this to do the update More...

Protected Attributes
CacheContainer *	_container
ParameterVector	_parameters
std::vector< Cache * >	_parentCaches
bool	_updateNeeded

Friends
class	CacheContainer

Detailed Description

Definition at line 38 of file cache.h.

Constructor & Destructor Documentation

g2o::Cache::Cache	(	CacheContainer *	container_ = 0,
		const ParameterVector &	parameters_ = ParameterVector()
	)

Definition at line 46 of file cache.cpp.

Member Function Documentation

CacheContainer * g2o::Cache::container

(

)

Definition at line 71 of file cache.cpp.

virtual HyperGraph::HyperGraphElementType g2o::Cache::elementType ( ) const

inlinevirtual

returns the type of the graph element, see HyperGraphElementType

Implements g2o::HyperGraph::HyperGraphElement.

Definition at line 70 of file cache.h.

OptimizableGraph * g2o::Cache::graph

(

)

Definition at line 65 of file cache.cpp.

Cache * g2o::Cache::installDependency ( const std::string &  type_, const std::vector< int > &  parameterIndices  )

protected

this function installs and satisfies a cache

Parameters

type_

the typename of the dependency

parameterIndices

a vector containing the indices if the parameters in _parameters that will be used to assemble the Key of the cache being created For example if I have a cache of type C2, having parameters "A, B, and C", and it depends on a cache of type C1 that depends on the parameters A and C, the parameterIndices should contain "0, 2", since they are the positions in the parameter vector of C2 of the parameters needed to construct C1.

Returns

the newly created cache

Definition at line 95 of file cache.cpp.

Cache::CacheKey g2o::Cache::key

(

)

const

Definition at line 79 of file cache.cpp.

ParameterVector & g2o::Cache::parameters

(

)

Definition at line 75 of file cache.cpp.

bool g2o::Cache::resolveDependancies ( )

protectedvirtual

Function to be called from a cache that has dependencies. It just invokes a sequence of installDependency(). Although the caches returned are stored in the _parentCache vector, it is better that you redefine your own cache member variables, for better readability

Definition at line 114 of file cache.cpp.

void g2o::Cache::update

(

)

Definition at line 85 of file cache.cpp.

virtual void g2o::Cache::updateImpl ( )

protectedpure virtual

redefine this to do the update

OptimizableGraph::Vertex * g2o::Cache::vertex

(

)

Definition at line 59 of file cache.cpp.

Friends And Related Function Documentation

friend class CacheContainer

friend

Definition at line 41 of file cache.h.

Member Data Documentation

CacheContainer* g2o::Cache::_container

protected

Definition at line 100 of file cache.h.

ParameterVector g2o::Cache::_parameters

protected

Definition at line 98 of file cache.h.

std::vector<Cache*> g2o::Cache::_parentCaches

protected

Definition at line 99 of file cache.h.

bool g2o::Cache::_updateNeeded

protected

Definition at line 97 of file cache.h.

---

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

• cache.h
• cache.cpp