OTB  6.7.0
Orfeo Toolbox
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
otb::Wrapper::ChoiceParameter Class Reference

#include <otbWrapperChoiceParameter.h>

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

Classes

struct  Choice
 

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef itk::SmartPointer< SelfPointer
 
typedef ChoiceParameter 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 AddChoice (std::string choicekey, std::string choiceName)
 
void ClearValue () override
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
void FromInt (int value) override
 
void FromString (const std::string &value) override
 
std::string GetChoiceKey (int i) const
 
std::vector< std::string > GetChoiceKeys ()
 
std::string GetChoiceName (int i)
 
std::vector< std::string > GetChoiceNames ()
 
ParameterGroup::Pointer GetChoiceParameterGroupByIndex (int i)
 
ParameterGroup::Pointer GetChoiceParameterGroupByKey (std::string choiceKey)
 
virtual const char * GetNameOfClass () const
 
unsigned int GetNbChoices (void)
 
std::vector< std::string > GetParametersKeys ()
 
ParameterType GetType () const override
 
virtual unsigned int GetValue () const
 
bool HasValue () const override
 
virtual void SetValue (unsigned int v)
 
virtual void SetValue (std::string choiceKey)
 
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 Role GetRole () const
 
virtual const Parameter::Pointer GetRoot () const
 
virtual UserLevel GetUserLevel () const
 
virtual bool HasUserValue () const
 
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 float ToFloat () const
 
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 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
 

Static Public Member Functions

static Pointer New ()
 
- 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 ()
 

Protected Types

typedef std::vector< ChoiceChoiceList
 

Protected Member Functions

 ChoiceParameter ()
 
 ~ChoiceParameter () 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

ChoiceList m_ChoiceList
 
unsigned int m_CurrentChoice
 
- 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

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

Detailed Description

This class represent a multiple choice parameter for the wrapper framework.

Represents an enumerated parameter. The different values of the enumeration can be associated with a parameter

Definition at line 40 of file otbWrapperChoiceParameter.h.

Member Typedef Documentation

typedef std::vector<Choice> otb::Wrapper::ChoiceParameter::ChoiceList
protected

Definition at line 119 of file otbWrapperChoiceParameter.h.

Definition at line 48 of file otbWrapperChoiceParameter.h.

Definition at line 47 of file otbWrapperChoiceParameter.h.

Standard class typedef

Definition at line 45 of file otbWrapperChoiceParameter.h.

Definition at line 46 of file otbWrapperChoiceParameter.h.

Constructor & Destructor Documentation

otb::Wrapper::ChoiceParameter::ChoiceParameter ( )
protected

Constructor

otb::Wrapper::ChoiceParameter::~ChoiceParameter ( )
overrideprotected

Destructor

otb::Wrapper::ChoiceParameter::ChoiceParameter ( const ChoiceParameter )
privatedelete

Member Function Documentation

void otb::Wrapper::ChoiceParameter::AddChoice ( std::string  choicekey,
std::string  choiceName 
)

Add a value to the choice

void otb::Wrapper::ChoiceParameter::ClearValue ( )
overridevirtual

Reimplemented from otb::Wrapper::Parameter.

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

Reimplemented from itk::Object.

void otb::Wrapper::ChoiceParameter::FromInt ( int  value)
overridevirtual

Reimplemented from otb::Wrapper::Parameter.

void otb::Wrapper::ChoiceParameter::FromString ( const std::string &  value)
overridevirtual

Reimplemented from otb::Wrapper::Parameter.

std::string otb::Wrapper::ChoiceParameter::GetChoiceKey ( int  i) const

Get the key of a specific choice value

std::vector<std::string> otb::Wrapper::ChoiceParameter::GetChoiceKeys ( )

Get the list of the different choice keys

std::string otb::Wrapper::ChoiceParameter::GetChoiceName ( int  i)

Get the long name of a specific choice value

std::vector<std::string> otb::Wrapper::ChoiceParameter::GetChoiceNames ( )

Get the list of the different choice keys

ParameterGroup::Pointer otb::Wrapper::ChoiceParameter::GetChoiceParameterGroupByIndex ( int  i)

Get the ParameterGroup associated to a choice value

ParameterGroup::Pointer otb::Wrapper::ChoiceParameter::GetChoiceParameterGroupByKey ( std::string  choiceKey)

Get the ParameterGroup associated to a choice value

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

RTTI support

Reimplemented from otb::Wrapper::Parameter.

unsigned int otb::Wrapper::ChoiceParameter::GetNbChoices ( void  )

Get the number of available choice

std::vector<std::string> otb::Wrapper::ChoiceParameter::GetParametersKeys ( )

Get all parameters that are child of this choice parameter

ParameterType otb::Wrapper::ChoiceParameter::GetType ( ) const
overridevirtual

Get the dynamic type as declared in WrapperTypes.h

Implements otb::Wrapper::Parameter.

virtual unsigned int otb::Wrapper::ChoiceParameter::GetValue ( ) const
virtual

Return any value

bool otb::Wrapper::ChoiceParameter::HasValue ( ) const
overridevirtual
static Pointer otb::Wrapper::ChoiceParameter::New ( )
static

Defining ::New() static method

void otb::Wrapper::ChoiceParameter::operator= ( const ChoiceParameter )
privatedelete
virtual void otb::Wrapper::ChoiceParameter::SetValue ( unsigned int  v)
virtual

Set choice value

virtual void otb::Wrapper::ChoiceParameter::SetValue ( std::string  choiceKey)
virtual

Set choice value by its key

int otb::Wrapper::ChoiceParameter::ToInt ( ) const
overridevirtual

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

Reimplemented from otb::Wrapper::Parameter.

std::string otb::Wrapper::ChoiceParameter::ToString ( ) const
overridevirtual

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

Reimplemented from otb::Wrapper::Parameter.

Member Data Documentation

ChoiceList otb::Wrapper::ChoiceParameter::m_ChoiceList
protected

Definition at line 120 of file otbWrapperChoiceParameter.h.

unsigned int otb::Wrapper::ChoiceParameter::m_CurrentChoice
protected

Definition at line 122 of file otbWrapperChoiceParameter.h.


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