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::BoolParameter Class Reference

#include <otbWrapperBoolParameter.h>

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

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef itk::SmartPointer< SelfPointer
 
typedef BoolParameter 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
 
void FromInt (int value) override
 
void FromString (const std::string &value) override
 
virtual const char * GetNameOfClass () const
 
ParameterType GetType () const override
 
bool GetValue () const
 
std::string GetValueAsString () const
 
bool HasValue () const override
 
void SetValue (bool state)
 
void SetValue (const std::string &str)
 
int ToInt () const override
 
std::string ToString () const override
 
- 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 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 float ToFloat () 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

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

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

Private Attributes

bool m_Value
 

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

This class represent a boolean parameter for the wrapper framework.

Definition at line 38 of file otbWrapperBoolParameter.h.

Member Typedef Documentation

Definition at line 46 of file otbWrapperBoolParameter.h.

Definition at line 45 of file otbWrapperBoolParameter.h.

Standard class typedef

Definition at line 43 of file otbWrapperBoolParameter.h.

Definition at line 44 of file otbWrapperBoolParameter.h.

Constructor & Destructor Documentation

otb::Wrapper::BoolParameter::BoolParameter ( )
protected

Constructor

otb::Wrapper::BoolParameter::~BoolParameter ( )
inlineoverrideprotected

Destructor

Definition at line 80 of file otbWrapperBoolParameter.h.

otb::Wrapper::BoolParameter::BoolParameter ( const BoolParameter )
privatedelete

Member Function Documentation

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

Reimplemented from itk::Object.

void otb::Wrapper::BoolParameter::FromInt ( int  value)
overridevirtual

Reimplemented from otb::Wrapper::Parameter.

void otb::Wrapper::BoolParameter::FromString ( const std::string &  value)
overridevirtual

Reimplemented from otb::Wrapper::Parameter.

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

RTTI support

Reimplemented from otb::Wrapper::Parameter.

ParameterType otb::Wrapper::BoolParameter::GetType ( ) const
overridevirtual

Get the dynamic type as declared in WrapperTypes.h

Implements otb::Wrapper::Parameter.

bool otb::Wrapper::BoolParameter::GetValue ( ) const
std::string otb::Wrapper::BoolParameter::GetValueAsString ( ) const
bool otb::Wrapper::BoolParameter::HasValue ( ) const
inlineoverridevirtual

This parameter is ON/OFF switch, it always has a value

Implements otb::Wrapper::Parameter.

Definition at line 55 of file otbWrapperBoolParameter.h.

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

Defining ::New() static method

void otb::Wrapper::BoolParameter::operator= ( const BoolParameter )
privatedelete
void otb::Wrapper::BoolParameter::SetValue ( bool  state)
void otb::Wrapper::BoolParameter::SetValue ( const std::string &  str)
int otb::Wrapper::BoolParameter::ToInt ( ) const
overridevirtual

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

Reimplemented from otb::Wrapper::Parameter.

std::string otb::Wrapper::BoolParameter::ToString ( ) const
overridevirtual

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

Reimplemented from otb::Wrapper::Parameter.

Member Data Documentation

bool otb::Wrapper::BoolParameter::m_Value
private

Definition at line 87 of file otbWrapperBoolParameter.h.


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