OTB  6.7.0
Orfeo Toolbox
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
otb::Wrapper::NumericalParameter< T > Class Template Reference

#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< SelfPointer
 
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< SelfPointer
 
typedef Parameter Self
 
typedef itk::Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

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 (ScalarType value)
 
void SetValue (const std::string &valueStr)
 
float ToFloat () const override
 
int ToInt () const override
 
std::string ToString () const override
 
- Public Member Functions inherited from otb::Wrapper::Parameter
virtual void AddChild (Parameter::Pointer child)
 
void AutomaticValueOff ()
 
void AutomaticValueOn ()
 
virtual void FromFloat (float)
 
virtual void FromStringList (const std::vector< std::string > &)
 
virtual bool GetAutomaticValue () const
 
virtual std::vector
< Parameter::Pointer
GetChildrenList ()
 
virtual const char * GetNameOfClass () const
 
virtual Role GetRole () const
 
virtual const Parameter::Pointer GetRoot () const
 
virtual ParameterType GetType () const =0
 
virtual UserLevel GetUserLevel () const
 
virtual bool HasUserValue () const
 
virtual bool IsRoot () const
 
virtual void SetAutomaticValue (bool flag)
 
virtual void SetRole (const Role role)
 
virtual void SetRoot (const Parameter::Pointer root)
 
virtual void SetUserLevel (const UserLevel level)
 
virtual void SetUserValue (bool isUserValue)
 
void TypeError (const std::string &target_type) 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 std::vector< std::string > ToStringList () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
virtual ModifiedTimeType GetMTime () const
 
virtual const std::string & GetObjectName () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Protected Member Functions

 NumericalParameter ()
 
 ~NumericalParameter () override
 
- Protected Member Functions inherited from otb::Wrapper::Parameter
 Parameter ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Protected Attributes

ScalarType m_DefaultValue
 
ScalarType m_MaximumValue
 
ScalarType m_MinimumValue
 
boost::optional< T > m_Value
 
- Protected Attributes inherited from otb::Wrapper::Parameter
bool m_Active
 
std::vector< Parameter::Pointerm_ChildrenList
 
std::string m_Description
 
std::string m_Key
 
bool m_Mandatory
 
std::string m_Name
 
Role m_Role
 
itk::WeakPointer< Parameterm_Root
 
UserLevel m_UserLevel
 
bool m_UserValue
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Private Member Functions

 NumericalParameter (const Parameter &)=delete
 
void operator= (const Parameter &)=delete
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Detailed Description

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

This class represents a numerical parameter.

Definition at line 38 of file otbWrapperNumericalParameter.h.

Member Typedef Documentation

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

Definition at line 45 of file otbWrapperNumericalParameter.h.

Definition at line 44 of file otbWrapperNumericalParameter.h.

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

Typedef of the scalar type

Definition at line 48 of file otbWrapperNumericalParameter.h.

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

Standard class typedef

Definition at line 42 of file otbWrapperNumericalParameter.h.

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

Definition at line 43 of file otbWrapperNumericalParameter.h.

Constructor & Destructor Documentation

template<class T>
otb::Wrapper::NumericalParameter< T >::NumericalParameter ( )
inlineprotected

Constructor

Definition at line 150 of file otbWrapperNumericalParameter.h.

template<class T>
otb::Wrapper::NumericalParameter< T >::~NumericalParameter ( )
inlineoverrideprotected

Destructor

Definition at line 157 of file otbWrapperNumericalParameter.h.

template<class T>
otb::Wrapper::NumericalParameter< T >::NumericalParameter ( const Parameter )
privatedelete

Member Function Documentation

template<class T>
void otb::Wrapper::NumericalParameter< T >::ClearValue ( )
inlineoverridevirtual

Reimplemented from otb::Wrapper::Parameter.

Definition at line 89 of file otbWrapperNumericalParameter.h.

template<class T>
void otb::Wrapper::NumericalParameter< T >::FromInt ( int  value)
inlineoverridevirtual

Reimplemented from otb::Wrapper::Parameter.

Definition at line 131 of file otbWrapperNumericalParameter.h.

template<class T>
void otb::Wrapper::NumericalParameter< T >::FromString ( const std::string &  value)
inlineoverridevirtual

Reimplemented from otb::Wrapper::Parameter.

Definition at line 136 of file otbWrapperNumericalParameter.h.

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

Get the default value

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

Get the maximum value

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

Get the minimum value

template<class T>
ScalarType otb::Wrapper::NumericalParameter< T >::GetValue ( void  ) const
inline

Definition at line 75 of file otbWrapperNumericalParameter.h.

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

Implements otb::Wrapper::Parameter.

Definition at line 84 of file otbWrapperNumericalParameter.h.

template<class T>
void otb::Wrapper::NumericalParameter< T >::operator= ( const Parameter )
privatedelete
template<class T>
void otb::Wrapper::NumericalParameter< T >::Reset ( void  )
inlineoverridevirtual

Implement the reset method (replace value by default value)

Reimplemented from otb::Wrapper::Parameter.

Definition at line 51 of file otbWrapperNumericalParameter.h.

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

Set the default value

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

Set the maximum value

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

Set the minimum value

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

Set the value

Definition at line 57 of file otbWrapperNumericalParameter.h.

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

Definition at line 69 of file otbWrapperNumericalParameter.h.

template<class T>
float otb::Wrapper::NumericalParameter< T >::ToFloat ( ) 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 122 of file otbWrapperNumericalParameter.h.

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.

template<class T>
std::string otb::Wrapper::NumericalParameter< T >::ToString ( ) 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 141 of file otbWrapperNumericalParameter.h.

Member Data Documentation

template<class T>
ScalarType otb::Wrapper::NumericalParameter< T >::m_DefaultValue
protected

Default value (when appliable)

Definition at line 164 of file otbWrapperNumericalParameter.h.

template<class T>
ScalarType otb::Wrapper::NumericalParameter< T >::m_MaximumValue
protected

Maximum value

Definition at line 170 of file otbWrapperNumericalParameter.h.

template<class T>
ScalarType otb::Wrapper::NumericalParameter< T >::m_MinimumValue
protected

Minimum value

Definition at line 167 of file otbWrapperNumericalParameter.h.

template<class T>
boost::optional<T> otb::Wrapper::NumericalParameter< T >::m_Value
protected

Value

Definition at line 161 of file otbWrapperNumericalParameter.h.


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