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

#include <DGtal/images/CImageFactory.h>

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

Public Types

typedef T::OutputImage OutputImage
 

Public Member Functions

 BOOST_CONCEPT_ASSERT ((CImage< OutputImage >))
 
 BOOST_CONCEPT_USAGE (CImageFactory)
 
void checkConstConstraints () const
 

Private Attributes

myT
 
OutputImagemyOI
 
T::Domain myDomain
 

Detailed Description

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

Aim: Defines the concept describing an image factory.

Description of concept 'CImageFactory'

Refinement of

Associated types :

Notation

Definitions

Valid expressions and semantics

Name Expression Type requirements Return type Precondition Semantics Post condition Complexity
Request image x.requestImage(d) d of type Domain OutputImage returns a pointer of an OutputImage created with the Domain d
Flush image x.flushImage(o) o of type OutputImage flush (i.e. write/synchronize) an OutputImage o
Detach image x.detachImage(o) o of type OutputImage free (i.e. delete) an OutputImage o

Invariants

Models

ImageFactoryFromImage ImageFactoryFromHDF5

Notes

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

Definition at line 90 of file CImageFactory.h.

Member Typedef Documentation

template<typename T >
typedef T::OutputImage DGtal::concepts::CImageFactory< T >::OutputImage

Definition at line 95 of file CImageFactory.h.

Member Function Documentation

template<typename T >
DGtal::concepts::CImageFactory< T >::BOOST_CONCEPT_ASSERT ( (CImage< OutputImage >)  )
template<typename T >
DGtal::concepts::CImageFactory< T >::BOOST_CONCEPT_USAGE ( CImageFactory< T >  )
inline
template<typename T >
void DGtal::concepts::CImageFactory< T >::checkConstConstraints ( ) const
inline

Definition at line 108 of file CImageFactory.h.

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

109  {
110  }

Field Documentation

template<typename T >
T::Domain DGtal::concepts::CImageFactory< T >::myDomain
private
template<typename T >
OutputImage* DGtal::concepts::CImageFactory< T >::myOI
private
template<typename T >
T DGtal::concepts::CImageFactory< T >::myT
private

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