OTB  6.7.0
Orfeo Toolbox
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
otb::Wrapper::ParameterList< T > Class Template Reference

#include <otbWrapperParameterList.h>

+ Inheritance diagram for otb::Wrapper::ParameterList< T >:
+ Collaboration diagram for otb::Wrapper::ParameterList< T >:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef std::vector< typename
T::Pointer > 
ParameterVector
 
typedef itk::SmartPointer< SelfPointer
 
typedef ParameterList Self
 
typedef AbstractParameterList Superclass
 
- Public Types inherited from otb::Wrapper::AbstractParameterList
typedef AbstractParameterList 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 Types inherited from otb::Wrapper::StringListInterface
typedef std::vector< std::string > StringVector
 

Public Member Functions

void AddFromFileName (const std::string &) override
 
ParameterVector::const_iterator begin () const
 
void ClearValue () override
 
ParameterVector::const_iterator end () const
 
virtual const char * GetNameOfClass () const
 
void Insert (const std::string &, std::vcl_size_t=-1) override
 
void InsertNullElement (std::vcl_size_t=-1) override
 
void SetListFromFileName (const StringVector &) override
 
bool HasValue () 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 void FromString (const std::string &)
 
virtual bool GetAutomaticValue () const
 
virtual std::vector
< Parameter::Pointer
GetChildrenList ()
 
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 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 LightObject::Pointer CreateAnother () const override
 
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
 
- Public Member Functions inherited from otb::Wrapper::StringListInterface
virtual void AddNullElement ()
 
virtual void Erase (std::vcl_size_t id)
 
virtual Role GetDirection (std::vcl_size_t) const
 
virtual Role GetDirection () const =0
 
virtual const std::string & GetFilenameFilter (std::vcl_size_t) const
 
virtual const std::string & GetFilenameFilter () const
 
virtual bool IsActive (std::vcl_size_t) const =0
 
virtual bool IsFilename () const
 

Protected Member Functions

 ParameterList ()
 
 ~ParameterList () override
 
- Protected Member Functions inherited from otb::Wrapper::AbstractParameterList
 AbstractParameterList ()
 
 ~AbstractParameterList () 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 Member Functions inherited from otb::Wrapper::StringListInterface
 StringListInterface ()
 

Protected Attributes

ParameterVector m_Parameters
 
- 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
 
void SetNthFileName (std::vcl_size_t, const std::string &) override
 
std::vcl_size_t SetStrings (const StringVector &) override
 
std::vcl_size_t GetStrings (StringVector &) const override
 
StringVector GetFileNameList () const override
 
std::string GetNthFileName (std::vcl_size_t) const override
 
const std::string & GetToolTip (std::vcl_size_t) const override
 
void Erase (std::vcl_size_t start, std::vcl_size_t count) override
 
std::vcl_size_t Size () const override
 
bool IsActive (vcl_size_t) const override
 
void Swap (std::vcl_size_t, std::vcl_size_t) override
 
std::vector< std::string > ToStringList () const override
 
void FromStringList (const std::vector< std::string > &value) override
 
std::string ToString () const override
 
template<typename L , typename From , typename Get >
void SetObjectList (L &, const L &, From, Get)
 
template<typename L , typename Get >
L::ObjectType * GetObjectList (L &, Get)
 
template<typename L , typename Get >
const L::ObjectType * GetObjectList (L &, Get) const
 
template<typename D , typename From >
void AddData (D *, From)
 
template<typename D , typename Set >
T::Pointer FromData (D *, Set, const std::string &description=std::string())
 
template<typename D , typename Set >
T::Pointer & FromData (typename T::Pointer &, D *, Set, const std::string &description=std::string())
 

Additional Inherited Members

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

Detailed Description

template<typename T>
class otb::Wrapper::ParameterList< T >

This class represents a InputImage parameter.

Definition at line 42 of file otbWrapperParameterList.h.

Member Typedef Documentation

template<typename T>
typedef itk::SmartPointer< const Self > otb::Wrapper::ParameterList< T >::ConstPointer

Definition at line 53 of file otbWrapperParameterList.h.

template<typename T>
typedef std::vector< typename T::Pointer > otb::Wrapper::ParameterList< T >::ParameterVector

Custom types

Definition at line 56 of file otbWrapperParameterList.h.

