DGtal::functors::DomainPredicate< TDomain > Struct Template Reference

Aim: The predicate returning true iff the point is in the domain given at construction. It is just a wrapper class around the methods Domain::isInside( const Point & ), where Domain stands for any model of CDomain. More...

#include <DGtal/kernel/domains/DomainPredicate.h>

Inheritance diagram for DGtal::functors::DomainPredicate< TDomain >:

Public Types
typedef TDomain	Domain
typedef Domain::Point	Point

Public Member Functions
	DomainPredicate (ConstAlias< Domain > aDomain)
	DomainPredicate (const DomainPredicate &other)
DomainPredicate &	operator= (const DomainPredicate &other)
bool	operator() (const Point &p) const
const Domain &	domain () const

Protected Member Functions
	DomainPredicate ()

Private Attributes
const Domain *	myDomain
	Aliasing pointer on the domain corresponding to this predicate.

Detailed Description

template<typename TDomain>
struct DGtal::functors::DomainPredicate< TDomain >

Aim: The predicate returning true iff the point is in the domain given at construction. It is just a wrapper class around the methods Domain::isInside( const Point & ), where Domain stands for any model of CDomain.

Description of template class 'DomainPredicate'

It is used by domains to define the type by their method predicate().

Model of concepts::CPointPredicate

See also

DomainAdjacency::predicate.

Definition at line 70 of file DomainPredicate.h.

Member Typedef Documentation

Domain

template<typename TDomain >

TDomain DGtal::functors::DomainPredicate< TDomain >::Domain

Definition at line 74 of file DomainPredicate.h.

Point

template<typename TDomain >

Domain::Point DGtal::functors::DomainPredicate< TDomain >::Point

Definition at line 75 of file DomainPredicate.h.

Constructor & Destructor Documentation

DomainPredicate() [1/3]

template<typename TDomain >

DGtal::functors::DomainPredicate< TDomain >::DomainPredicate

(

ConstAlias< Domain >

aDomain

)

Constructor from domain.

Parameters

aDomain

any domain.

DomainPredicate() [2/3]

template<typename TDomain >

DGtal::functors::DomainPredicate< TDomain >::DomainPredicate

(

const DomainPredicate< TDomain > &

other

)

Copy constructor.

Parameters

other

the object to clone.

DomainPredicate() [3/3]

template<typename TDomain >

DGtal::functors::DomainPredicate< TDomain >::DomainPredicate ( )

protected

Constructor. Forbidden by default (protected to avoid g++ warnings).

Member Function Documentation

domain()

template<typename TDomain >

const Domain & DGtal::functors::DomainPredicate< TDomain >::domain

(

)

const

Returns

a const reference to the associated domain.

operator()()

template<typename TDomain >

bool DGtal::functors::DomainPredicate< TDomain >::operator()

(

const Point &

p

)

const

Parameters

p	any point.

Returns

true iff p is in the domain.

operator=()

template<typename TDomain >

DomainPredicate & DGtal::functors::DomainPredicate< TDomain >::operator=

(

const DomainPredicate< TDomain > &

other

)

Assignment.

Parameters

other

the object to copy.

Returns

a reference on 'this'. Forbidden by default.

Field Documentation

myDomain

template<typename TDomain >

const Domain* DGtal::functors::DomainPredicate< TDomain >::myDomain

private

Aliasing pointer on the domain corresponding to this predicate.

Definition at line 122 of file DomainPredicate.h.

---

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

• DomainPredicate.h