OTB  9.0.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::ListViewParameter Class Reference
Group Core » Module OTBApplicationEngine

#include <otbWrapperListViewParameter.h>

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

Classes

struct  ListViewChoice
 

Public Types

typedef itk::SmartPointer< const Self > ConstPointer
 
typedef itk::SmartPointer< Self > Pointer
 
typedef ListViewParameter 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 AddChoice (std::string choicekey, std::string choiceName)
 
void ClearChoices ()
 
void ClearValue () override
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
void FromString (const std::string &value) override
 
void FromStringList (const std::vector< std::string > &values) override
 
std::string GetChoiceKey (int i) const
 
std::vector< std::string > GetChoiceKeys ()
 
std::string GetChoiceName (int i)
 
std::vector< std::string > GetChoiceNames ()
 
virtual const char * GetNameOfClass () const
 
unsigned int GetNbChoices (void)
 
std::vector< int > GetSelectedItems ()
 
std::vector< std::string > GetSelectedKeys ()
 
std::vector< std::string > GetSelectedNames () const
 
virtual bool GetSingleSelection ()
 
ParameterType GetType () const override
 
virtual unsigned int GetValue () const
 
bool HasValue () const override
 
void SetSelectedItems (std::vector< int > selectedItems)
 
void SetSelectedItems (std::vector< std::string > selectedItems)
 
void SetSelectedItemsByKeys ()
 
void SetSelectedItemsByNames ()
 
void SetSelectedKeys (std::vector< std::string > selectedKeys)
 
void SetSelectedNames (std::vector< std::string > selectedNames)
 
virtual void SetSingleSelection (bool _arg)
 
virtual void SetValue (std::string choiceKey)
 
virtual void SetValue (unsigned int v)
 
virtual void SingleSelectionOff ()
 
virtual void SingleSelectionOn ()
 
std::string ToString () const override
 
std::vector< std::string > ToStringList () 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 void Reset ()
 
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 ()
 
void TypeError (const std::string &target_type) const
 
virtual int ToInt () const
 
virtual float ToFloat () const
 
virtual double ToDouble () const
 
virtual void FromInt (int)
 
virtual void FromFloat (float)
 
virtual void FromDouble (double)
 

Static Public Member Functions

static Pointer New ()
 

Protected Types

typedef std::vector< ListViewChoice > ChoiceList
 

Protected Member Functions

 ListViewParameter ()
 
 ~ListViewParameter () override
 
- Protected Member Functions inherited from otb::Wrapper::Parameter
 Parameter ()
 

Protected Attributes

ChoiceList m_ChoiceList
 
unsigned int m_CurrentChoice
 
std::vector< int > m_SelectedItems
 
std::vector< std::string > m_SelectedKeys
 
std::vector< std::string > m_SelectedNames
 
bool m_SingleSelection
 
- 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

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

Detailed Description

This class represent a ListWidget parameter for the wrapper framework.

The row selected in the ListWidget are stored in a std::vector. The method GetSelectedItems() allow the user to access to this method.

Definition at line 41 of file otbWrapperListViewParameter.h.

Member Typedef Documentation

◆ ChoiceList

typedef std::vector<ListViewChoice> otb::Wrapper::ListViewParameter::ChoiceList
protected

Definition at line 206 of file otbWrapperListViewParameter.h.

◆ ConstPointer

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

Definition at line 48 of file otbWrapperListViewParameter.h.

◆ Pointer

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

Definition at line 47 of file otbWrapperListViewParameter.h.

◆ Self

typedef ListViewParameter otb::Wrapper::ListViewParameter::Self

Standard class typedef

Definition at line 45 of file otbWrapperListViewParameter.h.

◆ Superclass

typedef Parameter otb::Wrapper::ListViewParameter::Superclass

Definition at line 46 of file otbWrapperListViewParameter.h.

Constructor & Destructor Documentation

◆ ListViewParameter() [1/2]

otb::Wrapper::ListViewParameter::ListViewParameter ( )
protected

Constructor

◆ ~ListViewParameter()

otb::Wrapper::ListViewParameter::~ListViewParameter ( )
overrideprotected

Destructor

◆ ListViewParameter() [2/2]

otb::Wrapper::ListViewParameter::ListViewParameter ( const ListViewParameter &  )
privatedelete

Member Function Documentation

◆ AddChoice()

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

Add a value to the choice

◆ ClearChoices()

void otb::Wrapper::ListViewParameter::ClearChoices ( )

◆ ClearValue()

void otb::Wrapper::ListViewParameter::ClearValue ( )
inlineoverridevirtual

Name of the parameter

Reimplemented from otb::Wrapper::Parameter.

Definition at line 93 of file otbWrapperListViewParameter.h.

◆ CreateAnother()

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

◆ FromString()

void otb::Wrapper::ListViewParameter::FromString ( const std::string &  )
inlineoverridevirtual

Name of the parameter

Reimplemented from otb::Wrapper::Parameter.

Definition at line 174 of file otbWrapperListViewParameter.h.

◆ FromStringList()

void otb::Wrapper::ListViewParameter::FromStringList ( const std::vector< std::string > &  )
inlineoverridevirtual

Name of the parameter

Reimplemented from otb::Wrapper::Parameter.

Definition at line 184 of file otbWrapperListViewParameter.h.

◆ GetChoiceKey()

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

Get the key of a specific choice value

◆ GetChoiceKeys()

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

Get the list of the different choice keys

◆ GetChoiceName()

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

Get the long name of a specific choice value

◆ GetChoiceNames()

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

