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

#include <otbWrapperParameterGroup.h>

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

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef itk::SmartPointer< SelfPointer
 
typedef ParameterGroup 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

void AddChoice (std::string paramKey, std::string paramName)
 
void AddParameter (Parameter::Pointer p)
 
void AddParameter (ParameterType type, std::string paramKey, std::string paramName)
 
void Clear ()
 
void ClearChoices (std::string paramKey)
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
unsigned int GetNumberOfParameters ()
 
Parameter::Pointer GetParameterByIndex (unsigned int i, bool follow=true)
 
Parameter::Pointer GetParameterByKey (std::string name, bool follow=true)
 
std::vector< std::string > GetParametersKeys (bool recursive=true)
 
std::string GetParameterTypeAsString (ParameterType paramType)
 
ParameterType GetParameterTypeFromString (const std::string &paramType)
 
std::vector< int > GetSelectedItems (std::string paramKey)
 
ParameterType GetType () const override
 
bool HasValue () const override
 
bool ReplaceParameter (std::string &key, Parameter::Pointer p)
 
- 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 ParameterResolveParameter (Parameter *param)
 
- 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 Types

typedef std::vector
< Parameter::Pointer
ParameterListType
 

Protected Member Functions

 ParameterGroup ()
 
 ~ParameterGroup () 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 Attributes

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

Private Member Functions

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

Detailed Description

Definition at line 39 of file otbWrapperParameterGroup.h.

Member Typedef Documentation

Definition at line 46 of file otbWrapperParameterGroup.h.

Definition at line 112 of file otbWrapperParameterGroup.h.

Definition at line 45 of file otbWrapperParameterGroup.h.

Definition at line 43 of file otbWrapperParameterGroup.h.

Definition at line 44 of file otbWrapperParameterGroup.h.

Constructor & Destructor Documentation

otb::Wrapper::ParameterGroup::ParameterGroup ( )
protected
otb::Wrapper::ParameterGroup::~ParameterGroup ( )
overrideprotected
otb::Wrapper::ParameterGroup::ParameterGroup ( const ParameterGroup )
privatedelete

Member Function Documentation

void otb::Wrapper::ParameterGroup::AddChoice ( std::string  paramKey,
std::string  paramName 
)

Add a new choice value to an existing choice parameter

void otb::Wrapper::ParameterGroup::AddParameter ( Parameter::Pointer  p)
void otb::Wrapper::ParameterGroup::AddParameter ( ParameterType  type,
std::string  paramKey,
std::string  paramName 
)

Add a new parameter to the parameter group the parent key of paramKey can be the path to a parameter group or the path to a choice value

void otb::Wrapper::ParameterGroup::Clear ( void  )
inline

Definition at line 76 of file otbWrapperParameterGroup.h.

void otb::Wrapper::ParameterGroup::ClearChoices ( std::string  paramKey)

Remove choices made in ListViewParameter widget

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

Reimplemented from itk::Object.

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

RTTI support

Reimplemented from otb::Wrapper::Parameter.

unsigned int otb::Wrapper::ParameterGroup::GetNumberOfParameters ( )
Parameter::Pointer otb::Wrapper::ParameterGroup::GetParameterByIndex ( unsigned int  i,
bool  follow = true 
)
Parameter::Pointer otb::Wrapper::ParameterGroup::GetParameterByKey ( std::string  name,
bool  follow = true 
)
std::vector<std::string> otb::Wrapper::ParameterGroup::GetParametersKeys ( bool  recursive = true)
std::string otb::Wrapper::ParameterGroup::GetParameterTypeAsString ( ParameterType  paramType)

Get the parameter type as string from its ParameterType enum For example if type of parameter is ParameterType_InputImage this function return the string InputImage

ParameterType otb::Wrapper::ParameterGroup::GetParameterTypeFromString ( const std::string &  paramType)
std::vector<int> otb::Wrapper::ParameterGroup::GetSelectedItems ( std::string  paramKey)

Get the choices made in a ListView Parameter widget

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

Get the dynamic type as declared in WrapperTypes.h

Implements otb::Wrapper::Parameter.

Definition at line 103 of file otbWrapperParameterGroup.h.

References otb::Wrapper::ParameterType_Group.

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

Implements otb::Wrapper::Parameter.

Definition at line 94 of file otbWrapperParameterGroup.h.

static Pointer otb::Wrapper::ParameterGroup::New ( )
static
void otb::Wrapper::ParameterGroup::operator= ( const ParameterGroup )
privatedelete
bool otb::Wrapper::ParameterGroup::ReplaceParameter ( std::string &  key,
Parameter::Pointer  p 
)

Method to substitute a parameter in a group. The function returns true on success, false on failure

static Parameter* otb::Wrapper::ParameterGroup::ResolveParameter ( Parameter param)
static

Resolve potential proxy parameters by following their targets until a non-proxy parameter. It will detect cycles and report an error

Member Data Documentation

ParameterListType otb::Wrapper::ParameterGroup::m_ParameterList
protected

Definition at line 113 of file otbWrapperParameterGroup.h.


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