OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
otb::Wrapper::AbstractParameterList Class Reference

#include <otbWrapperAbstractParameterList.h>

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

Public Types

typedef AbstractParameterList 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 Types inherited from otb::Wrapper::StringListInterface
typedef std::vector< std::string > StringVector
 

Public Member Functions

virtual const char * GetNameOfClass () const
 
- 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 HasValue () const =0
 
virtual bool HasUserValue () const
 
virtual void SetUserValue (bool isUserValue)
 
virtual void ClearValue ()
 
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 ()
 
virtual ParameterType GetType () const =0
 
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 FromInt (int)
 
virtual void FromFloat (float)
 
virtual void FromDouble (double)
 
virtual void FromString (const std::string &)
 
virtual void FromStringList (const std::vector< std::string > &)
 
- Public Member Functions inherited from otb::Wrapper::StringListInterface
virtual void AddFromFileName (const std::string &)=0
 
virtual void AddNullElement ()
 
virtual void Erase (std::vcl_size_t id)
 
virtual void Erase (std::vcl_size_t start, std::vcl_size_t count)=0
 
virtual Role GetDirection () const =0
 
virtual Role GetDirection (std::vcl_size_t) const
 
virtual const std::string & GetFilenameFilter () const
 
virtual const std::string & GetFilenameFilter (std::vcl_size_t) const
 
virtual StringVector GetFileNameList () const =0
 
virtual std::string GetNthFileName (std::vcl_size_t i) const =0
 
virtual std::vcl_size_t GetStrings (StringVector &) const
 
virtual const std::string & GetToolTip (std::vcl_size_t) const =0
 
virtual void Insert (const std::string &filename, std::vcl_size_t=-1)=0
 
virtual void InsertNullElement (std::vcl_size_t=-1)=0
 
virtual bool IsActive (std::vcl_size_t) const =0
 
virtual bool IsFilename () const
 
virtual void SetListFromFileName (const StringVector &)=0
 
virtual void SetNthFileName (std::vcl_size_t, const std::string &)=0
 
virtual std::vcl_size_t SetStrings (const StringVector &)
 
virtual std::vcl_size_t Size () const =0
 
virtual void Swap (std::vcl_size_t, std::vcl_size_t)=0
 

Protected Member Functions

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

Private Member Functions

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

Additional Inherited Members

- 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

This class is a base class for list-type parameters.

Definition at line 41 of file otbWrapperAbstractParameterList.h.

Member Typedef Documentation

◆ Self

Standard class typedef

Definition at line 47 of file otbWrapperAbstractParameterList.h.

◆ Superclass

Definition at line 48 of file otbWrapperAbstractParameterList.h.

Constructor & Destructor Documentation

◆ AbstractParameterList() [1/2]

otb::Wrapper::AbstractParameterList::AbstractParameterList ( )
protected

Constructor

◆ ~AbstractParameterList()

otb::Wrapper::AbstractParameterList::~AbstractParameterList ( )
overrideprotected

Destructor

◆ AbstractParameterList() [2/2]

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

Member Function Documentation

◆ GetNameOfClass()

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

◆ operator=()

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

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