otb::Wrapper::InputImageListParameter Class Reference

#include <otbWrapperInputImageListParameter.h>

Inheritance diagram for otb::Wrapper::InputImageListParameter:

Collaboration diagram for otb::Wrapper::InputImageListParameter:

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer
typedef itk::SmartPointer< Self >	Pointer
typedef InputImageListParameter	Self
typedef ParameterList< InputImageParameter >	Superclass
Public Types inherited from otb::Wrapper::ParameterList< InputImageParameter >
typedef itk::SmartPointer< const Self >	ConstPointer
typedef std::vector< typename InputImageParameter ::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
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
Public Member Functions inherited from otb::Wrapper::ParameterList< InputImageParameter >
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
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 InputImageParameter ::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
InputImageParameter ::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
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	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 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 &)
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 const std::string &	GetFilenameFilter (std::vcl_size_t) const
virtual StringVector	GetFileNameList () const =0
virtual bool	IsActive (std::vcl_size_t) const =0
virtual bool	IsFilename () const
virtual std::vcl_size_t	Size () const =0

Static Public Member Functions
static Pointer	New ()
FloatVectorImageListType::Pointer	m_ImageList
const FloatVectorImageListType *	GetImageList () const
FloatVectorImageListType *	GetImageList ()
const FloatVectorImageType *	GetNthImage (std::vcl_size_t) const
FloatVectorImageType *	GetNthImage (std::vcl_size_t)
void	SetNthImage (std::vcl_size_t, ImageBaseType *)
void	SetImageList (FloatVectorImageListType *)
void	AddImage (ImageBaseType *)
void	ClearValue () override
Role	GetDirection () const override
const std::string &	GetFilenameFilter () const override
ParameterType	GetType () const override
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
	InputImageListParameter ()
	~InputImageListParameter () override
	InputImageListParameter (const Parameter &)=delete
void	operator= (const Parameter &)=delete
InputImageParameter::Pointer	FromImage (ImageBaseType *)
InputImageParameter::Pointer &	FromImage (InputImageParameter::Pointer &, ImageBaseType *)

Additional Inherited Members
Protected Member Functions inherited from otb::Wrapper::ParameterList< InputImageParameter >
	ParameterList ()
	~ParameterList () override
void	SetObjectList (L &, const L &, From, Get)
L::ObjectType *	GetObjectList (L &, Get)
const L::ObjectType *	GetObjectList (L &, Get) const
void	AddData (D *, From)
InputImageParameter ::Pointer	FromData (D *, Set, const std::string &description=std::string())
InputImageParameter ::Pointer &	FromData (typename InputImageParameter ::Pointer &, D *, Set, const std::string &description=std::string())
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 inherited from otb::Wrapper::ParameterList< InputImageParameter >
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

Detailed Description

This class represents a list of InputImage parameter.

Definition at line 41 of file otbWrapperInputImageListParameter.h.

Member Typedef Documentation

ConstPointer

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

Definition at line 48 of file otbWrapperInputImageListParameter.h.

Pointer

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

Definition at line 47 of file otbWrapperInputImageListParameter.h.

Self

typedef InputImageListParameter otb::Wrapper::InputImageListParameter::Self

Standard class typedef

Definition at line 45 of file otbWrapperInputImageListParameter.h.

Superclass

typedef ParameterList<InputImageParameter> otb::Wrapper::InputImageListParameter::Superclass

Definition at line 46 of file otbWrapperInputImageListParameter.h.

Constructor & Destructor Documentation

InputImageListParameter() [1/2]

otb::Wrapper::InputImageListParameter::InputImageListParameter ( )

protected

Constructor

~InputImageListParameter()

otb::Wrapper::InputImageListParameter::~InputImageListParameter ( )

overrideprotected

Destructor

InputImageListParameter() [2/2]

otb::Wrapper::InputImageListParameter::InputImageListParameter ( const Parameter &  )

privatedelete

Get one list of the stored image. WARNING : if the parameter list changes, the returned image list may become obsolete. You should call GetImageList() again to make sure your image list is up-to-date.

Member Function Documentation

AddImage()

void otb::Wrapper::InputImageListParameter::AddImage

(

ImageBaseType *

)

Add an image to the list.

ClearValue()

void otb::Wrapper::InputImageListParameter::ClearValue ( )

overridevirtual

Clear all the list.

Reimplemented from otb::Wrapper::Parameter.

CreateAnother()

virtual::itk::LightObject::Pointer otb::Wrapper::InputImageListParameter::CreateAnother

(

void

)

const

FromImage() [1/2]

InputImageParameter::Pointer otb::Wrapper::InputImageListParameter::FromImage ( ImageBaseType *  )

private

Get one list of the stored image. WARNING : if the parameter list changes, the returned image list may become obsolete. You should call GetImageList() again to make sure your image list is up-to-date.

