OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | List of all members
otb::Wrapper::DoubleParameter Class Reference

#include <otbWrapperNumericalParameter.h>

+ Inheritance diagram for otb::Wrapper::DoubleParameter:
+ Collaboration diagram for otb::Wrapper::DoubleParameter:

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef itk::SmartPointer< SelfPointer
 
typedef DoubleParameter Self
 
- Public Types inherited from otb::Wrapper::NumericalParameter< double >
typedef itk::SmartPointer< const SelfConstPointer
 
typedef itk::SmartPointer< SelfPointer
 
typedef double ScalarType
 
typedef NumericalParameter Self
 
typedef Parameter Superclass
 
- Public Types inherited from otb::Wrapper::Parameter
typedef itk::SmartPointer< const SelfConstPointer
 
typedef itk::SmartPointer< SelfPointer
 
typedef Parameter Self
 
typedef itk::Object Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
void FromDouble (double value) override
 
virtual const char * GetNameOfClass () const
 
ParameterType GetType () const override
 
- Public Member Functions inherited from otb::Wrapper::NumericalParameter< double >
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 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 HasValue () const =0
 
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::PointerGetChildrenList ()
 
void TypeError (const std::string &target_type) const
 
virtual int ToInt () const
 
virtual float ToFloat () const
 
virtual double ToDouble () const
 
virtual std::string ToString () const
 
virtual std::vector< std::string > ToStringList () const
 
virtual void FromFloat (float)
 
virtual void FromStringList (const std::vector< std::string > &)
 

Static Public Member Functions

static Pointer New ()
 

Additional Inherited Members

- Protected Member Functions inherited from otb::Wrapper::NumericalParameter< double >
 NumericalParameter ()
 
 ~NumericalParameter () override
 
- Protected Member Functions inherited from otb::Wrapper::Parameter
 Parameter ()
 
- Protected Attributes inherited from otb::Wrapper::NumericalParameter< double >
ScalarType m_DefaultValue
 
ScalarType m_MaximumValue
 
ScalarType m_MinimumValue
 
boost::optional< double > 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< Parameterm_Root
 
std::vector< Parameter::Pointerm_ChildrenList
 

Detailed Description

Definition at line 209 of file otbWrapperNumericalParameter.h.

Member Typedef Documentation

◆ ConstPointer

typedef itk::SmartPointer<const Self> otb::Wrapper::DoubleParameter::ConstPointer

Definition at line 215 of file otbWrapperNumericalParameter.h.

◆ Pointer

typedef itk::SmartPointer<Self> otb::Wrapper::DoubleParameter::Pointer

Definition at line 214 of file otbWrapperNumericalParameter.h.

◆ Self

Standard class typedef

Definition at line 213 of file otbWrapperNumericalParameter.h.

Member Function Documentation

◆ CreateAnother()

virtual::itk::LightObject::Pointer otb::Wrapper::DoubleParameter::CreateAnother ( void  ) const

◆ FromDouble()

void otb::Wrapper::DoubleParameter::FromDouble ( double  )
inlineoverridevirtual

Name of the parameter

Reimplemented from otb::Wrapper::Parameter.

Definition at line 225 of file otbWrapperNumericalParameter.h.

◆ GetNameOfClass()

virtual const char* otb::Wrapper::DoubleParameter::GetNameOfClass ( ) const
virtual

RTTI support

Reimplemented from otb::Wrapper::Parameter.

◆ GetType()

ParameterType otb::Wrapper::DoubleParameter::GetType ( ) const
inlineoverridevirtual

Get the dynamic type as declared in WrapperTypes.h

Implements otb::Wrapper::Parameter.

Definition at line 220 of file otbWrapperNumericalParameter.h.

References otb::Wrapper::ParameterType_Double.

◆ New()

static Pointer otb::Wrapper::DoubleParameter::New ( )
static

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