DGtal::detail::DSSDecorator< TDSS > Class Template Reference

#include <DGtal/geometry/curves/FP.h>

Inheritance diagram for DGtal::detail::DSSDecorator< TDSS >:

Public Types
typedef TDSS	DSS

Public Member Functions
bool	isExtendableFront () const
bool	extendFront ()
bool	retractBack ()
DSS::ConstIterator	end ()
virtual	~DSSDecorator ()
virtual TDSS::Point	firstLeaningPoint () const =0
virtual TDSS::Point	lastLeaningPoint () const =0
virtual bool	isInConvexPart () const =0

Protected Attributes
TDSS *	myDSS

Detailed Description

template<typename TDSS>
class DGtal::detail::DSSDecorator< TDSS >

Aim: Abstract DSSDecorator for ArithmeticalDSSComputer. Has 2 virtual methods returning the first and last leaning point:

• firstLeaningPoint()
• lastLeaningPoint()

See also

DSSDecorator4ConvexPart DSSDecorator4ConcavePart

Template Parameters

TDSS	type devoted to DSS recognition Must have a nested type 'Point' and four accessors: Uf(), Ul(), Lf(), Ll()

Definition at line 74 of file FP.h.

Member Typedef Documentation

DSS

template<typename TDSS >

typedef TDSS DGtal::detail::DSSDecorator< TDSS >::DSS

Type of the underlying DSS

Definition at line 80 of file FP.h.

Constructor & Destructor Documentation

~DSSDecorator()

template<typename TDSS >

virtual DGtal::detail::DSSDecorator< TDSS >::~DSSDecorator ( )

inlinevirtual

Destructor ( virtual to disable warnings [-Wdelete-non-virtual-dtor] )

Definition at line 126 of file FP.h.

References DGtal::detail::DSSDecorator< TDSS >::firstLeaningPoint(), DGtal::detail::DSSDecorator< TDSS >::isInConvexPart(), and DGtal::detail::DSSDecorator< TDSS >::lastLeaningPoint().

{}

Member Function Documentation

end()

template<typename TDSS >

DSS::ConstIterator DGtal::detail::DSSDecorator< TDSS >::end ( )

inline

End of the underlying segment

Returns

end iterator of the underlying segment

Definition at line 117 of file FP.h.

      {
        return myDSS->end(); 
      }

extendFront()

template<typename TDSS >

bool DGtal::detail::DSSDecorator< TDSS >::extendFront ( )

inline

Extends the underlying segment (if possible)

Returns

'true' if the segment has been extended, 'false' otherwise

Definition at line 100 of file FP.h.

      {
        return myDSS->extendFront(); 
      }

firstLeaningPoint()

template<typename TDSS >

virtual TDSS::Point DGtal::detail::DSSDecorator< TDSS >::firstLeaningPoint ( ) const

pure virtual

First leaning point accessor

Returns

the first upper or lower leaning point

Implemented in DGtal::detail::DSSDecorator4ConcavePart< TDSS >, and DGtal::detail::DSSDecorator4ConvexPart< TDSS >.

Referenced by DGtal::detail::DSSDecorator< TDSS >::~DSSDecorator().

isExtendableFront()

template<typename TDSS >

bool DGtal::detail::DSSDecorator< TDSS >::isExtendableFront ( ) const

inline

Tells whether the underlying segment can be extended or not

Returns

'true' if extendable, 'false' otherwise

Definition at line 91 of file FP.h.

      {
        return myDSS->isExtendableFront(); 
      }

isInConvexPart()

template<typename TDSS >

virtual bool DGtal::detail::DSSDecorator< TDSS >::isInConvexPart ( ) const

pure virtual

Tells whether it adapts a DSS computer for convex parts or not

Returns

'true' for convex parts, 'false' for concave parts

Implemented in DGtal::detail::DSSDecorator4ConcavePart< TDSS >, and DGtal::detail::DSSDecorator4ConvexPart< TDSS >.

Referenced by DGtal::detail::DSSDecorator< TDSS >::~DSSDecorator().

lastLeaningPoint()

template<typename TDSS >

virtual TDSS::Point DGtal::detail::DSSDecorator< TDSS >::lastLeaningPoint ( ) const

pure virtual

Last leaning point accessor

Returns

the last upper or lower leaning point

Implemented in DGtal::detail::DSSDecorator4ConcavePart< TDSS >, and DGtal::detail::DSSDecorator4ConvexPart< TDSS >.

Referenced by DGtal::detail::DSSDecorator< TDSS >::~DSSDecorator().

retractBack()

template<typename TDSS >

bool DGtal::detail::DSSDecorator< TDSS >::retractBack ( )

inline

Retracts the underlying segment (if possible)

Returns

'true' if the segment has been retracted, 'false' otherwise

Definition at line 109 of file FP.h.

      {
        return myDSS->retractBack(); 
      }

Field Documentation

myDSS

template<typename TDSS >

TDSS* DGtal::detail::DSSDecorator< TDSS >::myDSS

protected

Aliasing pointer to an instance of TDSS

Definition at line 85 of file FP.h.

Referenced by DGtal::detail::DSSDecorator4ConcavePart< TDSS >::DSSDecorator4ConcavePart(), DGtal::detail::DSSDecorator4ConvexPart< TDSS >::DSSDecorator4ConvexPart(), DGtal::detail::DSSDecorator4ConvexPart< TDSS >::firstLeaningPoint(), DGtal::detail::DSSDecorator4ConcavePart< TDSS >::firstLeaningPoint(), DGtal::detail::DSSDecorator4ConvexPart< TDSS >::lastLeaningPoint(), and DGtal::detail::DSSDecorator4ConcavePart< TDSS >::lastLeaningPoint().

---

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

• FP.h