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

#include <otbWrapperDocExampleStructure.h>

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

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef std::vector
< ParametersVectorType
ParametersVectorOfVectorType
 
typedef std::vector
< ParameterType
ParametersVectorType
 
typedef std::pair< std::string,
std::string > 
ParameterType
 
typedef itk::SmartPointer< SelfPointer
 
typedef DocExampleStructure 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

unsigned int AddExample (const std::string &comm="")
 
void AddParameter (const std::string key, const std::string name, unsigned int exId=0)
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
std::string GenerateCLExample (unsigned int exId)
 
std::string GenerateCLExample ()
 
std::string GenerateHtmlExample (unsigned int exId)
 
std::string GenerateHtmlExample ()
 
std::string GetApplicationName ()
 
std::string GetExampleComment (unsigned int i)
 
std::vector< std::string > GetExampleCommentList ()
 
virtual const char * GetNameOfClass () const
 
virtual unsigned int GetNbOfExamples ()
 
unsigned int GetNumberOfParameters (unsigned int exId=0)
 
std::string GetParameterKey (unsigned int i, unsigned int exId=0)
 
ParametersVectorOfVectorType GetParameterList ()
 
std::string GetParameterValue (unsigned int i, unsigned int exId=0)
 
void SetApplicationName (const std::string name)
 
void SetExampleComment (const std::string &comm, unsigned int i)
 
- 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

 DocExampleStructure ()
 
 ~DocExampleStructure () override
 
- 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

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

Private Attributes

std::string m_ApplicationName
 
std::vector< std::string > m_ExampleCommentList
 
unsigned int m_NbOfExamples
 
ParametersVectorOfVectorType m_ParameterList
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Detailed Description

This class is a structure that gathered the necessary element to generate an example (for CommandLine, python ...). User has to set the application name, the binary path and a list of key/value couple.

Definition at line 46 of file otbWrapperDocExampleStructure.h.

Member Typedef Documentation

Definition at line 54 of file otbWrapperDocExampleStructure.h.

Definition at line 64 of file otbWrapperDocExampleStructure.h.

Definition at line 63 of file otbWrapperDocExampleStructure.h.

typedef std::pair<std::string, std::string> otb::Wrapper::DocExampleStructure::ParameterType

Definition at line 60 of file otbWrapperDocExampleStructure.h.

Definition at line 53 of file otbWrapperDocExampleStructure.h.

Standard class typedefs

Definition at line 51 of file otbWrapperDocExampleStructure.h.

Definition at line 52 of file otbWrapperDocExampleStructure.h.

Constructor & Destructor Documentation

otb::Wrapper::DocExampleStructure::DocExampleStructure ( )
protected

Constructor

otb::Wrapper::DocExampleStructure::~DocExampleStructure ( )
overrideprotected

Destructor

otb::Wrapper::DocExampleStructure::DocExampleStructure ( const DocExampleStructure )
privatedelete

Member Function Documentation

unsigned int otb::Wrapper::DocExampleStructure::AddExample ( const std::string &  comm = "")

Add an example using comment. Return the index of the new example.

void otb::Wrapper::DocExampleStructure::AddParameter ( const std::string  key,
const std::string  name,
unsigned int  exId = 0 
)

Parameter list accessors. Parameter list accessors : adding key and name

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

Reimplemented from itk::Object.

std::string otb::Wrapper::DocExampleStructure::GenerateCLExample ( unsigned int  exId)

Generation of the documentation for CommandLine for one specific example.

std::string otb::Wrapper::DocExampleStructure::GenerateCLExample ( )

Generation of the documentation for CommandLine.

std::string otb::Wrapper::DocExampleStructure::GenerateHtmlExample ( unsigned int  exId)

Generation of the documentation for Qt for one specific example.

std::string otb::Wrapper::DocExampleStructure::GenerateHtmlExample ( )

Generation of the documentation for Qt.

std::string otb::Wrapper::DocExampleStructure::GetApplicationName ( )

Get Application name.

std::string otb::Wrapper::DocExampleStructure::GetExampleComment ( unsigned int  i)

Get one example comment

std::vector<std::string> otb::Wrapper::DocExampleStructure::GetExampleCommentList ( )

Get the example comment list

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

Runtime information

Reimplemented from itk::Object.

virtual unsigned int otb::Wrapper::DocExampleStructure::GetNbOfExamples ( )
virtual

Get the number of examples

unsigned int otb::Wrapper::DocExampleStructure::GetNumberOfParameters ( unsigned int  exId = 0)

Get number of parameters

std::string otb::Wrapper::DocExampleStructure::GetParameterKey ( unsigned int  i,
unsigned int  exId = 0 
)

Get a specific parameter couple key.

ParametersVectorOfVectorType otb::Wrapper::DocExampleStructure::GetParameterList ( )

Get the parameter list.

std::string otb::Wrapper::DocExampleStructure::GetParameterValue ( unsigned int  i,
unsigned int  exId = 0 
)

Get a specific parameter couple value as string.

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

Standards macros

void otb::Wrapper::DocExampleStructure::operator= ( const DocExampleStructure )
privatedelete
void otb::Wrapper::DocExampleStructure::SetApplicationName ( const std::string  name)

Set Application name.

void otb::Wrapper::DocExampleStructure::SetExampleComment ( const std::string &  comm,
unsigned int  i 
)

Set one example comment

Member Data Documentation

std::string otb::Wrapper::DocExampleStructure::m_ApplicationName
private

Application name

Definition at line 133 of file otbWrapperDocExampleStructure.h.

std::vector<std::string> otb::Wrapper::DocExampleStructure::m_ExampleCommentList
private

Example comments

Definition at line 136 of file otbWrapperDocExampleStructure.h.

unsigned int otb::Wrapper::DocExampleStructure::m_NbOfExamples
private

Stores the number of example.

Definition at line 139 of file otbWrapperDocExampleStructure.h.

ParametersVectorOfVectorType otb::Wrapper::DocExampleStructure::m_ParameterList
private

List of the application parameters. List of key/name/value couples.

Definition at line 130 of file otbWrapperDocExampleStructure.h.


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