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< Self >	Pointer
typedef ParameterGroup	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	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	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 ()
static Parameter *	ResolveParameter (Parameter *param)

Protected Types
typedef std::vector< Parameter::Pointer >	ParameterListType

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

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

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

ConstPointer

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

Definition at line 45 of file otbWrapperParameterGroup.h.

ParameterListType

typedef std::vector<Parameter::Pointer> otb::Wrapper::ParameterGroup::ParameterListType

protected

Definition at line 111 of file otbWrapperParameterGroup.h.

Pointer

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

Definition at line 44 of file otbWrapperParameterGroup.h.

Self

typedef ParameterGroup otb::Wrapper::ParameterGroup::Self

Definition at line 42 of file otbWrapperParameterGroup.h.

Superclass

typedef Parameter otb::Wrapper::ParameterGroup::Superclass

Definition at line 43 of file otbWrapperParameterGroup.h.

Constructor & Destructor Documentation

ParameterGroup() [1/2]

otb::Wrapper::ParameterGroup::ParameterGroup ( )

protected

~ParameterGroup()

otb::Wrapper::ParameterGroup::~ParameterGroup ( )

overrideprotected

ParameterGroup() [2/2]

otb::Wrapper::ParameterGroup::ParameterGroup ( const ParameterGroup &  )

privatedelete

Member Function Documentation

AddChoice()

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

Add a new choice value to an existing choice parameter

AddParameter() [1/2]

void otb::Wrapper::ParameterGroup::AddParameter

(

Parameter::Pointer

p

)

AddParameter() [2/2]

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

Clear()

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

inline

Definition at line 75 of file otbWrapperParameterGroup.h.

ClearChoices()

void otb::Wrapper::ParameterGroup::ClearChoices

(

std::string

paramKey

)

Remove choices made in ListViewParameter widget

CreateAnother()

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

(

void

)

const

GetNameOfClass()

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

virtual

RTTI support

Reimplemented from otb::Wrapper::Parameter.

GetNumberOfParameters()

unsigned int otb::Wrapper::ParameterGroup::GetNumberOfParameters

(

)

GetParameterByIndex()

Parameter::Pointer otb::Wrapper::ParameterGroup::GetParameterByIndex	(	unsigned int	i,
		bool	follow = true
	)

GetParameterByKey()

Parameter::Pointer otb::Wrapper::ParameterGroup::GetParameterByKey	(	std::string	name,
		bool	follow = true
	)

GetParametersKeys()

std::vector<std::string> otb::Wrapper::ParameterGroup::GetParametersKeys

(

bool

recursive = true

)

GetParameterTypeAsString()

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

GetParameterTypeFromString()

ParameterType otb::Wrapper::ParameterGroup::GetParameterTypeFromString

(

const std::string &

paramType

)

GetSelectedItems()

std::vector<int> otb::Wrapper::ParameterGroup::GetSelectedItems

(

std::string

paramKey

)

Get the choices made in a ListView Parameter widget

GetType()

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

inlineoverridevirtual

Get the dynamic type as declared in WrapperTypes.h

Implements otb::Wrapper::Parameter.

Definition at line 102 of file otbWrapperParameterGroup.h.

References otb::Wrapper::ParameterType_Group.

HasValue()

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

inlineoverridevirtual

Name of the parameter

Implements otb::Wrapper::Parameter.

Definition at line 93 of file otbWrapperParameterGroup.h.

New()

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

static

operator=()

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

privatedelete

ReplaceParameter()

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

ResolveParameter()

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

m_ParameterList

ParameterListType otb::Wrapper::ParameterGroup::m_ParameterList

protected

Definition at line 112 of file otbWrapperParameterGroup.h.

---

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

• otbWrapperParameterGroup.h