#include <otbWrapperNumericalParameter.h>

Inheritance diagram for otb::Wrapper::NumericalParameter< T >:

Collaboration diagram for otb::Wrapper::NumericalParameter< T >:

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer

typedef itk::SmartPointer< Self >	Pointer

typedef T	ScalarType

typedef NumericalParameter	Self

typedef Parameter	Superclass

Public Types inherited from otb::Wrapper::Parameter
typedef itk::SmartPointer< const Self >	ConstPointer

typedef itk::SmartPointer< Self >	Pointer

typedef Parameter	Self

typedef itk::Object	Superclass

Public Member Functions
void	ClearValue () override

void	FromInt (int value) override

void	FromString (const std::string &value) override

virtual ScalarType	GetDefaultValue ()

virtual ScalarType	GetMaximumValue ()

virtual ScalarType	GetMinimumValue ()

ScalarType	GetValue () const

bool	HasValue () const override

void	Reset () override

virtual void	SetDefaultValue (ScalarType _arg)

virtual void	SetMaximumValue (ScalarType _arg)

virtual void	SetMinimumValue (ScalarType _arg)

void	SetValue (const std::string &valueStr)

void	SetValue (ScalarType value)

double	ToDouble () const override

float	ToFloat () const override

int	ToInt () const override

std::string	ToString () const override

Public Member Functions inherited from otb::Wrapper::Parameter
virtual const char *	GetNameOfClass () const

virtual void	SetName (const std::string &)

virtual const char *	GetName () const

virtual void	SetDescription (const std::string &)

virtual const std::string &	GetDescription () const

virtual void	SetKey (const std::string &)

virtual const char *	GetKey () const

virtual void	SetActive (bool flag)

bool	GetActive (bool recurseParents=false) const

virtual void	SetMandatory (bool flag)

virtual bool	GetMandatory () const

virtual void	MandatoryOn ()

virtual void	MandatoryOff ()

virtual void	SetAutomaticValue (bool flag)

virtual bool	GetAutomaticValue () const

void	AutomaticValueOn ()

void	AutomaticValueOff ()

virtual void	SetUserLevel (const UserLevel level)

virtual UserLevel	GetUserLevel () const

virtual void	SetRole (const Role role)

virtual Role	GetRole () const

virtual bool	HasUserValue () const

virtual void	SetUserValue (bool isUserValue)

virtual void	SetRoot (const Parameter::Pointer root)

virtual const Parameter::Pointer	GetRoot () const

virtual bool	IsRoot () const

virtual void	AddChild (Parameter::Pointer child)

virtual std::vector< Parameter::Pointer >	GetChildrenList ()

virtual ParameterType	GetType () const =0

void	TypeError (const std::string &target_type) const

virtual std::vector< std::string >	ToStringList () const

virtual void	FromFloat (float)

virtual void	FromDouble (double)

virtual void	FromStringList (const std::vector< std::string > &)

Protected Member Functions
	NumericalParameter ()

	~NumericalParameter () override

Protected Member Functions inherited from otb::Wrapper::Parameter
	Parameter ()

Protected Attributes
ScalarType	m_DefaultValue

ScalarType	m_MaximumValue

ScalarType	m_MinimumValue

boost::optional< T >	m_Value

Protected Attributes inherited from otb::Wrapper::Parameter
std::string	m_Name

std::string	m_Description

std::string	m_Key

bool	m_Mandatory

bool	m_Active

bool	m_UserValue

UserLevel	m_UserLevel

Role	m_Role

itk::WeakPointer< Parameter >	m_Root

std::vector< Parameter::Pointer >	m_ChildrenList

Private Member Functions
	NumericalParameter (const Parameter &)=delete

void	operator= (const Parameter &)=delete

Detailed Description

template<class T>
class otb::Wrapper::NumericalParameter< T >

This class represents a numerical parameter.

Definition at line 39 of file otbWrapperNumericalParameter.h.

Member Typedef Documentation

◆ ConstPointer

template<class T >

typedef itk::SmartPointer<const Self> otb::Wrapper::NumericalParameter< T >::ConstPointer

