otb::Wrapper::Parameter Class Reference

#include <otbWrapperParameter.h>

Inheritance diagram for otb::Wrapper::Parameter:

Collaboration diagram for otb::Wrapper::Parameter:

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer
typedef itk::SmartPointer< Self >	Pointer
typedef Parameter	Self
typedef itk::Object	Superclass

Public Member Functions
virtual const char *	GetNameOfClass () const
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
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	HasValue () const =0
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 ()
virtual ParameterType	GetType () const =0
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 > &)
	Parameter ()
	Parameter (const Parameter &)=delete
void	operator= (const Parameter &)=delete

Detailed Description

This class represent a parameter for the wrapper framework This class is a high level class representing a parameter for the wrapper framework. It should be subclassed to represent different kinds of parameters.

Definition at line 49 of file otbWrapperParameter.h.

Member Typedef Documentation

ConstPointer

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

Definition at line 56 of file otbWrapperParameter.h.

Pointer

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

Definition at line 55 of file otbWrapperParameter.h.

Self

typedef Parameter otb::Wrapper::Parameter::Self

Standard class typedef

Definition at line 53 of file otbWrapperParameter.h.

Superclass

typedef itk::Object otb::Wrapper::Parameter::Superclass

Definition at line 54 of file otbWrapperParameter.h.

Constructor & Destructor Documentation

Parameter() [1/2]

otb::Wrapper::Parameter::Parameter ( )

protected

Constructor

Parameter() [2/2]

otb::Wrapper::Parameter::Parameter ( const Parameter &  )

privatedelete

Name of the parameter

Member Function Documentation

AddChild()

virtual void otb::Wrapper::Parameter::AddChild ( Parameter::Pointer  child )

virtual

Add a child of this parameter when the param is a Group or a choice

AutomaticValueOff()

void otb::Wrapper::Parameter::AutomaticValueOff

(

)

Toggle OFF the parameter AutomaticValue flag

AutomaticValueOn()

void otb::Wrapper::Parameter::AutomaticValueOn

(

)

Toggle ON the parameter AutomaticValue flag

ClearValue()

virtual void otb::Wrapper::Parameter::ClearValue ( )

virtual

Name of the parameter

Reimplemented in otb::Wrapper::InputImageParameter, otb::Wrapper::ListViewParameter, otb::Wrapper::ChoiceParameter, otb::Wrapper::NumericalParameter< T >, otb::Wrapper::NumericalParameter< double >, otb::Wrapper::NumericalParameter< float >, otb::Wrapper::NumericalParameter< int >, otb::Wrapper::NumericalParameter< unsigned int >, otb::Wrapper::InputImageListParameter, otb::Wrapper::InputVectorDataListParameter, otb::Wrapper::InputFilenameParameter, otb::Wrapper::OutputFilenameParameter, otb::Wrapper::StringParameter, otb::Wrapper::ParameterList< T >, otb::Wrapper::ParameterList< InputImageParameter >, otb::Wrapper::ParameterList< StringParameter >, otb::Wrapper::ParameterList< InputVectorDataParameter >, otb::Wrapper::InputVectorDataParameter, and otb::Wrapper::DirectoryParameter.

FromDouble()

virtual void otb::Wrapper::Parameter::FromDouble ( double  )

virtual

Name of the parameter

Reimplemented in otb::Wrapper::DoubleParameter.

FromFloat()

virtual void otb::Wrapper::Parameter::FromFloat ( float  )

virtual

Name of the parameter

Reimplemented in otb::Wrapper::FloatParameter.

FromInt()

virtual void otb::Wrapper::Parameter::FromInt ( int  )

virtual

Name of the parameter

Reimplemented in otb::Wrapper::NumericalParameter< T >, otb::Wrapper::NumericalParameter< double >, otb::Wrapper::NumericalParameter< float >, otb::Wrapper::NumericalParameter< int >, otb::Wrapper::NumericalParameter< unsigned int >, otb::Wrapper::ChoiceParameter, and otb::Wrapper::BoolParameter.

FromString()

virtual void otb::Wrapper::Parameter::FromString ( const std::string &  )

