Public Member Functions | Private Attributes

DGtal::CDrawableWithDGtalBoard< T > Struct Template Reference
[DGtal concepts]

#include <CDrawableWithDGtalBoard.h>

Collaboration diagram for DGtal::CDrawableWithDGtalBoard< T >:
Collaboration graph
[legend]

Public Member Functions

 BOOST_CONCEPT_USAGE (CDrawableWithDGtalBoard)

Private Attributes

myT
DrawableWithDGtalBoardmyD
DGtalBoard myB
std::string myS

Detailed Description

template<typename T>
struct DGtal::CDrawableWithDGtalBoard< T >

Description of concept 'CDrawableWithDGtalBoard'

Aim: The concept CDrawableWithDGtalBoard specifies what are the classes that admit an export with DGtalBoard. An object x satisfying this concept may then be used as:

   DGtalBoard board;
   board << CustomStyle( x.styleName(), x.defaultStyle() )
         << x;

Refinement of

Associated types :

Notation

Definitions

Valid expressions and semantics

Name Expression Type requirements Return type Precondition Semantics Postcondition Complexity
the default draw style x.defaultStyle( m = "" ) mode : std::string DrawableWithDGtalBoard * returns a dynamic allocation of the default style for the model X in mode m
the name of the model X x.styleName() std::string returns a string telling the name of the model X
the way the object x is drawn x.selfDraw(DGtalBoard &board) draws on the board stream the object x

Invariants

Models
ArimeticalDSS, FreemanChain, HyperRectDomain, ImageContainerByHashTree, ImageContainerBySTLVector, PointVector, DigitalSetBySTLSet,DigitalSetBySTLVector, Object

Notes

Todo:

ImageContainerByHashTree does not implement selfDraw(DGtalBoard &).

ImageContainerByHashTree does not implement defaultStyle(std::string&)const.


Member Function Documentation

template<typename T >
DGtal::CDrawableWithDGtalBoard< T >::BOOST_CONCEPT_USAGE ( CDrawableWithDGtalBoard< T >   )  [inline]

Field Documentation

template<typename T >
DGtalBoard DGtal::CDrawableWithDGtalBoard< T >::myB [private]
Todo:
FIXME: si on décommente ça plante

Referenced by DGtal::CDrawableWithDGtalBoard< T >::BOOST_CONCEPT_USAGE().

template<typename T >
DrawableWithDGtalBoard* DGtal::CDrawableWithDGtalBoard< T >::myD [private]
template<typename T >
std::string DGtal::CDrawableWithDGtalBoard< T >::myS [private]
template<typename T >
T DGtal::CDrawableWithDGtalBoard< T >::myT [private]

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