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

Aim: Defines the concept describing an image factory. More...

#include <DGtal/images/CImageFactory.h>

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

◆ OutputImage

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

Definition at line 95 of file CImageFactory.h.

Member Function Documentation

◆ BOOST_CONCEPT_ASSERT()

template<typename T >
DGtal::concepts::CImageFactory< T >::BOOST_CONCEPT_ASSERT ( (CImage< OutputImage >)  )

◆ BOOST_CONCEPT_USAGE()

template<typename T >
DGtal::concepts::CImageFactory< T >::BOOST_CONCEPT_USAGE ( CImageFactory< T >  )
inline

◆ checkConstConstraints()

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

Definition at line 108 of file CImageFactory.h.

109  {
110  }

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

Field Documentation

◆ myDomain

template<typename T >
T::Domain DGtal::concepts::CImageFactory< T >::myDomain
private

◆ myOI

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

◆ myT

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

The documentation for this struct was generated from the following file:
DGtal::concepts::CImageFactory::myOI
OutputImage * myOI
Definition: CImageFactory.h:115
DGtal::concepts::CImageFactory::checkConstConstraints
void checkConstConstraints() const
Definition: CImageFactory.h:108
DGtal::concepts::CImageFactory::myDomain
T::Domain myDomain
Definition: CImageFactory.h:116
DGtal::concepts::CImageFactory::myT
T myT
Definition: CImageFactory.h:114
DGtal::concepts::ConceptUtils::sameType
void sameType(const T &, const T &)
Definition: ConceptUtils.h:117