#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< Self >	Pointer

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< Self >	Pointer

typedef Parameter	Self

typedef itk::Object	Superclass

Public Types inherited from otb::Wrapper::StringListInterface
typedef std::vector< std::string >	StringVector

Public Member Functions
ParameterVector::const_iterator	begin () const

ParameterVector::const_iterator	end () const

virtual void	Erase (std::vcl_size_t id)

virtual void	Erase (std::vcl_size_t start, std::vcl_size_t count)=0

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

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 void	FromInt (int)

virtual void	FromFloat (float)

virtual void	FromDouble (double)

virtual void	FromString (const std::string &)

Public Member Functions inherited from otb::Wrapper::StringListInterface
virtual void	AddNullElement ()

virtual void	Erase (std::vcl_size_t id)

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 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 otb::Wrapper::StringListInterface
	StringListInterface ()

Protected Attributes
ParameterVector	m_Parameters

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

void	ClearValue () override

bool	HasValue () const override

void	SetListFromFileName (const StringVector &) override

void	InsertNullElement (std::vcl_size_t=-1) override

void	AddFromFileName (const std::string &) override

void	Insert (const std::string &, std::vcl_size_t=-1) override

void	InsertElement (typename T::Pointer, std::vcl_size_t=-1)

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

T::Pointer	GetNthElement (std::vcl_size_t)

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

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

◆ ConstPointer

template<typename T >

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

Definition at line 52 of file otbWrapperParameterList.h.

◆ ParameterVector

template<typename T >

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

Custom types

Definition at line 55 of file otbWrapperParameterList.h.

◆ Pointer

template<typename T >

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

Definition at line 51 of file otbWrapperParameterList.h.

◆ Self

template<typename T >

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

Standard class typedef

Definition at line 48 of file otbWrapperParameterList.h.

◆ Superclass

template<typename T >

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

Definition at line 49 of file otbWrapperParameterList.h.

Constructor & Destructor Documentation

◆ ParameterList()

template<typename T >

otb::Wrapper::ParameterList< T >::ParameterList

protected

Constructor

Definition at line 41 of file otbWrapperParameterList.hxx.

◆ ~ParameterList()

template<typename T >

otb::Wrapper::ParameterList< T >::~ParameterList

overrideprotected

Destructor

Definition at line 47 of file otbWrapperParameterList.hxx.

Member Function Documentation

◆ AddData()

template<typename T >

template<typename D , typename From >

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

protected

Set file form a list of filenames

Definition at line 333 of file otbWrapperParameterList.hxx.

◆ AddFromFileName()

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 105 of file otbWrapperParameterList.hxx.

◆ begin()

template<typename T >

ParameterList< T >::ParameterVector::const_iterator otb::Wrapper::ParameterList< T >::begin

Definition at line 53 of file otbWrapperParameterList.hxx.

Referenced by otb::Wrapper::ParameterList< InputVectorDataParameter >::begin().

◆ ClearValue()

template<typename T >

void otb::Wrapper::ParameterList< T >::ClearValue

overridevirtual

Set file form a list of filenames

Reimplemented from otb::Wrapper::Parameter.

Definition at line 78 of file otbWrapperParameterList.hxx.

◆ end()

template<typename T >

ParameterList< T >::ParameterVector::const_iterator otb::Wrapper::ParameterList< T >::end

Definition at line 60 of file otbWrapperParameterList.hxx.

Referenced by otb::Wrapper::ParameterList< InputVectorDataParameter >::end().

◆ Erase() [1/3]

template<typename T >

virtual void otb::Wrapper::StringListInterface::Erase

Erase one element of the list.

◆ Erase() [2/3]

template<typename T >

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

overridevirtual

Set file form a list of filenames

Implements otb::Wrapper::StringListInterface.

Definition at line 224 of file otbWrapperParameterList.hxx.

◆ Erase() [3/3]

template<typename T >

virtual void otb::Wrapper::StringListInterface::Erase

◆ FromData() [1/2]

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 file form a list of filenames

Definition at line 349 of file otbWrapperParameterList.hxx.

◆ FromData() [2/2]

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 file form a list of filenames

Definition at line 361 of file otbWrapperParameterList.hxx.

◆ FromStringList()

template<typename T >

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

overridevirtual

Set file form a list of filenames

Reimplemented from otb::Wrapper::Parameter.

Definition at line 378 of file otbWrapperParameterList.hxx.

◆ GetFileNameList()

template<typename T >

StringListInterface::StringVector otb::Wrapper::ParameterList< T >::GetFileNameList

overridevirtual

Get the stored image filename list

Implements otb::Wrapper::StringListInterface.

Definition at line 193 of file otbWrapperParameterList.hxx.

◆ GetNameOfClass()

template<typename T >

virtual const char* otb::Wrapper::ParameterList< T >::GetNameOfClass ( ) const

virtual

RTTI support

Reimplemented from otb::Wrapper::AbstractParameterList.

◆ GetNthElement()

template<typename T >

T::Pointer otb::Wrapper::ParameterList< T >::GetNthElement ( std::vcl_size_t i )