virtual

Name of the parameter

Reimplemented in otb::Wrapper::ListViewParameter, otb::Wrapper::NumericalParameter< T >, otb::Wrapper::NumericalParameter< double >, otb::Wrapper::NumericalParameter< float >, otb::Wrapper::NumericalParameter< int >, otb::Wrapper::NumericalParameter< unsigned int >, otb::Wrapper::InputImageParameter, otb::Wrapper::OutputImageParameter, otb::Wrapper::ChoiceParameter, otb::Wrapper::OutputVectorDataParameter, otb::Wrapper::DirectoryParameter, otb::Wrapper::InputFilenameParameter, otb::Wrapper::OutputFilenameParameter, otb::Wrapper::StringParameter, otb::Wrapper::InputVectorDataParameter, and otb::Wrapper::BoolParameter.

FromStringList()

virtual void otb::Wrapper::Parameter::FromStringList ( const std::vector< std::string > &  )

virtual

Name of the parameter

Reimplemented in otb::Wrapper::ListViewParameter, otb::Wrapper::ParameterList< T >, otb::Wrapper::ParameterList< InputImageParameter >, otb::Wrapper::ParameterList< StringParameter >, and otb::Wrapper::ParameterList< InputVectorDataParameter >.

GetActive()

bool otb::Wrapper::Parameter::GetActive

(

bool

recurseParents = false

)

const

Name of the parameter

GetAutomaticValue()

virtual bool otb::Wrapper::Parameter::GetAutomaticValue ( ) const

virtual

Get the parameter AutomaticValue flag

GetChildrenList()

virtual std::vector<Parameter::Pointer> otb::Wrapper::Parameter::GetChildrenList ( )

virtual

Get the children pointer list : not const cause we need to alterate the m_Active status and the m_IsCheckbox

GetDescription()

virtual const std::string& otb::Wrapper::Parameter::GetDescription ( ) const

virtual

Name of the parameter

GetKey()

virtual const char* otb::Wrapper::Parameter::GetKey ( ) const

virtual

Name of the parameter

GetMandatory()

virtual bool otb::Wrapper::Parameter::GetMandatory ( ) const

virtual

Name of the parameter

GetName()

virtual const char* otb::Wrapper::Parameter::GetName ( ) const

virtual

Name of the parameter

GetNameOfClass()

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

virtual

RTTI support

Reimplemented in otb::Wrapper::RadiusParameter, otb::Wrapper::RAMParameter, otb::Wrapper::IntParameter, otb::Wrapper::DoubleParameter, otb::Wrapper::FloatParameter, otb::Wrapper::ParameterList< T >, otb::Wrapper::InputFilenameListParameter, otb::Wrapper::StringListParameter, otb::Wrapper::InputImageParameter, otb::Wrapper::AbstractParameterList, otb::Wrapper::InputImageListParameter, otb::Wrapper::InputVectorDataListParameter, otb::Wrapper::ListViewParameter, otb::Wrapper::OutputImageParameter, otb::Wrapper::ChoiceParameter, otb::Wrapper::OutputVectorDataParameter, otb::Wrapper::ProxyParameter, otb::Wrapper::DirectoryParameter, otb::Wrapper::BandParameter, otb::Wrapper::BoolParameter, otb::Wrapper::FieldParameter, otb::Wrapper::InputVectorDataParameter, otb::Wrapper::InputFilenameParameter, otb::Wrapper::OutputFilenameParameter, otb::Wrapper::StringParameter, and otb::Wrapper::ParameterGroup.

GetRole()

virtual Role otb::Wrapper::Parameter::GetRole ( ) const

virtual

Get the user access level

GetRoot()

virtual const Parameter::Pointer otb::Wrapper::Parameter::GetRoot ( ) const

virtual

Name of the parameter

GetType()

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

pure virtual

Get the dynamic type as declared in WrapperTypes.h

