TePDIParameters Class Reference

This file contains the class of structures and definitions to deal with parameters used by all PDI classes. More...

#include <TePDIParameters.hpp>

Inheritance diagram for TePDIParameters:

List of all members.

Public Types
typedef TeSharedPtr < TePDIParameters >	pointer
typedef const TeSharedPtr < TePDIParameters >	const_pointer
Public Member Functions
	TePDIParameters ()
	Default Constructor.
	TePDIParameters (const TePDIParameters &external)
	Alternative Constructor.
	~TePDIParameters ()
	Default Destructor.
void	SetdecName (const std::string &dec_name)
	Set the a name descriptor for the current parameters.
std::string	decName () const
	Returns the a name descriptor for the current parameters.
bool	operator== (const TePDIParameters &ext_instance) const
	Operator == overload.
bool	operator!= (const TePDIParameters &ext_instance) const
	Operator != overload.
const TePDIParameters &	operator= (const TePDIParameters &ext_instance)
	operator= overload.
void	Clear ()
	Clear all parameter contents.
template<typename DataT >
void	SetParameter (const std::string &pname, const DataT &data)
	Store a parameter object copy.
template<typename DataT >
bool	GetParameter (const std::string &pname, DataT &data) const
	Retrive a copy of a stored object.
template<typename DataT >
bool	CheckParameter (const std::string &pname) const
	Checks if a parameter was set.
void	RemoveParameter (const std::string &pname)
	Remove a stored parameter.

---

Detailed Description

This file contains the class of structures and definitions to deal with parameters used by all PDI classes.

Store parameters used by all PDI classes.

Author:

Emiliano F. Castejon <castejon@dpi.inpe.br>

Note:

Do not use this class with polymorphic types !!

Examples:

TePDIArithmetic_test.cpp, TePDIBDFilter_test.cpp, TePDIClassification_test.cpp, TePDIColorTransform_test.cpp, TePDIContrast_test.cpp, TePDICorrelationMatching_test.cpp, TePDIDecorrelationEnhancement_test.cpp, TePDIFFT_test.cpp, TePDIFusion_test.cpp, TePDIHants_test.cpp, TePDIHaralick_test.cpp, TePDILinearFilter_test.cpp, TePDIMIMatching_test.cpp, TePDIMixModel_test.cpp, TePDIMMIOMatching_test.cpp, TePDIMorfFilter_test.cpp, TePDIMosaic_test.cpp, TePDIOFMatching_test.cpp, TePDIParallelSegmenter_test.cpp, TePDIParameters_test.cpp, TePDIPrincipalComponents_test.cpp, TePDIRadarFilters_test.cpp, TePDIRaster2Vector_test.cpp, TePDIRegister_test.cpp, TePDISegmentation_test.cpp, TePDISensorSimulator_test.cpp, TePDISimplex_test.cpp, TePDIStatistic_test.cpp, and TePDIWavelets_test.cpp.

---

Member Typedef Documentation

const TeSharedPtr< TePDIParameters > TePDIParameters::const_pointer

Type definition for a const instance pointer

Reimplemented from TeMultiContainer< std::string >.

TeSharedPtr< TePDIParameters > TePDIParameters::pointer

Type definition for a instance pointer

Reimplemented from TeMultiContainer< std::string >.

---

Constructor & Destructor Documentation

TePDIParameters::TePDIParameters

(

)

Default Constructor.

TePDIParameters::TePDIParameters

(

const TePDIParameters &

external

)

Alternative Constructor.

Parameters:

external

External reference.

TePDIParameters::~TePDIParameters

(

)

Default Destructor.

---

Member Function Documentation

template<typename DataT >

bool TePDIParameters::CheckParameter

(

const std::string &

pname

)

const [inline]

Checks if a parameter was set.

Parameters:

pname

Parameter name.

Note:

The parameter data type must be specified.

Returns:

true if OK, false if the parameter was not set.

Examples:

TePDIParameters_test.cpp.

void TePDIParameters::Clear

(

void

)

Clear all parameter contents.

std::string TePDIParameters::decName

(

)

const

Returns the a name descriptor for the current parameters.

Returns:

A a name descriptor for the current parameters.

template<typename DataT >

bool TePDIParameters::GetParameter	(	const std::string &	pname,
		DataT &	data
	)		const [inline]

Retrive a copy of a stored object.

Parameters:

pname	Parameter name.
data	Output parameter data.

Returns:

true if OK, false if the parameter was no found or error.

Examples:

TePDIMixModel_test.cpp, and TePDIParameters_test.cpp.

bool TePDIParameters::operator!=

(

const TePDIParameters &

ext_instance

)

const

Operator != overload.

Parameters:

ext_instance

External instance reference.

Returns:

true if this instance don't have the same internal parameters that the external instance.

const TePDIParameters & TePDIParameters::operator=

(

const TePDIParameters &

ext_instance

)

operator= overload.

Parameters:

ext_instance

External instance reference.

Returns:

The external instance reference.

bool TePDIParameters::operator==

(

const TePDIParameters &

ext_instance

)

const

Operator == overload.

Parameters:

ext_instance

External instance reference.

Returns:

true if this instance have the same internal parameters that the external instance.

void TePDIParameters::RemoveParameter

(

const std::string &

pname

)

[inline]

Remove a stored parameter.

Parameters:

pname

Parameter name.

Examples:

TePDIParameters_test.cpp.

void TePDIParameters::SetdecName

(

const std::string &

dec_name

)

Set the a name descriptor for the current parameters.

Parameters:

dec_name

A a name descriptor for the current parameters.

template<typename DataT >

void TePDIParameters::SetParameter	(	const std::string &	pname,
		const DataT &	data
	)		[inline]

Store a parameter object copy.

Parameters:

pname	Parameter name.
data	Parameter object instance.

Examples:

TePDIArithmetic_test.cpp, TePDIBDFilter_test.cpp, TePDIClassification_test.cpp, TePDIColorTransform_test.cpp, TePDIContrast_test.cpp, TePDICorrelationMatching_test.cpp, TePDIDecorrelationEnhancement_test.cpp, TePDIFFT_test.cpp, TePDIFusion_test.cpp, TePDIHants_test.cpp, TePDIHaralick_test.cpp, TePDILinearFilter_test.cpp, TePDIMIMatching_test.cpp, TePDIMixModel_test.cpp, TePDIMMIOMatching_test.cpp, TePDIMorfFilter_test.cpp, TePDIMosaic_test.cpp, TePDIOFMatching_test.cpp, TePDIParallelSegmenter_test.cpp, TePDIParameters_test.cpp, TePDIPrincipalComponents_test.cpp, TePDIRadarFilters_test.cpp, TePDIRaster2Vector_test.cpp, TePDIRegister_test.cpp, TePDISegmentation_test.cpp, TePDISensorSimulator_test.cpp, TePDISimplex_test.cpp, TePDIStatistic_test.cpp, and TePDIWavelets_test.cpp.

---

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

• E:/Projetos_Primeiro_Semestre_2012/TerraView/terralib/src/terralib/image_processing/TePDIParameters.hpp
• E:/Projetos_Primeiro_Semestre_2012/TerraView/terralib/src/terralib/image_processing/TePDIParameters.cpp