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

#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< 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 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 const char * GetNameOfClass () const
 
virtual Role GetRole () const
 
virtual const Parameter::Pointer GetRoot () const
 
virtual ParameterType GetType () const =0
 
virtual UserLevel GetUserLevel () const
 
virtual bool HasUserValue () const
 
virtual bool HasValue () const =0
 
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 LightObject::Pointer CreateAnother () const override
 
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
 

Protected Member Functions

 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

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 Parameter &)=delete
 
 Parameter (const Parameter &)=delete
 

Additional Inherited Members

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

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

Definition at line 57 of file otbWrapperParameter.h.

Definition at line 56 of file otbWrapperParameter.h.

Standard class typedef

Definition at line 54 of file otbWrapperParameter.h.

Definition at line 55 of file otbWrapperParameter.h.

Constructor & Destructor Documentation

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

Constructor

otb::Wrapper::Parameter::Parameter ( const Parameter )
privatedelete

Member Function Documentation

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

void otb::Wrapper::Parameter::AutomaticValueOff ( )

Toogle OFF the parameter AutomaticValue flag

void otb::Wrapper::Parameter::AutomaticValueOn ( )

Toogle ON the parameter AutomaticValue flag

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

Reimplemented in otb::Wrapper::FloatParameter.

virtual void otb::Wrapper::Parameter::FromInt ( int  )
virtual
virtual void otb::Wrapper::Parameter::FromString ( const std::string &  )
virtual
virtual void otb::Wrapper::Parameter::FromStringList ( const std::vector< std::string > &  )
virtual
bool otb::Wrapper::Parameter::GetActive ( bool  recurseParents = false) const

Set the parameter Active flag

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

Get the parameter AutomaticValue flag

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

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

Set/get the parameter description

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

Set/get the parameter key

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

Set the parameter Mandatory flag

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

Set/get the parameter name

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

Get the user access level

virtual const Parameter::Pointer otb::Wrapper::Parameter::GetRoot ( ) const
virtual
virtual ParameterType otb::Wrapper::Parameter::GetType ( ) const
pure virtual
virtual UserLevel otb::Wrapper::Parameter::GetUserLevel ( ) const
virtual

Get the user access level

virtual bool otb::Wrapper::Parameter::HasUserValue ( ) const
virtual
virtual bool otb::Wrapper::Parameter::HasValue ( ) const
pure virtual
virtual bool otb::Wrapper::Parameter::IsRoot ( ) const
virtual

Is the parameter a root or a child of another param

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

Set the parameter Mandatory flag

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

Set the parameter Mandatory flag

void otb::Wrapper::Parameter::operator= ( const Parameter )
privatedelete
virtual void otb::Wrapper::Parameter::Reset ( )
virtual
virtual void otb::Wrapper::Parameter::SetActive ( bool  flag)
virtual

Set the parameter Active flag

Reimplemented in otb::Wrapper::DirectoryParameter.

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

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

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

Set/get the parameter description

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

Set/get the parameter key

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

Set the parameter Mandatory flag

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

Set/get the parameter name

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

Set the parameter io type

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

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

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

Set the user access level

virtual void otb::Wrapper::Parameter::SetUserValue ( bool  isUserValue)
virtual
virtual float otb::Wrapper::Parameter::ToFloat ( ) 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::NumericalParameter< float >, otb::Wrapper::NumericalParameter< int >, and otb::Wrapper::NumericalParameter< unsigned int >.

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::NumericalParameter< float >, otb::Wrapper::NumericalParameter< int >, otb::Wrapper::NumericalParameter< unsigned int >, otb::Wrapper::ChoiceParameter, and otb::Wrapper::BoolParameter.

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

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

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

void otb::Wrapper::Parameter::TypeError ( const std::string &  target_type) const

Error raising function to indicate a type conversion error

Member Data Documentation

bool otb::Wrapper::Parameter::m_Active
protected

True if activated (a mandatory parameter is always active)

Definition at line 182 of file otbWrapperParameter.h.

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

List of children parameters

Definition at line 196 of file otbWrapperParameter.h.

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

Description of the parameter

Definition at line 173 of file otbWrapperParameter.h.

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

Key of the parameter

Definition at line 176 of file otbWrapperParameter.h.

bool otb::Wrapper::Parameter::m_Mandatory
protected

True if the parameter is mandatory

Definition at line 179 of file otbWrapperParameter.h.

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

Name of the parameter

Definition at line 170 of file otbWrapperParameter.h.

Role otb::Wrapper::Parameter::m_Role
protected

Default iotype mode

Definition at line 190 of file otbWrapperParameter.h.

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

List of parents Parameters

Definition at line 193 of file otbWrapperParameter.h.

UserLevel otb::Wrapper::Parameter::m_UserLevel
protected

Definition at line 187 of file otbWrapperParameter.h.

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 185 of file otbWrapperParameter.h.


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