DGtal  1.5.beta
DGtal::concepts::CImageCacheWritePolicy< T > Struct Template Reference

Aim: Defines the concept describing a cache write policy. More...

#include <DGtal/images/CImageCacheWritePolicy.h>

Public Types

typedef T::ImageContainer ImageContainer
 

Public Member Functions

 BOOST_CONCEPT_USAGE (CImageCacheWritePolicy)
 
void checkConstConstraints () const
 

Private Attributes

myT
 
ImageContainermyIC
 
T::Point myPoint
 
T::Value myValue
 

Detailed Description

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

Aim: Defines the concept describing a cache write policy.

Description of concept 'CImageCacheWritePolicy'

Refinement of

Associated types

  • ImageContainer : type of the image in the cache, model of concept CImage
  • Point : type of the image point
  • Value : type of the image value

Notation

  • X : A type that is a model of CImageCacheWritePolicy
  • x : object of type X
  • i : object of type ImageContainer
  • p : object of type Point
  • v : object of type Value

Definitions

Valid expressions and semantics

Name Expression Type requirements Return type Precondition Semantics Post condition Complexity
Write in page x.writeInPage(i,p,v) i of type ImageContainer, p of type Point, v of type Value set a value v on an image i at a given position p
Flush page x.flushPage(i) i of type ImageContainer flush the image i on disk according to the cache policy

Invariants

Models

ImageCacheWritePolicyWT, ImageCacheWritePolicyWB

Notes

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

Definition at line 91 of file CImageCacheWritePolicy.h.

Member Typedef Documentation

◆ ImageContainer

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

Definition at line 96 of file CImageCacheWritePolicy.h.

Member Function Documentation

◆ BOOST_CONCEPT_USAGE()

◆ checkConstConstraints()

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

Definition at line 107 of file CImageCacheWritePolicy.h.

108  {
109  }

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

Field Documentation

◆ myIC

◆ myPoint

◆ myT

template<typename T >
T DGtal::concepts::CImageCacheWritePolicy< T >::myT
private

◆ myValue


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