Definition at line 46 of file otbWrapperNumericalParameter.h.

◆ Pointer

template<class T >

typedef itk::SmartPointer<Self> otb::Wrapper::NumericalParameter< T >::Pointer

Definition at line 45 of file otbWrapperNumericalParameter.h.

◆ ScalarType

template<class T >

typedef T otb::Wrapper::NumericalParameter< T >::ScalarType

Typedef of the scalar type

Definition at line 49 of file otbWrapperNumericalParameter.h.

◆ Self

template<class T >

typedef NumericalParameter otb::Wrapper::NumericalParameter< T >::Self

Standard class typedef

Definition at line 43 of file otbWrapperNumericalParameter.h.

◆ Superclass

template<class T >

typedef Parameter otb::Wrapper::NumericalParameter< T >::Superclass

Definition at line 44 of file otbWrapperNumericalParameter.h.

Constructor & Destructor Documentation

◆ NumericalParameter() [1/2]

template<class T >

otb::Wrapper::NumericalParameter< T >::NumericalParameter ( )

inlineprotected

Constructor

Definition at line 159 of file otbWrapperNumericalParameter.h.

◆ ~NumericalParameter()

template<class T >

otb::Wrapper::NumericalParameter< T >::~NumericalParameter ( )

inlineoverrideprotected

Destructor

Definition at line 165 of file otbWrapperNumericalParameter.h.

◆ NumericalParameter() [2/2]

template<class T >

otb::Wrapper::NumericalParameter< T >::NumericalParameter ( const Parameter & )

privatedelete

Member Function Documentation

◆ ClearValue()

template<class T >

void otb::Wrapper::NumericalParameter< T >::ClearValue ( )

inlineoverridevirtual

Name of the parameter

Reimplemented from otb::Wrapper::Parameter.

Definition at line 89 of file otbWrapperNumericalParameter.h.

◆ FromInt()

template<class T >

void otb::Wrapper::NumericalParameter< T >::FromInt ( int )

inlineoverridevirtual

Name of the parameter

Reimplemented from otb::Wrapper::Parameter.

Definition at line 140 of file otbWrapperNumericalParameter.h.

◆ FromString()

template<class T >

void otb::Wrapper::NumericalParameter< T >::FromString ( const std::string & )

inlineoverridevirtual

Name of the parameter

Reimplemented from otb::Wrapper::Parameter.

Definition at line 145 of file otbWrapperNumericalParameter.h.

◆ GetDefaultValue()

template<class T >

virtual ScalarType otb::Wrapper::NumericalParameter< T >::GetDefaultValue ( )

virtual

Get the default value

◆ GetMaximumValue()

template<class T >

virtual ScalarType otb::Wrapper::NumericalParameter< T >::GetMaximumValue ( )

virtual

Get the maximum value

◆ GetMinimumValue()

template<class T >

virtual ScalarType otb::Wrapper::NumericalParameter< T >::GetMinimumValue ( )

virtual

Get the minimum value

◆ GetValue()

template<class T >

ScalarType otb::Wrapper::NumericalParameter< T >::GetValue ( ) const

inline

Definition at line 75 of file otbWrapperNumericalParameter.h.

◆ HasValue()

template<class T >

bool otb::Wrapper::NumericalParameter< T >::HasValue ( ) const

inlineoverridevirtual

Name of the parameter

Implements otb::Wrapper::Parameter.

Definition at line 84 of file otbWrapperNumericalParameter.h.

◆ operator=()

template<class T >

void otb::Wrapper::NumericalParameter< T >::operator= ( const Parameter & )

privatedelete

◆ Reset()

template<class T >

void otb::Wrapper::NumericalParameter< T >::Reset ( )

inlineoverridevirtual

Implement the reset method (replace value by default value)

Reimplemented from otb::Wrapper::Parameter.

Definition at line 52 of file otbWrapperNumericalParameter.h.

◆ SetDefaultValue()

template<class T >

virtual void otb::Wrapper::NumericalParameter< T >::SetDefaultValue ( ScalarType _arg )

