otb::Wrapper::ProxyParameter Class Reference

#include <otbWrapperProxyParameter.h>

Inheritance diagram for otb::Wrapper::ProxyParameter:

Collaboration diagram for otb::Wrapper::ProxyParameter:

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer
typedef itk::SmartPointer< Self >	Pointer
typedef std::pair< Parameter::Pointer, std::string >	ProxyTargetType
typedef ProxyParameter	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
const ProxyTargetType &	GetTarget (void)
ParameterType	GetType () const override
bool	HasValue () const override
void	SetTarget (const ProxyTargetType &target)
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	ClearValue ()
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 &)
virtual void	FromStringList (const std::vector< std::string > &)

Static Public Member Functions
static Pointer	New ()

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

Private Member Functions
void	operator= (const Self &)=delete
	ProxyParameter (const Self &)=delete

Private Attributes
ProxyTargetType	m_Target

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

Parameter class acting as a proxy to a different parameter.

The target parameter of this proxy is defined as a pair of a group parameter containing the target and the targets key. It allows defining proxies on parameters that may be themselves replaced by a proxy

Definition at line 43 of file otbWrapperProxyParameter.h.

Member Typedef Documentation

ConstPointer

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

Definition at line 49 of file otbWrapperProxyParameter.h.

Pointer

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

Definition at line 48 of file otbWrapperProxyParameter.h.

ProxyTargetType

typedef std::pair<Parameter::Pointer, std::string> otb::Wrapper::ProxyParameter::ProxyTargetType

Definition at line 53 of file otbWrapperProxyParameter.h.

Self

typedef ProxyParameter otb::Wrapper::ProxyParameter::Self

Definition at line 46 of file otbWrapperProxyParameter.h.

Superclass

typedef Parameter otb::Wrapper::ProxyParameter::Superclass

Definition at line 47 of file otbWrapperProxyParameter.h.

Constructor & Destructor Documentation

ProxyParameter() [1/2]

otb::Wrapper::ProxyParameter::ProxyParameter ( )

inlineprotected

Definition at line 85 of file otbWrapperProxyParameter.h.

~ProxyParameter()

otb::Wrapper::ProxyParameter::~ProxyParameter ( )

inlineoverrideprotected

Definition at line 88 of file otbWrapperProxyParameter.h.

ProxyParameter() [2/2]

otb::Wrapper::ProxyParameter::ProxyParameter ( const Self &  )

privatedelete

Member Function Documentation

CreateAnother()

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

(

void

)

const

GetNameOfClass()

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

virtual

RTTI support

Reimplemented from otb::Wrapper::Parameter.

GetTarget()

const ProxyTargetType& otb::Wrapper::ProxyParameter::GetTarget ( void  )

inline

Get the target parameter of the proxy First part is the group parameter containing the target Second part is the key of the target

Definition at line 68 of file otbWrapperProxyParameter.h.

References m_Target.

GetType()

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

inlineoverridevirtual

Get the dynamic type as declared in WrapperTypes.h

Implements otb::Wrapper::Parameter.

Definition at line 78 of file otbWrapperProxyParameter.h.

References m_Target.

HasValue()

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

inlineoverridevirtual

Name of the parameter

Implements otb::Wrapper::Parameter.

Definition at line 73 of file otbWrapperProxyParameter.h.

References m_Target.

New()

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

static

operator=()

void otb::Wrapper::ProxyParameter::operator= ( const Self &  )

privatedelete

SetTarget()

void otb::Wrapper::ProxyParameter::SetTarget ( const ProxyTargetType &  target )

inline

Set the target parameter of the proxy

Parameters

target

pair of a group parameter containing the target and its key

Definition at line 60 of file otbWrapperProxyParameter.h.

References m_Target.

Member Data Documentation

m_Target

ProxyTargetType otb::Wrapper::ProxyParameter::m_Target

private

Definition at line 96 of file otbWrapperProxyParameter.h.

Referenced by GetTarget(), GetType(), HasValue(), and SetTarget().

---

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

• otbWrapperProxyParameter.h