Implemented in otb::Wrapper::RadiusParameter, otb::Wrapper::RAMParameter, otb::Wrapper::IntParameter, otb::Wrapper::DoubleParameter, otb::Wrapper::FloatParameter, otb::Wrapper::ListViewParameter, otb::Wrapper::InputImageParameter, otb::Wrapper::OutputImageParameter, otb::Wrapper::ParameterGroup, otb::Wrapper::ChoiceParameter, otb::Wrapper::InputImageListParameter, otb::Wrapper::InputVectorDataListParameter, otb::Wrapper::StringListParameter, otb::Wrapper::OutputVectorDataParameter, otb::Wrapper::DirectoryParameter, otb::Wrapper::ProxyParameter, otb::Wrapper::InputFilenameParameter, otb::Wrapper::OutputFilenameParameter, otb::Wrapper::StringParameter, otb::Wrapper::InputFilenameListParameter, otb::Wrapper::InputVectorDataParameter, otb::Wrapper::BoolParameter, otb::Wrapper::FieldParameter, and otb::Wrapper::BandParameter.

GetUserLevel()

virtual UserLevel otb::Wrapper::Parameter::GetUserLevel ( ) const

virtual

Get the user access level

HasUserValue()

virtual bool otb::Wrapper::Parameter::HasUserValue ( ) const

virtual

Name of the parameter

HasValue()

virtual bool otb::Wrapper::Parameter::HasValue ( ) const

pure virtual

Name of the parameter

Implemented in otb::Wrapper::RadiusParameter, otb::Wrapper::InputImageParameter, otb::Wrapper::OutputImageParameter, otb::Wrapper::ParameterGroup, otb::Wrapper::ChoiceParameter, otb::Wrapper::ListViewParameter, otb::Wrapper::NumericalParameter< T >, otb::Wrapper::ParameterList< T >, otb::Wrapper::ProxyParameter, otb::Wrapper::InputVectorDataParameter, otb::Wrapper::StringParameter, otb::Wrapper::OutputVectorDataParameter, otb::Wrapper::BoolParameter, otb::Wrapper::DirectoryParameter, otb::Wrapper::InputFilenameParameter, and otb::Wrapper::OutputFilenameParameter.

IsRoot()

virtual bool otb::Wrapper::Parameter::IsRoot ( ) const

virtual

Is the parameter a root or a child of another param

MandatoryOff()

virtual void otb::Wrapper::Parameter::MandatoryOff ( )

virtual

Name of the parameter

MandatoryOn()

virtual void otb::Wrapper::Parameter::MandatoryOn ( )

virtual

Name of the parameter

operator=()

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

privatedelete

Name of the parameter

Reset()

virtual void otb::Wrapper::Parameter::Reset ( )

virtual

Reset to the the default value. Default implementation does nothing

Reimplemented in otb::Wrapper::OutputImageParameter, otb::Wrapper::NumericalParameter< T >, otb::Wrapper::NumericalParameter< double >, otb::Wrapper::NumericalParameter< float >, otb::Wrapper::NumericalParameter< int >, and otb::Wrapper::NumericalParameter< unsigned int >.

SetActive()

virtual void otb::Wrapper::Parameter::SetActive ( bool  flag )

virtual

Set the parameter Active flag

Reimplemented in otb::Wrapper::DirectoryParameter.

SetAutomaticValue()

virtual void otb::Wrapper::Parameter::SetAutomaticValue ( bool  flag )

virtual

Set the parameter AutomaticValue flag (which is the opposite of UserValue)

SetDescription()

virtual void otb::Wrapper::Parameter::SetDescription ( const std::string &  )

virtual

Set/get the parameter description

SetKey()

virtual void otb::Wrapper::Parameter::SetKey ( const std::string &  )

virtual

Set/get the parameter key

SetMandatory()

virtual void otb::Wrapper::Parameter::SetMandatory ( bool  flag )

virtual

Set the parameter Mandatory flag

SetName()

virtual void otb::Wrapper::Parameter::SetName ( const std::string &  )

virtual

Set/get the parameter name

SetRole()

virtual void otb::Wrapper::Parameter::SetRole ( const Role  role )

virtual

Set the parameter io type

SetRoot()

virtual void otb::Wrapper::Parameter::SetRoot ( const Parameter::Pointer  root )