virtual

Set the default value

◆ SetMaximumValue()

template<class T >

virtual void otb::Wrapper::NumericalParameter< T >::SetMaximumValue ( ScalarType _arg )

virtual

Set the maximum value

◆ SetMinimumValue()

template<class T >

virtual void otb::Wrapper::NumericalParameter< T >::SetMinimumValue ( ScalarType _arg )

virtual

Set the minimum value

◆ SetValue() [1/2]

template<class T >

void otb::Wrapper::NumericalParameter< T >::SetValue ( const std::string & valueStr )

inline

Definition at line 69 of file otbWrapperNumericalParameter.h.

◆ SetValue() [2/2]

template<class T >

void otb::Wrapper::NumericalParameter< T >::SetValue ( ScalarType value )

inline

Set the value

Definition at line 58 of file otbWrapperNumericalParameter.h.

◆ ToDouble()

template<class T >

double otb::Wrapper::NumericalParameter< T >::ToDouble ( ) const

inlineoverridevirtual

Name of the parameter

Reimplemented from otb::Wrapper::Parameter.

Definition at line 131 of file otbWrapperNumericalParameter.h.

◆ ToFloat()

template<class T >

float otb::Wrapper::NumericalParameter< T >::ToFloat ( ) const

inlineoverridevirtual

Name of the parameter

Reimplemented from otb::Wrapper::Parameter.

Definition at line 122 of file otbWrapperNumericalParameter.h.

◆ ToInt()

template<class T >

int otb::Wrapper::NumericalParameter< T >::ToInt ( ) const

inlineoverridevirtual

Parameter conversion functions. They are used by WrapperApplication to provide functions like SetParameterInt, GetParameterString, etc.

Reimplemented from otb::Wrapper::Parameter.

Definition at line 113 of file otbWrapperNumericalParameter.h.

◆ ToString()

template<class T >

std::string otb::Wrapper::NumericalParameter< T >::ToString ( ) const

inlineoverridevirtual

Name of the parameter

Reimplemented from otb::Wrapper::Parameter.

Definition at line 150 of file otbWrapperNumericalParameter.h.

Member Data Documentation

◆ m_DefaultValue

template<class T >

ScalarType otb::Wrapper::NumericalParameter< T >::m_DefaultValue

protected

Default value (when applicable)

Definition at line 173 of file otbWrapperNumericalParameter.h.

◆ m_MaximumValue

template<class T >

ScalarType otb::Wrapper::NumericalParameter< T >::m_MaximumValue

protected

Maximum value

Definition at line 179 of file otbWrapperNumericalParameter.h.

◆ m_MinimumValue

template<class T >

ScalarType otb::Wrapper::NumericalParameter< T >::m_MinimumValue

protected

Minimum value

Definition at line 176 of file otbWrapperNumericalParameter.h.

◆ m_Value

template<class T >

boost::optional<T> otb::Wrapper::NumericalParameter< T >::m_Value

protected

Value

Definition at line 170 of file otbWrapperNumericalParameter.h.

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

otbWrapperNumericalParameter.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

template<class T> class otb::Wrapper::NumericalParameter< T >

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ ScalarType

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ NumericalParameter() [1/2]

◆ ~NumericalParameter()

◆ NumericalParameter() [2/2]

Member Function Documentation

◆ ClearValue()

◆ FromInt()

◆ FromString()

◆ GetDefaultValue()

◆ GetMaximumValue()

◆ GetMinimumValue()

◆ GetValue()

◆ HasValue()

◆ operator=()

◆ Reset()

◆ SetDefaultValue()

◆ SetMaximumValue()

◆ SetMinimumValue()

◆ SetValue() [1/2]

◆ SetValue() [2/2]

◆ ToDouble()

◆ ToFloat()

◆ ToInt()

◆ ToString()

Member Data Documentation

◆ m_DefaultValue

◆ m_MaximumValue

◆ m_MinimumValue

◆ m_Value

template<class T>
class otb::Wrapper::NumericalParameter< T >