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

#include <otbWrapperStringListParameter.h>

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

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef itk::SmartPointer< SelfPointer
 
typedef StringListParameter Self
 
typedef
StringListInterface::StringVector 
StringListType
 
typedef ParameterList
< StringParameter
Superclass
 
- Public Types inherited from otb::Wrapper::ParameterList< StringParameter >
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef std::vector< typename
StringParameter::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 AddString (const std::string &value)
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
Role GetDirection () const override
 
virtual const char * GetNameOfClass () const
 
std::string GetNthElement (std::vcl_size_t) const
 
ParameterType GetType () const override
 
StringListInterface::StringVector GetValue () const
 
bool IsFilename () const override
 
void SetNthElement (std::vcl_size_t, const std::string &)
 
void SetValue (const StringListInterface::StringVector &)
 
- Public Member Functions inherited from otb::Wrapper::ParameterList< StringParameter >
void AddFromFileName (const std::string &) override
 
ParameterVector::const_iterator begin () const
 
void ClearValue () override
 
ParameterVector::const_iterator end () const
 
void Erase (std::vcl_size_t start, std::vcl_size_t count) override
 
void FromStringList (const std::vector< std::string > &value) override
 
StringVector GetFileNameList () const override
 
std::string GetNthFileName (std::vcl_size_t) const override
 
std::vcl_size_t GetStrings (StringVector &) const override
 
const std::string & GetToolTip (std::vcl_size_t) const override
 
bool HasValue () const override
 
void Insert (const std::string &, std::vcl_size_t=-1) override
 
void InsertNullElement (std::vcl_size_t=-1) override
 
bool IsActive (vcl_size_t) const override
 
void SetListFromFileName (const StringVector &) override
 
void SetNthFileName (std::vcl_size_t, const std::string &) override
 
std::vcl_size_t SetStrings (const StringVector &) override
 
std::vcl_size_t Size () const override
 
void Swap (std::vcl_size_t, std::vcl_size_t) override
 
std::string ToString () const override
 
std::vector< std::string > ToStringList () 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 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 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 const std::string & GetFilenameFilter (std::vcl_size_t) const
 
virtual const std::string & GetFilenameFilter () const
 
virtual bool IsActive (std::vcl_size_t) const =0
 

Static Public Member Functions

static Pointer New ()
 
- 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 ()
 

Protected Member Functions

 StringListParameter ()
 
 ~StringListParameter () override
 
- Protected Member Functions inherited from otb::Wrapper::ParameterList< StringParameter >
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())
 
L::ObjectType * GetObjectList (L &, Get)
 
const L::ObjectType * GetObjectList (L &, Get) const
 
 ParameterList ()
 
void SetObjectList (L &, const L &, From, Get)
 
 ~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 ()
 

Private Member Functions

void operator= (const StringListParameter &)=delete
 
 StringListParameter (const StringListParameter &)=delete
 

Additional Inherited Members

- Protected Attributes inherited from otb::Wrapper::ParameterList< StringParameter >
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
 

Detailed Description

This class represent a list of string parameter for the wrapper framework.

Definition at line 41 of file otbWrapperStringListParameter.h.

Member Typedef Documentation

Definition at line 51 of file otbWrapperStringListParameter.h.

Definition at line 50 of file otbWrapperStringListParameter.h.

Standard class typedef

Definition at line 48 of file otbWrapperStringListParameter.h.

Definition at line 53 of file otbWrapperStringListParameter.h.

Definition at line 49 of file otbWrapperStringListParameter.h.

Constructor & Destructor Documentation

otb::Wrapper::StringListParameter::StringListParameter ( )
protected

Constructor

otb::Wrapper::StringListParameter::~StringListParameter ( )
overrideprotected

Destructor

otb::Wrapper::StringListParameter::StringListParameter ( const StringListParameter )
privatedelete

Member Function Documentation

void otb::Wrapper::StringListParameter::AddString ( const std::string &  value)
virtual::itk::LightObject::Pointer otb::Wrapper::StringListParameter::CreateAnother ( void  ) const
virtual

Reimplemented from itk::Object.

Role otb::Wrapper::StringListParameter::GetDirection ( ) const
overridevirtual
virtual const char* otb::Wrapper::StringListParameter::GetNameOfClass ( ) const
virtual

RTTI support

Reimplemented from otb::Wrapper::ParameterList< StringParameter >.

std::string otb::Wrapper::StringListParameter::GetNthElement ( std::vcl_size_t  ) const

Get the value

ParameterType otb::Wrapper::StringListParameter::GetType ( ) const
inlineoverridevirtual

Get the dynamic type as declared in WrapperTypes.h

Implements otb::Wrapper::Parameter.

Definition at line 83 of file otbWrapperStringListParameter.h.

References otb::Wrapper::ParameterType_StringList.

StringListInterface::StringVector otb::Wrapper::StringListParameter::GetValue ( ) const

Get the value

bool otb::Wrapper::StringListParameter::IsFilename ( ) const
overridevirtual

Reimplemented from otb::Wrapper::StringListInterface.

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

Defining ::New() static method

void otb::Wrapper::StringListParameter::operator= ( const StringListParameter )
privatedelete
void otb::Wrapper::StringListParameter::SetNthElement ( std::vcl_size_t  ,
const std::string &   
)

Get the value

void otb::Wrapper::StringListParameter::SetValue ( const StringListInterface::StringVector )

Set the value


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