FromImage() [2/2]

InputImageParameter::Pointer& otb::Wrapper::InputImageListParameter::FromImage ( InputImageParameter::Pointer &  , ImageBaseType *    )

private

Get one list of the stored image. WARNING : if the parameter list changes, the returned image list may become obsolete. You should call GetImageList() again to make sure your image list is up-to-date.

GetDirection() [1/3]

Role otb::Wrapper::InputImageListParameter::GetDirection ( ) const

overridevirtual

Get one list of the stored image. WARNING : if the parameter list changes, the returned image list may become obsolete. You should call GetImageList() again to make sure your image list is up-to-date.

Implements otb::Wrapper::StringListInterface.

GetDirection() [2/3]

virtual Role otb::Wrapper::StringListInterface::GetDirection

Get one list of the stored image. WARNING : if the parameter list changes, the returned image list may become obsolete. You should call GetImageList() again to make sure your image list is up-to-date.

GetDirection() [3/3]

virtual Role otb::Wrapper::StringListInterface::GetDirection

Get one list of the stored image. WARNING : if the parameter list changes, the returned image list may become obsolete. You should call GetImageList() again to make sure your image list is up-to-date.

GetFilenameFilter() [1/3]

virtual const std::string& otb::Wrapper::StringListInterface::GetFilenameFilter

Get one list of the stored image. WARNING : if the parameter list changes, the returned image list may become obsolete. You should call GetImageList() again to make sure your image list is up-to-date.

GetFilenameFilter() [2/3]

const std::string& otb::Wrapper::InputImageListParameter::GetFilenameFilter ( ) const

overridevirtual

Get one list of the stored image. WARNING : if the parameter list changes, the returned image list may become obsolete. You should call GetImageList() again to make sure your image list is up-to-date.

Reimplemented from otb::Wrapper::StringListInterface.

GetFilenameFilter() [3/3]

virtual const std::string& otb::Wrapper::StringListInterface::GetFilenameFilter

Get one list of the stored image. WARNING : if the parameter list changes, the returned image list may become obsolete. You should call GetImageList() again to make sure your image list is up-to-date.

GetImageList() [1/2]

FloatVectorImageListType* otb::Wrapper::InputImageListParameter::GetImageList

(

)

Get one list of the stored image. WARNING : if the parameter list changes, the returned image list may become obsolete. You should call GetImageList() again to make sure your image list is up-to-date.

GetImageList() [2/2]

const FloatVectorImageListType* otb::Wrapper::InputImageListParameter::GetImageList

(

)

const

Get one list of the stored image. WARNING : if the parameter list changes, the returned image list may become obsolete. You should call GetImageList() again to make sure your image list is up-to-date.

GetNameOfClass()

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

virtual

RTTI support

Reimplemented from otb::Wrapper::AbstractParameterList.

GetNthImage() [1/2]

FloatVectorImageType* otb::Wrapper::InputImageListParameter::GetNthImage

(

std::vcl_size_t

)

Get one list of the stored image. WARNING : if the parameter list changes, the returned image list may become obsolete. You should call GetImageList() again to make sure your image list is up-to-date.

GetNthImage() [2/2]

const FloatVectorImageType* otb::Wrapper::InputImageListParameter::GetNthImage

(

std::vcl_size_t

)

const

Get one specific stored image.

GetType()

ParameterType otb::Wrapper::InputImageListParameter::GetType ( ) const

inlineoverridevirtual

Get one list of the stored image. WARNING : if the parameter list changes, the returned image list may become obsolete. You should call GetImageList() again to make sure your image list is up-to-date.

Implements otb::Wrapper::Parameter.

Definition at line 88 of file otbWrapperInputImageListParameter.h.

References otb::Wrapper::ParameterType_InputImageList.

New()

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

static

Defining ::New() static method

operator=()

void otb::Wrapper::InputImageListParameter::operator= ( const Parameter &  )

privatedelete

Get one list of the stored image. WARNING : if the parameter list changes, the returned image list may become obsolete. You should call GetImageList() again to make sure your image list is up-to-date.

SetImageList()

void otb::Wrapper::InputImageListParameter::SetImageList

(

FloatVectorImageListType *

)

Set the list of image.

SetNthImage()

void otb::Wrapper::InputImageListParameter::SetNthImage	(	std::vcl_size_t	,
		ImageBaseType *
	)

Set one specific image.

Member Data Documentation

m_ImageList

FloatVectorImageListType::Pointer otb::Wrapper::InputImageListParameter::m_ImageList

private

Get one list of the stored image. WARNING : if the parameter list changes, the returned image list may become obsolete. You should call GetImageList() again to make sure your image list is up-to-date.

Definition at line 113 of file otbWrapperInputImageListParameter.h.

---

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

• otbWrapperInputImageListParameter.h