virtual

Set/Get the root of the current parameter (direct parent)

SetUserLevel()

virtual void otb::Wrapper::Parameter::SetUserLevel ( const UserLevel  level )

virtual

Set the user access level

SetUserValue()

virtual void otb::Wrapper::Parameter::SetUserValue ( bool  isUserValue )

virtual

Name of the parameter

ToDouble()

virtual double otb::Wrapper::Parameter::ToDouble ( ) const

virtual

Name of the parameter

Reimplemented in otb::Wrapper::NumericalParameter< T >.

ToFloat()

virtual float otb::Wrapper::Parameter::ToFloat ( ) const

virtual

Name of the parameter

Reimplemented in otb::Wrapper::NumericalParameter< T >.

ToInt()

virtual int otb::Wrapper::Parameter::ToInt ( ) const

virtual

Parameter conversion functions. They are used by WrapperApplication to provide functions like SetParameterInt, GetParameterString, etc.

Reimplemented in otb::Wrapper::NumericalParameter< T >, otb::Wrapper::ChoiceParameter, and otb::Wrapper::BoolParameter.

ToString()

virtual std::string otb::Wrapper::Parameter::ToString ( ) const

virtual

Name of the parameter

Reimplemented in otb::Wrapper::ListViewParameter, otb::Wrapper::NumericalParameter< T >, otb::Wrapper::InputImageParameter, otb::Wrapper::ParameterList< T >, otb::Wrapper::OutputImageParameter, otb::Wrapper::ChoiceParameter, otb::Wrapper::OutputVectorDataParameter, otb::Wrapper::DirectoryParameter, otb::Wrapper::InputFilenameParameter, otb::Wrapper::OutputFilenameParameter, otb::Wrapper::StringParameter, otb::Wrapper::InputVectorDataParameter, and otb::Wrapper::BoolParameter.

ToStringList()

virtual std::vector<std::string> otb::Wrapper::Parameter::ToStringList ( ) const

virtual

Name of the parameter

Reimplemented in otb::Wrapper::ListViewParameter, and otb::Wrapper::ParameterList< T >.

TypeError()

void otb::Wrapper::Parameter::TypeError

(

const std::string &

target_type

)

const

Error raising function to indicate a type conversion error

Member Data Documentation

m_Active

bool otb::Wrapper::Parameter::m_Active

protected

True if activated (a mandatory parameter is always active)

Definition at line 183 of file otbWrapperParameter.h.

m_ChildrenList

std::vector<Parameter::Pointer> otb::Wrapper::Parameter::m_ChildrenList

protected

List of children parameters

Definition at line 197 of file otbWrapperParameter.h.

m_Description

std::string otb::Wrapper::Parameter::m_Description

protected

Description of the parameter

Definition at line 174 of file otbWrapperParameter.h.

m_Key

std::string otb::Wrapper::Parameter::m_Key

protected

Key of the parameter

Definition at line 177 of file otbWrapperParameter.h.

m_Mandatory

bool otb::Wrapper::Parameter::m_Mandatory

protected

True if the parameter is mandatory

Definition at line 180 of file otbWrapperParameter.h.

m_Name

std::string otb::Wrapper::Parameter::m_Name

protected

Name of the parameter

Definition at line 171 of file otbWrapperParameter.h.

m_Role

Role otb::Wrapper::Parameter::m_Role

protected

Default iotype mode

Definition at line 191 of file otbWrapperParameter.h.

m_Root

itk::WeakPointer<Parameter> otb::Wrapper::Parameter::m_Root

protected

List of parents Parameters

Definition at line 194 of file otbWrapperParameter.h.

m_UserLevel

UserLevel otb::Wrapper::Parameter::m_UserLevel

protected

Name of the parameter

Definition at line 188 of file otbWrapperParameter.h.

m_UserValue

bool otb::Wrapper::Parameter::m_UserValue

protected

True if the value is set in user mode (otherwise, it is an automatic value)

Definition at line 186 of file otbWrapperParameter.h.

---

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

• otbWrapperParameter.h