#include <otbWrapperFieldParameter.h>

Inheritance diagram for otb::Wrapper::FieldParameter:

Collaboration diagram for otb::Wrapper::FieldParameter:

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer

typedef itk::SmartPointer< Self >	Pointer

typedef FieldParameter	Self

typedef ListViewParameter	Superclass

typedef std::vector< OGRFieldType >	TypeFilterType

Public Types inherited from otb::Wrapper::ListViewParameter
typedef itk::SmartPointer< const Self >	ConstPointer

typedef itk::SmartPointer< Self >	Pointer

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

virtual const char *	GetNameOfClass () const

ParameterType	GetType () const override

const TypeFilterType &	GetTypeFilter () const

const std::string &	GetVectorData () const

void	SetTypeFilter (TypeFilterType typeFilter)

void	SetVectorData (std::string vectorData)

Public Member Functions inherited from otb::Wrapper::ListViewParameter
void	AddChoice (std::string choicekey, std::string choiceName)

void	ClearChoices ()

void	ClearValue () override

virtual ::itk::LightObject::Pointer	CreateAnother (void) const

void	FromString (const std::string &value) override

void	FromStringList (const std::vector< std::string > &values) override

std::string	GetChoiceKey (int i) const

std::vector< std::string >	GetChoiceKeys ()

std::string	GetChoiceName (int i)

std::vector< std::string >	GetChoiceNames ()

unsigned int	GetNbChoices (void)

std::vector< int >	GetSelectedItems ()

std::vector< std::string >	GetSelectedKeys ()

std::vector< std::string >	GetSelectedNames () const

virtual bool	GetSingleSelection ()

ParameterType	GetType () const override

virtual unsigned int	GetValue () const

bool	HasValue () const override

void	SetSelectedItems (std::vector< int > selectedItems)

void	SetSelectedItems (std::vector< std::string > selectedItems)

void	SetSelectedItemsByKeys ()

void	SetSelectedItemsByNames ()

void	SetSelectedKeys (std::vector< std::string > selectedKeys)

void	SetSelectedNames (std::vector< std::string > selectedNames)

virtual void	SetSingleSelection (bool _arg)

virtual void	SetValue (std::string choiceKey)

virtual void	SetValue (unsigned int v)

virtual void	SingleSelectionOff ()

virtual void	SingleSelectionOn ()

std::string	ToString () const override

std::vector< std::string >	ToStringList () 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	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 void	FromInt (int)

virtual void	FromFloat (float)

virtual void	FromDouble (double)

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from otb::Wrapper::ListViewParameter
static Pointer	New ()

Protected Member Functions
	FieldParameter ()=default

	~FieldParameter () override=default

Protected Member Functions inherited from otb::Wrapper::ListViewParameter
	ListViewParameter ()

	~ListViewParameter () override

Protected Member Functions inherited from otb::Wrapper::Parameter
	Parameter ()

Protected Attributes
TypeFilterType	m_TypeFilter

std::string	m_VectorData

Protected Attributes inherited from otb::Wrapper::ListViewParameter
ChoiceList	m_ChoiceList

unsigned int	m_CurrentChoice

std::vector< int >	m_SelectedItems

std::vector< std::string >	m_SelectedKeys

std::vector< std::string >	m_SelectedNames

bool	m_SingleSelection

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

void	operator= (const FieldParameter &)=delete

Additional Inherited Members
Protected Types inherited from otb::Wrapper::ListViewParameter
typedef std::vector< ListViewChoice >	ChoiceList

Detailed Description

This class represents a field parameter selected from a vector file for the wrapper framework.

Definition at line 38 of file otbWrapperFieldParameter.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 45 of file otbWrapperFieldParameter.h.

◆ Pointer

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

Definition at line 44 of file otbWrapperFieldParameter.h.

◆ Self

typedef FieldParameter otb::Wrapper::FieldParameter::Self

Standard class typedef

Definition at line 42 of file otbWrapperFieldParameter.h.

◆ Superclass

typedef ListViewParameter otb::Wrapper::FieldParameter::Superclass

Definition at line 43 of file otbWrapperFieldParameter.h.

◆ TypeFilterType

typedef std::vector<OGRFieldType> otb::Wrapper::FieldParameter::TypeFilterType

Definition at line 51 of file otbWrapperFieldParameter.h.

Constructor & Destructor Documentation

◆ FieldParameter() [1/2]

otb::Wrapper::FieldParameter::FieldParameter ( )

protecteddefault

Constructor

◆ ~FieldParameter()

otb::Wrapper::FieldParameter::~FieldParameter ( )

overrideprotecteddefault

Destructor

◆ FieldParameter() [2/2]

otb::Wrapper::FieldParameter::FieldParameter ( const FieldParameter & )

privatedelete

Member Function Documentation

◆ CreateAnother()

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

◆ GetNameOfClass()

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

virtual

RTTI support

Reimplemented from otb::Wrapper::ListViewParameter.

◆ GetType()

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

inlineoverridevirtual

Get the dynamic type as declared in WrapperTypes.h

Implements otb::Wrapper::Parameter.

Definition at line 55 of file otbWrapperFieldParameter.h.

References otb::Wrapper::ParameterType_Field.

◆ GetTypeFilter()

const TypeFilterType& otb::Wrapper::FieldParameter::GetTypeFilter ( ) const

inline

Get list of allowed field types

Definition at line 79 of file otbWrapperFieldParameter.h.

◆ GetVectorData()

const std::string& otb::Wrapper::FieldParameter::GetVectorData ( ) const

inline

Get vector data name from which we choose the fields

Definition at line 67 of file otbWrapperFieldParameter.h.

◆ New()

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

static

Defining ::New() static method

◆ operator=()

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

privatedelete

◆ SetTypeFilter()

void otb::Wrapper::FieldParameter::SetTypeFilter ( TypeFilterType typeFilter )

inline

Set list of allowed field types

Definition at line 73 of file otbWrapperFieldParameter.h.

◆ SetVectorData()

void otb::Wrapper::FieldParameter::SetVectorData ( std::string vectorData )

inline

Set vector data name from which we choose the fields

Definition at line 61 of file otbWrapperFieldParameter.h.

Member Data Documentation

◆ m_TypeFilter

TypeFilterType otb::Wrapper::FieldParameter::m_TypeFilter

protected

Definition at line 92 of file otbWrapperFieldParameter.h.

◆ m_VectorData

std::string otb::Wrapper::FieldParameter::m_VectorData

protected

Definition at line 91 of file otbWrapperFieldParameter.h.

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

otbWrapperFieldParameter.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

◆ TypeFilterType

Constructor & Destructor Documentation

◆ FieldParameter() [1/2]

◆ ~FieldParameter()

◆ FieldParameter() [2/2]

Member Function Documentation

◆ CreateAnother()

◆ GetNameOfClass()

◆ GetType()

◆ GetTypeFilter()

◆ GetVectorData()

◆ New()

◆ operator=()

◆ SetTypeFilter()

◆ SetVectorData()

Member Data Documentation

◆ m_TypeFilter

◆ m_VectorData