otb::Wrapper::StringParameter Class Reference

#include <otbWrapperStringParameter.h>

Inheritance diagram for otb::Wrapper::StringParameter:

Collaboration diagram for otb::Wrapper::StringParameter:

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer
typedef itk::SmartPointer< Self >	Pointer
typedef StringParameter	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 Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
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 ()
void	TypeError (const std::string &target_type) const
virtual int	ToInt () const
virtual float	ToFloat () const
virtual double	ToDouble () const
virtual std::vector< std::string >	ToStringList () const
virtual void	FromInt (int)
virtual void	FromFloat (float)
virtual void	FromDouble (double)
virtual void	FromStringList (const std::vector< std::string > &)

Static Public Member Functions
static Pointer	New ()
std::string	m_Value
void	SetValue (const std::string &value)
const std::string &	GetValue () const
bool	HasValue () const override
void	ClearValue () override
ParameterType	GetType () const override
std::string	ToString () const override
void	FromString (const std::string &value) override
	StringParameter ()
	~StringParameter () override
	StringParameter (const StringParameter &)=delete
void	operator= (const StringParameter &)=delete

Additional Inherited Members
Protected Member Functions inherited from otb::Wrapper::Parameter
	Parameter ()
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 represent a string parameter for the wrapper framework.

Definition at line 37 of file otbWrapperStringParameter.h.

Member Typedef Documentation

ConstPointer

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

Definition at line 44 of file otbWrapperStringParameter.h.

Pointer

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

Definition at line 43 of file otbWrapperStringParameter.h.

Self

typedef StringParameter otb::Wrapper::StringParameter::Self

Standard class typedef

Definition at line 41 of file otbWrapperStringParameter.h.

Superclass

typedef Parameter otb::Wrapper::StringParameter::Superclass

Definition at line 42 of file otbWrapperStringParameter.h.

Constructor & Destructor Documentation

StringParameter() [1/2]

otb::Wrapper::StringParameter::StringParameter ( )

inlineprotected

Constructor

Definition at line 93 of file otbWrapperStringParameter.h.

~StringParameter()

otb::Wrapper::StringParameter::~StringParameter ( )

inlineoverrideprotected

Destructor

Definition at line 98 of file otbWrapperStringParameter.h.

StringParameter() [2/2]

otb::Wrapper::StringParameter::StringParameter ( const StringParameter &  )

privatedelete

Set the value

Member Function Documentation

ClearValue()

void otb::Wrapper::StringParameter::ClearValue ( )

inlineoverridevirtual

Set the value

Reimplemented from otb::Wrapper::Parameter.

Definition at line 71 of file otbWrapperStringParameter.h.

CreateAnother()

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

(

void

)

const

FromString()

void otb::Wrapper::StringParameter::FromString ( const std::string &  value )

inlineoverridevirtual

Set the value

Reimplemented from otb::Wrapper::Parameter.

Definition at line 86 of file otbWrapperStringParameter.h.

GetNameOfClass()

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

virtual

RTTI support

Reimplemented from otb::Wrapper::Parameter.

GetType()

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

inlineoverridevirtual

Set the value

Implements otb::Wrapper::Parameter.

Definition at line 76 of file otbWrapperStringParameter.h.

References otb::Wrapper::ParameterType_String.

GetValue()

const std::string& otb::Wrapper::StringParameter::GetValue ( ) const

inline

Get the value

Definition at line 61 of file otbWrapperStringParameter.h.

HasValue()

bool otb::Wrapper::StringParameter::HasValue ( ) const

inlineoverridevirtual

Set the value

Implements otb::Wrapper::Parameter.

Definition at line 66 of file otbWrapperStringParameter.h.

New()

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

static

Defining ::New() static method

Referenced by otb::Wrapper::DirectoryParameter::DirectoryParameter(), otb::Wrapper::InputFilenameParameter::InputFilenameParameter(), and otb::Wrapper::OutputFilenameParameter::OutputFilenameParameter().

operator=()

void otb::Wrapper::StringParameter::operator= ( const StringParameter &  )

privatedelete

Set the value

SetValue()

void otb::Wrapper::StringParameter::SetValue ( const std::string &  value )

inline

Set the value

Definition at line 53 of file otbWrapperStringParameter.h.

ToString()

std::string otb::Wrapper::StringParameter::ToString ( ) const

inlineoverridevirtual

Set the value

Reimplemented from otb::Wrapper::Parameter.

Definition at line 81 of file otbWrapperStringParameter.h.

Member Data Documentation

m_Value

std::string otb::Wrapper::StringParameter::m_Value

protected

Set the value

Definition at line 102 of file otbWrapperStringParameter.h.

---

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

• otbWrapperStringParameter.h