DGtal::ConstValueFunctor< TValue > Class Template Reference

#include <BasicFunctors.h>

Public Types
typedef TValue	Value

Public Member Functions
	ConstValueFunctor (const Value &aValue=0)
template<typename TInput >
Value	operator() (const TInput &) const

Private Attributes
Value	myValue

---

Detailed Description

template<typename TValue>
class DGtal::ConstValueFunctor< TValue >

Aim: Define a simple functor that returns a constant value (0 by default).

Description of template class 'ConstValueFunctor'

Template Parameters:

TValue

type of the value

Definition at line 135 of file BasicFunctors.h.

---

Member Typedef Documentation

template<typename TValue>

typedef TValue DGtal::ConstValueFunctor< TValue >::Value

Definition at line 138 of file BasicFunctors.h.

---

Constructor & Destructor Documentation

template<typename TValue>

DGtal::ConstValueFunctor< TValue >::ConstValueFunctor ( const Value &  aValue = 0 )

inline

Constructor.

Parameters:

value

the constant value.

Definition at line 144 of file BasicFunctors.h.

      :myValue(aValue) {};

---

Member Function Documentation

template<typename TValue>

template<typename TInput >

Value DGtal::ConstValueFunctor< TValue >::operator() ( const TInput &  ) const

inline

Operator

Template Parameters:

TInput

type of the input object

Parameters:

aInput

input object

Returns:

the constant value.

Definition at line 157 of file BasicFunctors.h.

References DGtal::ConstValueFunctor< TValue >::myValue.

    {
      return myValue;
    }

---

Field Documentation

template<typename TValue>

Value DGtal::ConstValueFunctor< TValue >::myValue

private

value

Definition at line 166 of file BasicFunctors.h.

Referenced by DGtal::ConstValueFunctor< TValue >::operator()().

---

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

• BasicFunctors.h