OTB  7.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
otb::Wrapper::Parameter Class Referenceabstract

#include <otbWrapperParameter.h>

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

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef itk::SmartPointer< SelfPointer
 
typedef Parameter Self
 
typedef itk::Object Superclass
 

Public Member Functions

virtual void AddChild (Parameter::Pointer child)
 
void AutomaticValueOff ()
 
void AutomaticValueOn ()
 
virtual void ClearValue ()
 
virtual void FromFloat (float)
 
virtual void FromInt (int)
 
virtual void FromString (const std::string &)
 
virtual void FromStringList (const std::vector< std::string > &)
 
virtual bool GetAutomaticValue () const
 
virtual std::vector< Parameter::PointerGetChildrenList ()
 
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 HasValue () const =0
 
virtual bool IsRoot () const
 
virtual void Reset ()
 
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 int ToInt () const
 
virtual float ToFloat () const
 
virtual std::string ToString () const
 
virtual std::vector< std::string > ToStringList () const
 

Protected Member Functions

 Parameter ()
 

Protected Attributes

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
 

Private Member Functions

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

Detailed Description

This class represent a parameter for the wrapper framework This class is a high level class representing a parameter for the wrapper framework. It should be subclassed to represent different kinds of parameters.

Definition at line 49 of file otbWrapperParameter.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 56 of file otbWrapperParameter.h.

◆ Pointer

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

Definition at line 55 of file otbWrapperParameter.h.

◆ Self

Standard class typedef

Definition at line 53 of file otbWrapperParameter.h.

◆ Superclass

Definition at line 54 of file otbWrapperParameter.h.

Constructor & Destructor Documentation

◆ Parameter() [1/2]

otb::Wrapper::Parameter::Parameter ( )
protected

Constructor

◆ Parameter() [2/2]

otb::Wrapper::Parameter::Parameter ( const Parameter )
privatedelete

Member Function Documentation

◆ AddChild()

virtual void otb::Wrapper::Parameter::AddChild ( Parameter::Pointer  child)
virtual

Add a child of this parameter when the param is a Group or a choice

◆ AutomaticValueOff()

void otb::Wrapper::Parameter::AutomaticValueOff ( )

Toogle OFF the parameter AutomaticValue flag

◆ AutomaticValueOn()

void otb::Wrapper::Parameter::AutomaticValueOn ( )

Toogle ON the parameter AutomaticValue flag

◆ ClearValue()

virtual void otb::Wrapper::Parameter::ClearValue ( )
virtual

◆ FromFloat()

virtual void otb::Wrapper::Parameter::FromFloat ( float  )
virtual

Reimplemented in otb::Wrapper::FloatParameter.

◆ FromInt()

virtual void otb::Wrapper::Parameter::FromInt ( int  )
virtual

◆ FromString()

virtual void otb::Wrapper::Parameter::FromString ( const std::string &  )
virtual

◆ FromStringList()

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

◆ GetActive()

bool otb::Wrapper::Parameter::GetActive ( bool  recurseParents = false) const

Set the parameter Active flag

◆ GetAutomaticValue()

virtual bool otb::Wrapper::Parameter::GetAutomaticValue ( ) const
virtual

Get the parameter AutomaticValue flag

◆ GetChildrenList()

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

Get the children pointer list : not const cause we need to alterate the m_Active status and the m_IsCheckbox

◆ GetDescription()

virtual const std::string& otb::Wrapper::Parameter::GetDescription ( ) const
virtual

Set/get the parameter description

◆ GetKey()

virtual const char* otb::Wrapper::Parameter::GetKey ( ) const
virtual

Set/get the parameter key

◆ GetMandatory()

virtual bool otb::Wrapper::Parameter::GetMandatory ( ) const
virtual

Set the parameter Mandatory flag

◆ GetName()

virtual const char* otb::Wrapper::Parameter::GetName ( ) const
virtual

Set/get the parameter name

◆ GetNameOfClass()

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

◆ GetRole()

virtual Role otb::Wrapper::Parameter::GetRole ( ) const
virtual

Get the user access level

◆ GetRoot()

virtual const Parameter::Pointer otb::Wrapper::Parameter::GetRoot ( ) const
virtual

◆ GetType()

virtual ParameterType otb::Wrapper::Parameter::GetType ( ) const
pure virtual

◆ GetUserLevel()

virtual UserLevel otb::Wrapper::Parameter::GetUserLevel ( ) const
virtual

Get the user access level

◆ HasUserValue()

virtual bool otb::Wrapper::Parameter::HasUserValue ( ) const
virtual

◆ HasValue()

virtual bool otb::Wrapper::Parameter::HasValue ( ) const
pure virtual

◆ IsRoot()

virtual bool otb::Wrapper::Parameter::IsRoot ( ) const
virtual

Is the parameter a root or a child of another param

◆ MandatoryOff()

virtual void otb::Wrapper::Parameter::MandatoryOff ( )
virtual

Set the parameter Mandatory flag

◆ MandatoryOn()

virtual void otb::Wrapper::Parameter::MandatoryOn ( )
virtual

