OTB  6.7.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
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< SelfPointer
 
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< 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 Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
const ProxyTargetTypeGetTarget (void)
 
ParameterType GetType () const override
 
bool HasValue () const override
 
void SetTarget (const ProxyTargetType &target)
 
- Public Member Functions inherited from otb::Wrapper::Parameter
virtual void AddChild (Parameter::Pointer child)
 
void AutomaticValueOff ()
 
void AutomaticValueOn ()
 
virtual void ClearValue ()
 
virtual void FromFloat (float)
 
virtual void FromInt (int)
 
virtual void FromString (const std::string &)
 
virtual void FromStringList (const std::vector< 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
 
virtual std::string ToString () const
 
virtual std::vector< std::string > ToStringList () 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
 

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

 ProxyParameter ()
 
 ~ProxyParameter () 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 ()
 

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
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

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

Definition at line 49 of file otbWrapperProxyParameter.h.

Definition at line 48 of file otbWrapperProxyParameter.h.

Definition at line 53 of file otbWrapperProxyParameter.h.

Definition at line 46 of file otbWrapperProxyParameter.h.

Definition at line 47 of file otbWrapperProxyParameter.h.

Constructor & Destructor Documentation

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

Definition at line 85 of file otbWrapperProxyParameter.h.

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

Definition at line 88 of file otbWrapperProxyParameter.h.

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

Member Function Documentation

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

Reimplemented from itk::Object.

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

RTTI support

Reimplemented from otb::Wrapper::Parameter.

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.

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.

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

Implements otb::Wrapper::Parameter.

Definition at line 73 of file otbWrapperProxyParameter.h.

References m_Target.

static Pointer otb::Wrapper::ProxyParameter::New ( )
static
void otb::Wrapper::ProxyParameter::operator= ( const Self )
privatedelete
void otb::Wrapper::ProxyParameter::SetTarget ( const ProxyTargetType target)
inline

Set the target parameter of the proxy

Parameters
targetpair of a group parameter containing the target and its key

Definition at line 60 of file otbWrapperProxyParameter.h.

References m_Target.

Member Data Documentation

ProxyTargetType otb::Wrapper::ProxyParameter::m_Target
private

Definition at line 95 of file otbWrapperProxyParameter.h.

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


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