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

#include <DGtal/shapes/CDigitalBoundedShape.h>

Public Types

typedef TShape::Point Point
 

Public Member Functions

 BOOST_CONCEPT_USAGE (CDigitalBoundedShape)
 

Private Attributes

TShape myT
 
Point myP
 

Detailed Description

template<typename TShape>
struct DGtal::concepts::CDigitalBoundedShape< TShape >

Aim: designs the concept of bounded shapes in DGtal (shape for which upper and lower bounding bounds are available).

DescriptionDescription of concept 'CDigitalBoundedShape'

Refinement of

Associated types :

Notation

Definitions

Valid expressions and semantics

| Name | Expression | Type requirements | Return type | Precondition | Semantics | Post condition | Complexity | |------------—|---------—|------------------—|----------—|---------------—|--------—|-------------—|---------—| |Lower bound | x.getLowerBound()| | |Point | |compute and return the lower bound of the shape bounding box | | | |Upper bound | x.getUpperBound()| | |Point | |compute and return the upper bound of the shape bounding box | | |

Invariants

Models

Implicit and Parametric shapes of the shape factory.

Notes

Definition at line 90 of file CDigitalBoundedShape.h.

Member Typedef Documentation

template<typename TShape >
typedef TShape::Point DGtal::concepts::CDigitalBoundedShape< TShape >::Point

Definition at line 95 of file CDigitalBoundedShape.h.

Member Function Documentation

template<typename TShape >
DGtal::concepts::CDigitalBoundedShape< TShape >::BOOST_CONCEPT_USAGE ( CDigitalBoundedShape< TShape >  )
inline

Definition at line 97 of file CDigitalBoundedShape.h.

References DGtal::concepts::CDigitalBoundedShape< TShape >::myP, DGtal::concepts::CDigitalBoundedShape< TShape >::myT, and DGtal::concepts::ConceptUtils::sameType().

98  {
99  // Shape should have a getUpperBound() returning a Point.
100  ConceptUtils::sameType( myP, myT.getUpperBound() );
101  // Shape should have a getLowerBound() returning a Point.
102  ConceptUtils::sameType( myP, myT.getLowerBound() );
103  }
void sameType(const T &t1, const T &t2)

Field Documentation

template<typename TShape >
Point DGtal::concepts::CDigitalBoundedShape< TShape >::myP
private
template<typename TShape >
TShape DGtal::concepts::CDigitalBoundedShape< TShape >::myT
private

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