template<typename T>
typedef itk::SmartPointer< Self > otb::Wrapper::ParameterList< T >::Pointer

Definition at line 52 of file otbWrapperParameterList.h.

template<typename T>
typedef ParameterList otb::Wrapper::ParameterList< T >::Self

Standard class typedef

Definition at line 49 of file otbWrapperParameterList.h.

template<typename T>
typedef AbstractParameterList otb::Wrapper::ParameterList< T >::Superclass

Definition at line 50 of file otbWrapperParameterList.h.

Constructor & Destructor Documentation

template<typename T >
otb::Wrapper::ParameterList< T >::ParameterList ( )
protected

Constructor

Definition at line 42 of file otbWrapperParameterList.hxx.

template<typename T >
otb::Wrapper::ParameterList< T >::~ParameterList ( )
overrideprotected

Destructor

Definition at line 51 of file otbWrapperParameterList.hxx.

Member Function Documentation

template<typename T >
template<typename D , typename From >
void otb::Wrapper::ParameterList< T >::AddData ( D *  data,
From  from 
)
protected

Set one specific stored filename.

Definition at line 429 of file otbWrapperParameterList.hxx.

template<typename T >
void otb::Wrapper::ParameterList< T >::AddFromFileName ( const std::string &  filename)
overridevirtual

Add a filename from a filename

Implements otb::Wrapper::StringListInterface.

Definition at line 136 of file otbWrapperParameterList.hxx.

template<typename T >
ParameterList< T >::ParameterVector::const_iterator otb::Wrapper::ParameterList< T >::begin ( ) const

Definition at line 59 of file otbWrapperParameterList.hxx.

template<typename T >
void otb::Wrapper::ParameterList< T >::ClearValue ( )
overridevirtual

Reimplemented from otb::Wrapper::Parameter.

Definition at line 98 of file otbWrapperParameterList.hxx.

template<typename T >
ParameterList< T >::ParameterVector::const_iterator otb::Wrapper::ParameterList< T >::end ( ) const

Definition at line 68 of file otbWrapperParameterList.hxx.

template<typename T >
void otb::Wrapper::ParameterList< T >::Erase ( std::vcl_size_t  start,
std::vcl_size_t  count 
)
overridevirtual

Set one specific stored filename.

Implements otb::Wrapper::StringListInterface.

Definition at line 280 of file otbWrapperParameterList.hxx.

template<typename T >
template<typename D , typename Set >
T::Pointer otb::Wrapper::ParameterList< T >::FromData ( D *  data,
Set  set,
const std::string &  description = std::string() 
)
protected

Set one specific stored filename.

Definition at line 447 of file otbWrapperParameterList.hxx.

template<typename T>
template<typename D , typename Set >
T::Pointer & otb::Wrapper::ParameterList< T >::FromData ( typename T::Pointer &  parameter,
D *  data,
Set  set,
const std::string &  description = std::string() 
)
protected

Set one specific stored filename.

Definition at line 463 of file otbWrapperParameterList.hxx.

template<typename T >
void otb::Wrapper::ParameterList< T >::FromStringList ( const std::vector< std::string > &  value)
overridevirtual

Set one specific stored filename.

Reimplemented from otb::Wrapper::Parameter.

Definition at line 485 of file otbWrapperParameterList.hxx.

template<typename T >
StringListInterface::StringVector otb::Wrapper::ParameterList< T >::GetFileNameList ( ) const
overridevirtual

Get the stored image filename list

Implements otb::Wrapper::StringListInterface.

Definition at line 243 of file otbWrapperParameterList.hxx.

template<typename T>
virtual const char* otb::Wrapper::ParameterList< T >::GetNameOfClass ( ) const
virtual
template<typename T >
std::string otb::Wrapper::ParameterList< T >::GetNthFileName ( std::vcl_size_t  i) const
overridevirtual

Get one specific stored image filename.

Implements otb::Wrapper::StringListInterface.

Definition at line 256 of file otbWrapperParameterList.hxx.

template<typename T >
template<typename L , typename Get >
L::ObjectType * otb::Wrapper::ParameterList< T >::GetObjectList ( L &  this_list,
Get  get 
)
protected

Utility method to factorize some code

Definition at line 385 of file otbWrapperParameterList.hxx.

