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

#include <otbWrapperInputFilenameListParameter.h>

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

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef itk::SmartPointer< SelfPointer
 
typedef InputFilenameListParameter Self
 
typedef ParameterList< StringParameterSuperclass
 
- Public Types inherited from otb::Wrapper::ParameterList< StringParameter >
typedef itk::SmartPointer< const SelfConstPointer
 
typedef std::vector< typename StringParameter ::PointerParameterVector
 
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 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 ::itk::LightObject::Pointer CreateAnother (void) const
 
Role GetDirection () const override
 
Role GetDirection (std::vcl_size_t) const override
 
const std::string & GetFilenameFilter () const override
 
const std::string & GetFilenameFilter (std::vcl_size_t) const override
 
virtual const char * GetNameOfClass () const
 
ParameterType GetType () const override
 
- Public Member Functions inherited from otb::Wrapper::ParameterList< StringParameter >
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 StringParameter ::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
 
StringParameter ::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::PointerGetChildrenList ()
 
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 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 ()
 

Protected Member Functions

 InputFilenameListParameter ()
 
 ~InputFilenameListParameter () override
 
- Protected Member Functions inherited from otb::Wrapper::ParameterList< StringParameter >
 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)
 
StringParameter ::Pointer FromData (D *, Set, const std::string &description=std::string())
 
StringParameter ::PointerFromData (typename StringParameter ::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 ()
 

Private Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from otb::Wrapper::ParameterList< StringParameter >
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< Parameterm_Root
 
std::vector< Parameter::Pointerm_ChildrenList
 

Detailed Description

This class represents a list of InputFilename parameter.

Definition at line 40 of file otbWrapperInputFilenameListParameter.h.

Member Typedef Documentation

◆ ConstPointer

Definition at line 50 of file otbWrapperInputFilenameListParameter.h.

◆ Pointer

Definition at line 49 of file otbWrapperInputFilenameListParameter.h.

◆ Self

Standard class typedef

Definition at line 46 of file otbWrapperInputFilenameListParameter.h.

◆ Superclass

Definition at line 47 of file otbWrapperInputFilenameListParameter.h.

Constructor & Destructor Documentation

◆ InputFilenameListParameter() [1/2]

otb::Wrapper::InputFilenameListParameter::InputFilenameListParameter ( )
protected

Constructor

◆ ~InputFilenameListParameter()

otb::Wrapper::InputFilenameListParameter::~InputFilenameListParameter ( )
overrideprotected

Destructor

◆ InputFilenameListParameter() [2/2]

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

Member Function Documentation

◆ CreateAnother()

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

◆ GetDirection() [1/2]

Role otb::Wrapper::InputFilenameListParameter::GetDirection ( ) const
overridevirtual

◆ GetDirection() [2/2]

Role otb::Wrapper::InputFilenameListParameter::GetDirection ( std::vcl_size_t  ) const
overridevirtual

Reimplemented from otb::Wrapper::StringListInterface.

◆ GetFilenameFilter() [1/2]

const std::string& otb::Wrapper::InputFilenameListParameter::GetFilenameFilter ( ) const
overridevirtual

Reimplemented from otb::Wrapper::StringListInterface.

◆ GetFilenameFilter() [2/2]

const std::string& otb::Wrapper::InputFilenameListParameter::GetFilenameFilter ( std::vcl_size_t  ) const
overridevirtual

Reimplemented from otb::Wrapper::StringListInterface.

◆ GetNameOfClass()

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

RTTI support

Reimplemented from otb::Wrapper::AbstractParameterList.

◆ GetType()

ParameterType otb::Wrapper::InputFilenameListParameter::GetType ( ) const
overridevirtual

Get the dynamic type as declared in WrapperTypes.h

Implements otb::Wrapper::Parameter.

◆ New()

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

Defining ::New() static method

◆ operator=()

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

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