OTB  9.0.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::OutputFilenameParameter Class Reference

#include <otbWrapperOutputFilenameParameter.h>

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

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef itk::SmartPointer< SelfPointer
 
typedef OutputFilenameParameter Self
 
typedef StringParameter Superclass
 
- Public Types inherited from otb::Wrapper::Parameter
typedef itk::SmartPointer< const SelfConstPointer
 
typedef itk::SmartPointer< SelfPointer
 
typedef Parameter Self
 
typedef itk::Object Superclass
 

Public Member Functions

void ClearValue () override
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
void FromString (const std::string &value) override
 
virtual const char * GetNameOfClass () const
 
ParameterType GetType () const override
 
bool HasValue () const override
 
 otbGetObjectMemberConstMacro (StringParam, Value, std::string)
 
virtual void SetValue (const std::string value)
 
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 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::PointerGetChildrenList ()
 
void TypeError (const std::string &target_type) const
 
virtual int ToInt () const
 
virtual float ToFloat () const
 
virtual double ToDouble () const
 
virtual std::vector< std::string > ToStringList () const
 
virtual void FromInt (int)
 
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

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

Private Member Functions

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

Private Attributes

StringParameter::Pointer m_StringParam
 

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< Parameterm_Root
 
std::vector< Parameter::Pointerm_ChildrenList
 

Detailed Description

This class represent a string parameter for the wrapper framework.

Definition at line 37 of file otbWrapperOutputFilenameParameter.h.

Member Typedef Documentation

◆ ConstPointer

Definition at line 44 of file otbWrapperOutputFilenameParameter.h.

◆ Pointer

Definition at line 43 of file otbWrapperOutputFilenameParameter.h.

◆ Self

Standard class typedef

Definition at line 41 of file otbWrapperOutputFilenameParameter.h.

◆ Superclass

Definition at line 42 of file otbWrapperOutputFilenameParameter.h.

Constructor & Destructor Documentation

◆ OutputFilenameParameter() [1/2]

otb::Wrapper::OutputFilenameParameter::OutputFilenameParameter ( )
inlineprotected

Constructor

Definition at line 93 of file otbWrapperOutputFilenameParameter.h.

References otb::Wrapper::StringParameter::New().

◆ ~OutputFilenameParameter()

otb::Wrapper::OutputFilenameParameter::~OutputFilenameParameter ( )
inlineoverrideprotected

Destructor

Definition at line 100 of file otbWrapperOutputFilenameParameter.h.

◆ OutputFilenameParameter() [2/2]

otb::Wrapper::OutputFilenameParameter::OutputFilenameParameter ( const OutputFilenameParameter )
privatedelete

Member Function Documentation

◆ ClearValue()

void otb::Wrapper::OutputFilenameParameter::ClearValue ( )
inlineoverridevirtual

Name of the parameter

Reimplemented from otb::Wrapper::Parameter.

Definition at line 71 of file otbWrapperOutputFilenameParameter.h.

◆ CreateAnother()

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

◆ FromString()

void otb::Wrapper::OutputFilenameParameter::FromString ( const std::string &  )
inlineoverridevirtual

Name of the parameter

Reimplemented from otb::Wrapper::Parameter.

Definition at line 86 of file otbWrapperOutputFilenameParameter.h.

◆ GetNameOfClass()

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

RTTI support

Reimplemented from otb::Wrapper::Parameter.

◆ GetType()

ParameterType otb::Wrapper::OutputFilenameParameter::GetType ( ) const
inlineoverridevirtual

Get the dynamic type as declared in WrapperTypes.h

Implements otb::Wrapper::Parameter.

Definition at line 76 of file otbWrapperOutputFilenameParameter.h.

References otb::Wrapper::ParameterType_OutputFilename.

◆ HasValue()

bool otb::Wrapper::OutputFilenameParameter::HasValue ( ) const
inlineoverridevirtual

Name of the parameter

Implements otb::Wrapper::Parameter.

Definition at line 53 of file otbWrapperOutputFilenameParameter.h.

◆ New()

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

Defining ::New() static method

◆ operator=()

void otb::Wrapper::OutputFilenameParameter::operator= ( const OutputFilenameParameter )
private

◆ otbGetObjectMemberConstMacro()

otb::Wrapper::OutputFilenameParameter::otbGetObjectMemberConstMacro ( StringParam  ,
Value  ,
std::string   
)

◆ SetValue()

virtual void otb::Wrapper::OutputFilenameParameter::SetValue ( const std::string  value)
inlinevirtual

Definition at line 62 of file otbWrapperOutputFilenameParameter.h.

◆ ToString()

std::string otb::Wrapper::OutputFilenameParameter::ToString ( ) const
inlineoverridevirtual

Name of the parameter

Reimplemented from otb::Wrapper::Parameter.

Definition at line 81 of file otbWrapperOutputFilenameParameter.h.

Member Data Documentation

◆ m_StringParam

StringParameter::Pointer otb::Wrapper::OutputFilenameParameter::m_StringParam
private

Definition at line 109 of file otbWrapperOutputFilenameParameter.h.


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