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::ListViewParameter Class Reference

#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< SelfPointer
 
typedef ListViewParameter 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 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< std::string > selectedItems)
 
void SetSelectedItems (std::vector< int > 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 (unsigned int v)
 
virtual void SetValue (std::string choiceKey)
 
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 AddChild (Parameter::Pointer child)
 
void AutomaticValueOff ()
 
void AutomaticValueOn ()
 
virtual void FromFloat (float)
 
virtual void FromInt (int)
 
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 int ToInt () const
 
virtual float ToFloat () 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
< ListViewChoice
ChoiceList
 

Protected Member Functions

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

 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

Definition at line 201 of file otbWrapperListViewParameter.h.

Definition at line 49 of file otbWrapperListViewParameter.h.

Definition at line 48 of file otbWrapperListViewParameter.h.

Standard class typedef

Definition at line 46 of file otbWrapperListViewParameter.h.

Definition at line 47 of file otbWrapperListViewParameter.h.

Constructor & Destructor Documentation

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

Constructor

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

Destructor

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

Member Function Documentation

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

Add a value to the choice

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

Reimplemented from otb::Wrapper::Parameter.

Definition at line 94 of file otbWrapperListViewParameter.h.

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

Reimplemented from itk::Object.

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

Reimplemented from otb::Wrapper::Parameter.

Definition at line 171 of file otbWrapperListViewParameter.h.

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

Reimplemented from otb::Wrapper::Parameter.

Definition at line 181 of file otbWrapperListViewParameter.h.

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

Get the key of a specific choice value

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

Get the list of the different choice keys

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

Get the long name of a specific choice value

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

Get the list of the different choice keys

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

RTTI support

Reimplemented from otb::Wrapper::Parameter.

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

Get the number of available choice

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

Definition at line 101 of file otbWrapperListViewParameter.h.

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

Definition at line 116 of file otbWrapperListViewParameter.h.

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

Definition at line 108 of file otbWrapperListViewParameter.h.

virtual bool otb::Wrapper::ListViewParameter::GetSingleSelection ( )
virtual
ParameterType otb::Wrapper::ListViewParameter::GetType ( ) const
inlineoverridevirtual

Get the dynamic type as declared in WrapperTypes.h

Implements otb::Wrapper::Parameter.

Definition at line 154 of file otbWrapperListViewParameter.h.

References otb::Wrapper::ParameterType_ListView.

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

Return any value

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

Implements otb::Wrapper::Parameter.

Definition at line 88 of file otbWrapperListViewParameter.h.

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

Defining ::New() static method

void otb::Wrapper::ListViewParameter::operator= ( const ListViewParameter )
privatedelete
void otb::Wrapper::ListViewParameter::SetSelectedItems ( std::vector< std::string >  selectedItems)
inline

Definition at line 129 of file otbWrapperListViewParameter.h.

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

Definition at line 139 of file otbWrapperListViewParameter.h.

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 123 of file otbWrapperListViewParameter.h.

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 127 of file otbWrapperListViewParameter.h.

void otb::Wrapper::ListViewParameter::SetSelectedKeys ( std::vector< std::string >  selectedKeys)
void otb::Wrapper::ListViewParameter::SetSelectedNames ( std::vector< std::string >  selectedNames)
virtual void otb::Wrapper::ListViewParameter::SetSingleSelection ( bool  _arg)
virtual
virtual void otb::Wrapper::ListViewParameter::SetValue ( unsigned int  v)
virtual

Set choice value

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

Set choice value by its key

virtual void otb::Wrapper::ListViewParameter::SingleSelectionOff ( )
virtual
virtual void otb::Wrapper::ListViewParameter::SingleSelectionOn ( )
virtual
std::string otb::Wrapper::ListViewParameter::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 159 of file otbWrapperListViewParameter.h.

std::vector<std::string> otb::Wrapper::ListViewParameter::ToStringList ( ) 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 176 of file otbWrapperListViewParameter.h.

Member Data Documentation

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

Definition at line 202 of file otbWrapperListViewParameter.h.

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

Definition at line 203 of file otbWrapperListViewParameter.h.

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

Definition at line 204 of file otbWrapperListViewParameter.h.

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

Definition at line 205 of file otbWrapperListViewParameter.h.

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

Definition at line 206 of file otbWrapperListViewParameter.h.

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

Definition at line 207 of file otbWrapperListViewParameter.h.


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