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< Self >	Pointer
typedef DocExampleStructure	Self
typedef itk::Object	Superclass

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 ()
std::string	GenerateCLExample (unsigned int exId)
std::string	GenerateHtmlExample ()
std::string	GenerateHtmlExample (unsigned int exId)
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)

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	DocExampleStructure ()
	~DocExampleStructure () override

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

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

ConstPointer

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

Definition at line 53 of file otbWrapperDocExampleStructure.h.

ParametersVectorOfVectorType

typedef std::vector<ParametersVectorType> otb::Wrapper::DocExampleStructure::ParametersVectorOfVectorType

Definition at line 63 of file otbWrapperDocExampleStructure.h.

ParametersVectorType

typedef std::vector<ParameterType> otb::Wrapper::DocExampleStructure::ParametersVectorType

Definition at line 62 of file otbWrapperDocExampleStructure.h.

ParameterType

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

Definition at line 59 of file otbWrapperDocExampleStructure.h.

Pointer

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

Definition at line 52 of file otbWrapperDocExampleStructure.h.

Self

typedef DocExampleStructure otb::Wrapper::DocExampleStructure::Self

Standard class typedefs

Definition at line 50 of file otbWrapperDocExampleStructure.h.

Superclass

typedef itk::Object otb::Wrapper::DocExampleStructure::Superclass

Definition at line 51 of file otbWrapperDocExampleStructure.h.

Constructor & Destructor Documentation

DocExampleStructure() [1/2]

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

protected

Constructor

~DocExampleStructure()

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

overrideprotected

Destructor

DocExampleStructure() [2/2]

otb::Wrapper::DocExampleStructure::DocExampleStructure ( const DocExampleStructure &  )

privatedelete

Member Function Documentation

AddExample()

unsigned int otb::Wrapper::DocExampleStructure::AddExample

(

const std::string &

comm = ""

)

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

AddParameter()

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

CreateAnother()

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

(

void

)

const

GenerateCLExample() [1/2]

std::string otb::Wrapper::DocExampleStructure::GenerateCLExample

(

)

Generation of the documentation for CommandLine.

GenerateCLExample() [2/2]

std::string otb::Wrapper::DocExampleStructure::GenerateCLExample

(

unsigned int

exId

)

Generation of the documentation for CommandLine for one specific example.

GenerateHtmlExample() [1/2]

std::string otb::Wrapper::DocExampleStructure::GenerateHtmlExample

(

)

Generation of the documentation for Qt.

GenerateHtmlExample() [2/2]

std::string otb::Wrapper::DocExampleStructure::GenerateHtmlExample

(

unsigned int

exId

)

Generation of the documentation for Qt for one specific example.

GetApplicationName()

std::string otb::Wrapper::DocExampleStructure::GetApplicationName

(

)

Get Application name.

GetExampleComment()

std::string otb::Wrapper::DocExampleStructure::GetExampleComment

(

unsigned int

i

)

Get one example comment

GetExampleCommentList()

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

(

)

Get the example comment list

GetNameOfClass()

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

virtual

Runtime information

GetNbOfExamples()

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

virtual

Get the number of examples

GetNumberOfParameters()

unsigned int otb::Wrapper::DocExampleStructure::GetNumberOfParameters

(

unsigned int

exId = 0

)

Get number of parameters

GetParameterKey()

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

Get a specific parameter couple key.

GetParameterList()

ParametersVectorOfVectorType otb::Wrapper::DocExampleStructure::GetParameterList

(

)

Get the parameter list.

GetParameterValue()

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

Get a specific parameter couple value as string.

New()

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

static

Standards macros

operator=()

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

privatedelete

SetApplicationName()

void otb::Wrapper::DocExampleStructure::SetApplicationName

(

const std::string &

name

)

Set Application name.

SetExampleComment()

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

Set one example comment

Member Data Documentation

m_ApplicationName

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

private

Application name

Definition at line 132 of file otbWrapperDocExampleStructure.h.

m_ExampleCommentList

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

private

Example comments

Definition at line 135 of file otbWrapperDocExampleStructure.h.

m_NbOfExamples

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

private

Stores the number of example.

Definition at line 138 of file otbWrapperDocExampleStructure.h.

m_ParameterList

ParametersVectorOfVectorType otb::Wrapper::DocExampleStructure::m_ParameterList

private

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

Definition at line 129 of file otbWrapperDocExampleStructure.h.

---

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

• otbWrapperDocExampleStructure.h