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< Self >	Pointer
typedef BoolParameter	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
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	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 float	ToFloat () const
virtual double	ToDouble () const
virtual std::vector< std::string >	ToStringList () const
virtual void	FromFloat (float)
virtual void	FromDouble (double)
virtual void	FromStringList (const std::vector< std::string > &)

Static Public Member Functions
static Pointer	New ()

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

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

Detailed Description

This class represent a boolean parameter for the wrapper framework.

Definition at line 38 of file otbWrapperBoolParameter.h.

Member Typedef Documentation

ConstPointer

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

Definition at line 45 of file otbWrapperBoolParameter.h.

Pointer

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

Definition at line 44 of file otbWrapperBoolParameter.h.

Self

typedef BoolParameter otb::Wrapper::BoolParameter::Self

Standard class typedef

Definition at line 42 of file otbWrapperBoolParameter.h.

Superclass

typedef Parameter otb::Wrapper::BoolParameter::Superclass

Definition at line 43 of file otbWrapperBoolParameter.h.

Constructor & Destructor Documentation

BoolParameter() [1/2]

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

protected

Constructor

~BoolParameter()

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

inlineoverrideprotected

Destructor

Definition at line 79 of file otbWrapperBoolParameter.h.

BoolParameter() [2/2]

otb::Wrapper::BoolParameter::BoolParameter ( const BoolParameter &  )

privatedelete

Member Function Documentation

CreateAnother()

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

(

void

)

const

FromInt()

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

overridevirtual

Name of the parameter

Reimplemented from otb::Wrapper::Parameter.

FromString()

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

overridevirtual

Name of the parameter

Reimplemented from otb::Wrapper::Parameter.

GetNameOfClass()

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

virtual

RTTI support

Reimplemented from otb::Wrapper::Parameter.

GetType()

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

overridevirtual

Get the dynamic type as declared in WrapperTypes.h

Implements otb::Wrapper::Parameter.

GetValue()

bool otb::Wrapper::BoolParameter::GetValue

(

)

const

GetValueAsString()

std::string otb::Wrapper::BoolParameter::GetValueAsString

(

)

const

HasValue()

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 54 of file otbWrapperBoolParameter.h.

New()

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

static

Defining ::New() static method

operator=()

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

privatedelete

SetValue() [1/2]

void otb::Wrapper::BoolParameter::SetValue

(

bool

state

)

SetValue() [2/2]

void otb::Wrapper::BoolParameter::SetValue

(

const std::string &

str

)

ToInt()

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.

ToString()

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

overridevirtual

Name of the parameter

Reimplemented from otb::Wrapper::Parameter.

Member Data Documentation

m_Value

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:

• otbWrapperBoolParameter.h