otb::Wrapper::DirectoryParameter Class Reference

#include <otbWrapperDirectoryParameter.h>

Inheritance diagram for otb::Wrapper::DirectoryParameter:

Collaboration diagram for otb::Wrapper::DirectoryParameter:

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer
typedef itk::SmartPointer< Self >	Pointer
typedef DirectoryParameter	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
void	ClearValue () override
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
void	FromString (const std::string &value) override
virtual const char *	GetNameOfClass () const
virtual ParameterType	GetType () const override
bool	HasValue () const override
	otbGetObjectMemberConstMacro (StringParam, Active, bool)
	otbGetObjectMemberConstMacro (StringParam, Value, std::string)
	otbSetObjectMemberMacro (StringParam, Value, std::string)
void	SetActive (bool 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
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 ()

Protected Member Functions
	DirectoryParameter ()
	~DirectoryParameter () override
Protected Member Functions inherited from otb::Wrapper::Parameter
	Parameter ()

Private Member Functions
	DirectoryParameter (const DirectoryParameter &)=delete
void	operator= (const DirectoryParameter &)

Private Attributes
StringParameter::Pointer	m_StringParam

Additional Inherited Members
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 39 of file otbWrapperDirectoryParameter.h.

Member Typedef Documentation

ConstPointer

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

Definition at line 46 of file otbWrapperDirectoryParameter.h.

Pointer

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

Definition at line 45 of file otbWrapperDirectoryParameter.h.

Self

typedef DirectoryParameter otb::Wrapper::DirectoryParameter::Self

Standard class typedef

Definition at line 43 of file otbWrapperDirectoryParameter.h.

Superclass

typedef Parameter otb::Wrapper::DirectoryParameter::Superclass

Definition at line 44 of file otbWrapperDirectoryParameter.h.

Constructor & Destructor Documentation

DirectoryParameter() [1/2]

otb::Wrapper::DirectoryParameter::DirectoryParameter ( )

inlineprotected

Constructor

Definition at line 96 of file otbWrapperDirectoryParameter.h.

References otb::Wrapper::StringParameter::New().

~DirectoryParameter()

otb::Wrapper::DirectoryParameter::~DirectoryParameter ( )

inlineoverrideprotected

Destructor

Definition at line 102 of file otbWrapperDirectoryParameter.h.

DirectoryParameter() [2/2]

otb::Wrapper::DirectoryParameter::DirectoryParameter ( const DirectoryParameter &  )

privatedelete

Member Function Documentation

ClearValue()

void otb::Wrapper::DirectoryParameter::ClearValue ( )

inlineoverridevirtual

Name of the parameter

Reimplemented from otb::Wrapper::Parameter.

Definition at line 64 of file otbWrapperDirectoryParameter.h.

CreateAnother()

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

(

void

)

const

FromString()

void otb::Wrapper::DirectoryParameter::FromString ( const std::string &  )

inlineoverridevirtual

Name of the parameter

Reimplemented from otb::Wrapper::Parameter.

Definition at line 89 of file otbWrapperDirectoryParameter.h.

GetNameOfClass()

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

virtual

RTTI support

Reimplemented from otb::Wrapper::Parameter.

GetType()

virtual ParameterType otb::Wrapper::DirectoryParameter::GetType ( ) const

inlineoverridevirtual

Get the dynamic type as declared in WrapperTypes.h

Implements otb::Wrapper::Parameter.

Definition at line 79 of file otbWrapperDirectoryParameter.h.

References otb::Wrapper::ParameterType_Directory.

HasValue()

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

inlineoverridevirtual

Name of the parameter

Implements otb::Wrapper::Parameter.

Definition at line 54 of file otbWrapperDirectoryParameter.h.

New()

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

static

Defining ::New() static method

operator=()

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

private

otbGetObjectMemberConstMacro() [1/2]

otb::Wrapper::DirectoryParameter::otbGetObjectMemberConstMacro	(	StringParam	,
		Active	,
		bool
	)

otbGetObjectMemberConstMacro() [2/2]

otb::Wrapper::DirectoryParameter::otbGetObjectMemberConstMacro	(	StringParam	,
		Value	,
		std::string
	)

otbSetObjectMemberMacro()

otb::Wrapper::DirectoryParameter::otbSetObjectMemberMacro	(	StringParam	,
		Value	,
		std::string
	)

SetActive()

void otb::Wrapper::DirectoryParameter::SetActive ( bool  flag )

inlineoverridevirtual

Set the parameter Active flag

Reimplemented from otb::Wrapper::Parameter.

Definition at line 70 of file otbWrapperDirectoryParameter.h.

ToString()

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

inlineoverridevirtual

Name of the parameter

Reimplemented from otb::Wrapper::Parameter.

Definition at line 84 of file otbWrapperDirectoryParameter.h.

Member Data Documentation

m_StringParam

StringParameter::Pointer otb::Wrapper::DirectoryParameter::m_StringParam

private

Definition at line 111 of file otbWrapperDirectoryParameter.h.

---

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

• otbWrapperDirectoryParameter.h