DGtal  0.9.3beta
Public Types | Public Member Functions
DGtal::concepts::CDomainArchetype< TSpace > Class Template Reference

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

Public Types

typedef CDomainArchetype< TSpace > Domain
 
typedef TSpace Space
 
typedef Space::Integer Integer
 
typedef Space::Point Point
 
typedef Space::Vector Vector
 
typedef Space::Size Size
 
typedef Space::Dimension Dimension
 
typedef CConstBidirectionalIteratorArchetype< PointConstIterator
 
typedef int Predicate
 
typedef int DigitalSet
 

Public Member Functions

 ~CDomainArchetype ()
 
 CDomainArchetype (const DigitalSet &aSet)
 
 CDomainArchetype (const CDomainArchetype &other)
 
ConstIterator begin (const Point &aPoint) const
 
ConstIterator begin () const
 
ConstIterator end () const
 
const PointlowerBound () const
 
const PointupperBound () const
 
Size size () const
 
bool isInside (const Point &p) const
 
const Predicatepredicate () const
 
void selfDisplay (std::ostream &out) const
 
bool isValid () const
 

Detailed Description

template<typename TSpace>
class DGtal::concepts::CDomainArchetype< TSpace >

Aim: The archetype of a class that represents a digital domain, i.e. a non mutable subset of points of the given digital space.

Description of template class 'CDomainArchetype'

Archetype of CDomain.

Definition at line 71 of file CDomainArchetype.h.

Member Typedef Documentation

Definition at line 84 of file CDomainArchetype.h.

template<typename TSpace >
typedef int DGtal::concepts::CDomainArchetype< TSpace >::DigitalSet
Todo:
DigitalSet

Definition at line 92 of file CDomainArchetype.h.

template<typename TSpace >
typedef Space::Dimension DGtal::concepts::CDomainArchetype< TSpace >::Dimension

Definition at line 83 of file CDomainArchetype.h.

template<typename TSpace >
typedef CDomainArchetype<TSpace> DGtal::concepts::CDomainArchetype< TSpace >::Domain

Definition at line 77 of file CDomainArchetype.h.

template<typename TSpace >
typedef Space::Integer DGtal::concepts::CDomainArchetype< TSpace >::Integer

Definition at line 79 of file CDomainArchetype.h.

template<typename TSpace >
typedef Space::Point DGtal::concepts::CDomainArchetype< TSpace >::Point

Definition at line 80 of file CDomainArchetype.h.

template<typename TSpace >
typedef int DGtal::concepts::CDomainArchetype< TSpace >::Predicate
Todo:
DigitalSetPredicate

Definition at line 88 of file CDomainArchetype.h.

template<typename TSpace >
typedef Space::Size DGtal::concepts::CDomainArchetype< TSpace >::Size

Definition at line 82 of file CDomainArchetype.h.

template<typename TSpace >
typedef TSpace DGtal::concepts::CDomainArchetype< TSpace >::Space

Definition at line 78 of file CDomainArchetype.h.

template<typename TSpace >
typedef Space::Vector DGtal::concepts::CDomainArchetype< TSpace >::Vector

Definition at line 81 of file CDomainArchetype.h.

Constructor & Destructor Documentation

template<typename TSpace >
DGtal::concepts::CDomainArchetype< TSpace >::~CDomainArchetype ( )
inline

Destructor.

Definition at line 100 of file CDomainArchetype.h.

100 {}
template<typename TSpace >
DGtal::concepts::CDomainArchetype< TSpace >::CDomainArchetype ( const DigitalSet aSet)
inline

Coonstructor from set.

Parameters
aSetthe digital set.

Definition at line 106 of file CDomainArchetype.h.

106 {}
template<typename TSpace >
DGtal::concepts::CDomainArchetype< TSpace >::CDomainArchetype ( const CDomainArchetype< TSpace > &  other)
inline

Copy constructor.

Parameters
otherthe object to clone.

Definition at line 113 of file CDomainArchetype.h.

113 {}

Member Function Documentation

template<typename TSpace >
ConstIterator DGtal::concepts::CDomainArchetype< TSpace >::begin ( const Point aPoint) const
inline
Returns
an iterator on the first element of the domain.

Definition at line 121 of file CDomainArchetype.h.

122  { return DummyObject<ConstIterator>::get(); }
template<typename TSpace >
ConstIterator DGtal::concepts::CDomainArchetype< TSpace >::begin ( ) const
inline
Returns
an iterator on the first element of the domain.

Definition at line 127 of file CDomainArchetype.h.

128  { return DummyObject<ConstIterator>::get(); }
template<typename TSpace >
ConstIterator DGtal::concepts::CDomainArchetype< TSpace >::end ( ) const
inline
Returns
an iterator on the element after the last of the domain.

Definition at line 133 of file CDomainArchetype.h.

134  { return DummyObject<ConstIterator>::get(); }
template<typename TSpace >
bool DGtal::concepts::CDomainArchetype< TSpace >::isInside ( const Point p) const
inline
Parameters
pany point.
Returns
'true' if point [p] is inside this domain.

Definition at line 161 of file CDomainArchetype.h.

162  { return true; }
template<typename TSpace >
bool DGtal::concepts::CDomainArchetype< TSpace >::isValid ( ) const
inline

Checks the validity/consistency of the object.

Returns
'true' if the object is valid, 'false' otherwise.

Definition at line 185 of file CDomainArchetype.h.

185 { return true; }
template<typename TSpace >
const Point& DGtal::concepts::CDomainArchetype< TSpace >::lowerBound ( ) const
inline

Returns the lowest point of the space diagonal.

Definition at line 140 of file CDomainArchetype.h.

141  { return DummyObject<Point>::get(); }
template<typename TSpace >
const Predicate& DGtal::concepts::CDomainArchetype< TSpace >::predicate ( ) const
inline
Returns
a const reference to the "IsInside" predicate.

Definition at line 168 of file CDomainArchetype.h.

169  { return DummyObject<Predicate>::get(); }
template<typename TSpace >
void DGtal::concepts::CDomainArchetype< TSpace >::selfDisplay ( std::ostream &  out) const
inline

Writes/Displays the object on an output stream.

Parameters
outthe output stream where the object is written.

Definition at line 179 of file CDomainArchetype.h.

179 {}
template<typename TSpace >
Size DGtal::concepts::CDomainArchetype< TSpace >::size ( ) const
inline

Returns the size.

Definition at line 154 of file CDomainArchetype.h.

155  { return DummyObject<Size>::get(); }
template<typename TSpace >
const Point& DGtal::concepts::CDomainArchetype< TSpace >::upperBound ( ) const
inline

Returns the highest point of the space diagonal.

Definition at line 147 of file CDomainArchetype.h.

148  { return DummyObject<Point>::get(); }

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