Get the list of the different choice keys

◆ GetNameOfClass()

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

RTTI support

Reimplemented from otb::Wrapper::Parameter.

Reimplemented in otb::Wrapper::BandParameter, and otb::Wrapper::FieldParameter.

◆ GetNbChoices()

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

Get the number of available choice

◆ GetSelectedItems()

std::vector<int> otb::Wrapper::ListViewParameter::GetSelectedItems ( )
inline

Definition at line 100 of file otbWrapperListViewParameter.h.

◆ GetSelectedKeys()

std::vector<std::string> otb::Wrapper::ListViewParameter::GetSelectedKeys ( )
inline

Definition at line 115 of file otbWrapperListViewParameter.h.

◆ GetSelectedNames()

std::vector<std::string> otb::Wrapper::ListViewParameter::GetSelectedNames ( ) const
inline

Definition at line 107 of file otbWrapperListViewParameter.h.

◆ GetSingleSelection()

virtual bool otb::Wrapper::ListViewParameter::GetSingleSelection ( )
virtual

◆ GetType()

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

Get the dynamic type as declared in WrapperTypes.h

Implements otb::Wrapper::Parameter.

Definition at line 157 of file otbWrapperListViewParameter.h.

References otb::Wrapper::ParameterType_ListView.

◆ GetValue()

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

Return any value

◆ HasValue()

bool otb::Wrapper::ListViewParameter::HasValue ( ) const
inlineoverridevirtual

Name of the parameter

Implements otb::Wrapper::Parameter.

Definition at line 87 of file otbWrapperListViewParameter.h.

◆ New()

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

Defining ::New() static method

◆ operator=()

void otb::Wrapper::ListViewParameter::operator= ( const ListViewParameter &  )
privatedelete

◆ SetSelectedItems() [1/2]

void otb::Wrapper::ListViewParameter::SetSelectedItems ( std::vector< int >  selectedItems)
inline

Definition at line 142 of file otbWrapperListViewParameter.h.

◆ SetSelectedItems() [2/2]

void otb::Wrapper::ListViewParameter::SetSelectedItems ( std::vector< std::string >  selectedItems)
inline

Definition at line 132 of file otbWrapperListViewParameter.h.

◆ SetSelectedItemsByKeys()

void otb::Wrapper::ListViewParameter::SetSelectedItemsByKeys ( )
inline

Set selected items using a lit of selected keys. OBSOLETE : this method is not needed anymore and does nothing.

Definition at line 122 of file otbWrapperListViewParameter.h.

◆ SetSelectedItemsByNames()

void otb::Wrapper::ListViewParameter::SetSelectedItemsByNames ( )
inline

Set selected items using a lit of selected names. OBSOLETE : this method is not needed anymore and does nothing.

Definition at line 128 of file otbWrapperListViewParameter.h.

◆ SetSelectedKeys()

void otb::Wrapper::ListViewParameter::SetSelectedKeys ( std::vector< std::string >  selectedKeys)

◆ SetSelectedNames()

void otb::Wrapper::ListViewParameter::SetSelectedNames ( std::vector< std::string >  selectedNames)

◆ SetSingleSelection()

virtual void otb::Wrapper::ListViewParameter::SetSingleSelection ( bool  _arg)
virtual

◆ SetValue() [1/2]

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

Set choice value by its key

◆ SetValue() [2/2]

virtual void otb::Wrapper::ListViewParameter::SetValue ( unsigned int  v)
virtual

Set choice value

◆ SingleSelectionOff()

virtual void otb::Wrapper::ListViewParameter::SingleSelectionOff ( )
virtual

◆ SingleSelectionOn()

virtual void otb::Wrapper::ListViewParameter::SingleSelectionOn ( )
virtual

◆ ToString()

std::string otb::Wrapper::ListViewParameter::ToString ( ) const
inlineoverridevirtual

Name of the parameter

Reimplemented from otb::Wrapper::Parameter.

Definition at line 162 of file otbWrapperListViewParameter.h.

◆ ToStringList()

std::vector<std::string> otb::Wrapper::ListViewParameter::ToStringList ( ) const
inlineoverridevirtual

Name of the parameter

Reimplemented from otb::Wrapper::Parameter.

Definition at line 179 of file otbWrapperListViewParameter.h.

Member Data Documentation

◆ m_ChoiceList

ChoiceList otb::Wrapper::ListViewParameter::m_ChoiceList
protected

Definition at line 207 of file otbWrapperListViewParameter.h.

◆ m_CurrentChoice

unsigned int otb::Wrapper::ListViewParameter::m_CurrentChoice
protected

Definition at line 208 of file otbWrapperListViewParameter.h.

◆ m_SelectedItems

std::vector<int> otb::Wrapper::ListViewParameter::m_SelectedItems
protected

Definition at line 209 of file otbWrapperListViewParameter.h.

◆ m_SelectedKeys

std::vector<std::string> otb::Wrapper::ListViewParameter::m_SelectedKeys
protected

Definition at line 210 of file otbWrapperListViewParameter.h.

◆ m_SelectedNames

std::vector<std::string> otb::Wrapper::ListViewParameter::m_SelectedNames
protected

Definition at line 211 of file otbWrapperListViewParameter.h.

◆ m_SingleSelection

bool otb::Wrapper::ListViewParameter::m_SingleSelection
protected

Definition at line 212 of file otbWrapperListViewParameter.h.

The documentation for this class was generated from the following file:
Generated at Wed Feb 28 2024 15:25:56 for OTB with   doxygen 1.8.17