Set the parameter Mandatory flag

◆ operator=()

void otb::Wrapper::Parameter::operator= ( const Parameter )
privatedelete

◆ Reset()

virtual void otb::Wrapper::Parameter::Reset ( )
virtual

◆ SetActive()

virtual void otb::Wrapper::Parameter::SetActive ( bool  flag)
virtual

Set the parameter Active flag

Reimplemented in otb::Wrapper::DirectoryParameter.

◆ SetAutomaticValue()

virtual void otb::Wrapper::Parameter::SetAutomaticValue ( bool  flag)
virtual

Set the parameter AutomaticValue flag (which is the opposite of UserValue)

◆ SetDescription()

virtual void otb::Wrapper::Parameter::SetDescription ( const std::string &  )
virtual

Set/get the parameter description

◆ SetKey()

virtual void otb::Wrapper::Parameter::SetKey ( const std::string &  )
virtual

Set/get the parameter key

◆ SetMandatory()

virtual void otb::Wrapper::Parameter::SetMandatory ( bool  flag)
virtual

Set the parameter Mandatory flag

◆ SetName()

virtual void otb::Wrapper::Parameter::SetName ( const std::string &  )
virtual

Set/get the parameter name

◆ SetRole()

virtual void otb::Wrapper::Parameter::SetRole ( const Role  role)
virtual

Set the parameter io type

◆ SetRoot()

virtual void otb::Wrapper::Parameter::SetRoot ( const Parameter::Pointer  root)
virtual

Set/Get the root of the current parameter (direct parent)

◆ SetUserLevel()

virtual void otb::Wrapper::Parameter::SetUserLevel ( const UserLevel  level)
virtual

Set the user access level

◆ SetUserValue()

virtual void otb::Wrapper::Parameter::SetUserValue ( bool  isUserValue)
virtual

◆ ToFloat()

virtual float otb::Wrapper::Parameter::ToFloat ( ) const
virtual

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

Reimplemented in otb::Wrapper::NumericalParameter< T >, otb::Wrapper::NumericalParameter< float >, otb::Wrapper::NumericalParameter< int >, and otb::Wrapper::NumericalParameter< unsigned int >.

◆ ToInt()

virtual int otb::Wrapper::Parameter::ToInt ( ) const
virtual

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

Reimplemented in otb::Wrapper::NumericalParameter< T >, otb::Wrapper::NumericalParameter< float >, otb::Wrapper::NumericalParameter< int >, otb::Wrapper::NumericalParameter< unsigned int >, otb::Wrapper::ChoiceParameter, and otb::Wrapper::BoolParameter.

◆ ToString()

virtual std::string otb::Wrapper::Parameter::ToString ( ) const
virtual

◆ ToStringList()

virtual std::vector<std::string> otb::Wrapper::Parameter::ToStringList ( ) const
virtual

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

Reimplemented in otb::Wrapper::ListViewParameter, otb::Wrapper::ParameterList< T >, otb::Wrapper::ParameterList< InputImageParameter >, otb::Wrapper::ParameterList< StringParameter >, and otb::Wrapper::ParameterList< InputVectorDataParameter >.

◆ TypeError()

void otb::Wrapper::Parameter::TypeError ( const std::string &  target_type) const

Error raising function to indicate a type conversion error

Member Data Documentation

◆ m_Active

bool otb::Wrapper::Parameter::m_Active
protected

True if activated (a mandatory parameter is always active)

Definition at line 181 of file otbWrapperParameter.h.

◆ m_ChildrenList

std::vector<Parameter::Pointer> otb::Wrapper::Parameter::m_ChildrenList
protected

List of children parameters

Definition at line 195 of file otbWrapperParameter.h.

◆ m_Description

std::string otb::Wrapper::Parameter::m_Description
protected

Description of the parameter

Definition at line 172 of file otbWrapperParameter.h.

◆ m_Key

std::string otb::Wrapper::Parameter::m_Key
protected

Key of the parameter

Definition at line 175 of file otbWrapperParameter.h.

◆ m_Mandatory

bool otb::Wrapper::Parameter::m_Mandatory
protected

True if the parameter is mandatory

Definition at line 178 of file otbWrapperParameter.h.

◆ m_Name

std::string otb::Wrapper::Parameter::m_Name
protected

Name of the parameter

Definition at line 169 of file otbWrapperParameter.h.

◆ m_Role

Role otb::Wrapper::Parameter::m_Role
protected

Default iotype mode

Definition at line 189 of file otbWrapperParameter.h.

◆ m_Root

itk::WeakPointer<Parameter> otb::Wrapper::Parameter::m_Root
protected

List of parents Parameters

Definition at line 192 of file otbWrapperParameter.h.

◆ m_UserLevel

UserLevel otb::Wrapper::Parameter::m_UserLevel
protected

Definition at line 186 of file otbWrapperParameter.h.

◆ m_UserValue

bool otb::Wrapper::Parameter::m_UserValue
protected

True if the value is set in user mode (otherwise, it is an automatic value)

Definition at line 184 of file otbWrapperParameter.h.


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