template<typename T >
template<typename L , typename Get >
const L::ObjectType * otb::Wrapper::ParameterList< T >::GetObjectList ( L &  this_list,
Get  get 
) const
protected

Set one specific stored filename.

Definition at line 417 of file otbWrapperParameterList.hxx.

template<typename T >
std::vcl_size_t otb::Wrapper::ParameterList< T >::GetStrings ( StringVector strings) const
overridevirtual

Set one specific stored filename.

Reimplemented from otb::Wrapper::StringListInterface.

Definition at line 223 of file otbWrapperParameterList.hxx.

template<typename T >
const std::string & otb::Wrapper::ParameterList< T >::GetToolTip ( std::vcl_size_t  i) const
overridevirtual

Set one specific stored filename.

Implements otb::Wrapper::StringListInterface.

Definition at line 267 of file otbWrapperParameterList.hxx.

template<typename T >
bool otb::Wrapper::ParameterList< T >::HasValue ( ) const
overridevirtual

Implements otb::Wrapper::Parameter.

Definition at line 77 of file otbWrapperParameterList.hxx.

template<typename T >
void otb::Wrapper::ParameterList< T >::Insert ( const std::string &  filename,
std::vcl_size_t  index = -1 
)
overridevirtual

Implements otb::Wrapper::StringListInterface.

Definition at line 157 of file otbWrapperParameterList.hxx.

template<typename T >
void otb::Wrapper::ParameterList< T >::InsertNullElement ( std::vcl_size_t  index = -1)
overridevirtual

Implements otb::Wrapper::StringListInterface.

Definition at line 118 of file otbWrapperParameterList.hxx.

template<typename T>
bool otb::Wrapper::ParameterList< T >::IsActive ( vcl_size_t  ) const
override

Set one specific stored filename.

Definition at line 307 of file otbWrapperParameterList.hxx.

template<typename T >
void otb::Wrapper::ParameterList< T >::SetListFromFileName ( const StringVector strings)
overridevirtual

Set file form a list of filenames

Implements otb::Wrapper::StringListInterface.

Definition at line 109 of file otbWrapperParameterList.hxx.

template<typename T >
void otb::Wrapper::ParameterList< T >::SetNthFileName ( std::vcl_size_t  i,
const std::string &  filename 
)
overridevirtual

Set one specific stored filename.

Implements otb::Wrapper::StringListInterface.

Definition at line 176 of file otbWrapperParameterList.hxx.

template<typename T >
template<typename L , typename From , typename Get >
void otb::Wrapper::ParameterList< T >::SetObjectList ( L &  this_list,
const L &  list,
From  from,
Get  get 
)
protected

Utility method to factorize some code

Definition at line 343 of file otbWrapperParameterList.hxx.

template<typename T >
std::vcl_size_t otb::Wrapper::ParameterList< T >::SetStrings ( const StringVector strings)
overridevirtual

Set one specific stored filename.

Reimplemented from otb::Wrapper::StringListInterface.

Definition at line 194 of file otbWrapperParameterList.hxx.

template<typename T >
std::vcl_size_t otb::Wrapper::ParameterList< T >::Size ( void  ) const
overridevirtual

Retrieve number of elements

Implements otb::Wrapper::StringListInterface.

Definition at line 298 of file otbWrapperParameterList.hxx.

template<typename T >
void otb::Wrapper::ParameterList< T >::Swap ( std::vcl_size_t  i1,
std::vcl_size_t  i2 
)
overridevirtual

Set one specific stored filename.

Implements otb::Wrapper::StringListInterface.

Definition at line 320 of file otbWrapperParameterList.hxx.

template<typename T >
std::string otb::Wrapper::ParameterList< T >::ToString ( ) const
overridevirtual

Set one specific stored filename.

Reimplemented from otb::Wrapper::Parameter.

Definition at line 491 of file otbWrapperParameterList.hxx.

template<typename T >
std::vector< std::string > otb::Wrapper::ParameterList< T >::ToStringList ( ) const
overridevirtual

Set one specific stored filename.

Reimplemented from otb::Wrapper::Parameter.

Definition at line 479 of file otbWrapperParameterList.hxx.

Member Data Documentation

template<typename T>
ParameterVector otb::Wrapper::ParameterList< T >::m_Parameters
protected

Definition at line 171 of file otbWrapperParameterList.h.


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