Set file form a list of filenames

Definition at line 401 of file otbWrapperParameterList.hxx.

◆ GetNthFileName()

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 204 of file otbWrapperParameterList.hxx.

◆ GetObjectList() [1/2]

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 304 of file otbWrapperParameterList.hxx.

◆ GetObjectList() [2/2]

template<typename T >

template<typename L , typename Get >

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

protected

Set file form a list of filenames

Definition at line 325 of file otbWrapperParameterList.hxx.

◆ GetStrings()

template<typename T >

std::vcl_size_t otb::Wrapper::ParameterList< T >::GetStrings ( StringVector & strings ) const

overridevirtual

Set file form a list of filenames

Reimplemented from otb::Wrapper::StringListInterface.

Definition at line 184 of file otbWrapperParameterList.hxx.

◆ GetToolTip()

template<typename T >

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

overridevirtual

Set file form a list of filenames

Implements otb::Wrapper::StringListInterface.

Definition at line 213 of file otbWrapperParameterList.hxx.

◆ HasValue()

template<typename T >

bool otb::Wrapper::ParameterList< T >::HasValue

overridevirtual

Set file form a list of filenames

Implements otb::Wrapper::Parameter.

Definition at line 67 of file otbWrapperParameterList.hxx.

◆ Insert()

template<typename T >

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

overridevirtual

Set file form a list of filenames

Implements otb::Wrapper::StringListInterface.

Definition at line 124 of file otbWrapperParameterList.hxx.

◆ InsertElement()

template<typename T >

void otb::Wrapper::ParameterList< T >::InsertElement	(	typename T::Pointer	p,
		std::vcl_size_t	index = `-1`
	)

Set file form a list of filenames

Definition at line 135 of file otbWrapperParameterList.hxx.

◆ InsertNullElement()

template<typename T >

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

overridevirtual

Set file form a list of filenames

Implements otb::Wrapper::StringListInterface.

Definition at line 94 of file otbWrapperParameterList.hxx.

◆ IsActive()

template<typename T >

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

override

Set file form a list of filenames

Definition at line 244 of file otbWrapperParameterList.hxx.

◆ SetListFromFileName()

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 87 of file otbWrapperParameterList.hxx.

◆ SetNthFileName()

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 148 of file otbWrapperParameterList.hxx.

◆ SetObjectList()

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 267 of file otbWrapperParameterList.hxx.

◆ SetStrings()

template<typename T >

std::vcl_size_t otb::Wrapper::ParameterList< T >::SetStrings ( const StringVector & strings )

overridevirtual

Set file form a list of filenames

Reimplemented from otb::Wrapper::StringListInterface.

Definition at line 163 of file otbWrapperParameterList.hxx.

◆ Size()

template<typename T >

std::vcl_size_t otb::Wrapper::ParameterList< T >::Size

overridevirtual

Retrieve number of elements

Implements otb::Wrapper::StringListInterface.

Definition at line 237 of file otbWrapperParameterList.hxx.

◆ Swap()

template<typename T >

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

overridevirtual

Set file form a list of filenames

Implements otb::Wrapper::StringListInterface.

Definition at line 255 of file otbWrapperParameterList.hxx.

◆ ToString()

template<typename T >

std::string otb::Wrapper::ParameterList< T >::ToString

overridevirtual

Set file form a list of filenames

Reimplemented from otb::Wrapper::Parameter.

Definition at line 384 of file otbWrapperParameterList.hxx.

◆ ToStringList()

template<typename T >

std::vector< std::string > otb::Wrapper::ParameterList< T >::ToStringList

overridevirtual

Set file form a list of filenames

Reimplemented from otb::Wrapper::Parameter.

Definition at line 372 of file otbWrapperParameterList.hxx.

Member Data Documentation

◆ m_Parameters

template<typename T >

ParameterVector otb::Wrapper::ParameterList< T >::m_Parameters

protected

Definition at line 163 of file otbWrapperParameterList.h.

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

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

Member Typedef Documentation

◆ ConstPointer

◆ ParameterVector

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ ParameterList()

◆ ~ParameterList()

Member Function Documentation

◆ AddData()

◆ AddFromFileName()

◆ begin()

◆ ClearValue()

◆ end()

◆ Erase() [1/3]

◆ Erase() [2/3]

◆ Erase() [3/3]

◆ FromData() [1/2]

◆ FromData() [2/2]

◆ FromStringList()

◆ GetFileNameList()

◆ GetNameOfClass()

◆ GetNthElement()

◆ GetNthFileName()

◆ GetObjectList() [1/2]

◆ GetObjectList() [2/2]

◆ GetStrings()

◆ GetToolTip()

◆ HasValue()

◆ Insert()

◆ InsertElement()

◆ InsertNullElement()

◆ IsActive()

◆ SetListFromFileName()

◆ SetNthFileName()

◆ SetObjectList()

◆ SetStrings()

◆ Size()

◆ Swap()

◆ ToString()

◆ ToStringList()

Member Data Documentation

◆ m_Parameters

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