DGtal  0.9.4beta
Public Types | Public Member Functions | Private Attributes
DGtal::concepts::CImageCacheReadPolicy< T > Struct Template Reference

#include <DGtal/images/CImageCacheReadPolicy.h>

Collaboration diagram for DGtal::concepts::CImageCacheReadPolicy< T >:
[legend]

Public Types

typedef T::ImageContainer ImageContainer
 

Public Member Functions

 BOOST_CONCEPT_USAGE (CImageCacheReadPolicy)
 
void checkConstConstraints () const
 

Private Attributes

myT
 
ImageContainermyIC
 
T::Point myPoint
 
T::Domain myDomain
 

Detailed Description

template<typename T>
struct DGtal::concepts::CImageCacheReadPolicy< T >

Aim: Defines the concept describing a cache read policy.

Description of concept 'CImageCacheReadPolicy'

Refinement of

Associated types :

Notation

Definitions

Valid expressions and semantics

Name Expression Type requirements Return type Precondition Semantics Post condition Complexity
Get page x.getPage(p) p of type Point ImageContainer p should be in a domain of the cache get the alias on the image that contains the point p
Get page x.getPage(d) d of type Domain ImageContainer d should be in a domain of the cache get the alias on the image that matchs the domain d
Get page to detach x.getPageToDetach() ImageContainer get the alias on the image that we have to detach
Update cache x.updateCache(d) d of type Domain update the cache with a new Domain d
Clear cache x.clearCache() clear the cache

Invariants

Models

ImageCacheReadPolicyLAST, ImageCacheReadPolicyFIFO

Notes

Template Parameters
Tthe type that should be a model of CImageCacheReadPolicy.

Definition at line 93 of file CImageCacheReadPolicy.h.

Member Typedef Documentation

template<typename T >
typedef T::ImageContainer DGtal::concepts::CImageCacheReadPolicy< T >::ImageContainer

Definition at line 98 of file CImageCacheReadPolicy.h.

Member Function Documentation

template<typename T >
DGtal::concepts::CImageCacheReadPolicy< T >::BOOST_CONCEPT_USAGE ( CImageCacheReadPolicy< T >  )
inline
template<typename T >
void DGtal::concepts::CImageCacheReadPolicy< T >::checkConstConstraints ( ) const
inline

Definition at line 112 of file CImageCacheReadPolicy.h.

Referenced by DGtal::concepts::CImageCacheReadPolicy< T >::BOOST_CONCEPT_USAGE().

113  {
114  }

Field Documentation

template<typename T >
T::Domain DGtal::concepts::CImageCacheReadPolicy< T >::myDomain
private
template<typename T >
ImageContainer* DGtal::concepts::CImageCacheReadPolicy< T >::myIC
private
template<typename T >
T::Point DGtal::concepts::CImageCacheReadPolicy< T >::myPoint
private
template<typename T >
T DGtal::concepts::CImageCacheReadPolicy< T >::myT
private

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