AlgorithmModuleExample Class Reference

Example to demonstrate the development of an ML module based on AlgorithmModule. More...

#include <mlAlgorithmModuleExample.h>

Inheritance diagram for AlgorithmModuleExample:

Public Member Functions
	AlgorithmModuleExample ()
	~AlgorithmModuleExample () override final
Public Member Functions inherited from AlgorithmModule
	AlgorithmModule (int numInputImages, int numOutputImages)
	Forwards given parameters to base class constructor.
	~AlgorithmModule () override
void	handleNotification (Field *field) override
	Never overwrite this method in derivative!
void	activateAttachments () override
	Never overwrite this method in derivative!
void	calculateOutputImageProperties (int outputIndex, PagedImage *outputImage) override
	Never overwrite this method in derivative!

Protected Member Functions
void	validateInput () override final
	Validates the values of module's input fields (object and parameter fields).
void	update () override final
	Executes the algorithm and updates the values of module's output fields with results.
void	clear () override final
	Clears the values of module's output fields (object and parameter fields).
Protected Member Functions inherited from AlgorithmModule
virtual void	validateInput ()=0
	Validates the values of module's input fields (object and parameter fields).
virtual void	update ()=0
	Executes the algorithm and updates the values of module's output fields with results.
virtual void	clear ()=0
	Clears the values of module's output fields (object and parameter fields).
virtual void	setOutputImageProperties (int outputIndex, PagedImage *outputImage)
	Sets properties of the output image at output outputIndex.

Additional Inherited Members
Protected Types inherited from AlgorithmModule
enum	EStatusCode { SC_OK = 0 , SC_ERROR_INPUT_OBJECT , SC_ERROR_INPUT_PARAMETER , SC_ERROR_INTERNAL }
	Contains possible values of field statusCode. More...

Detailed Description

Example to demonstrate the development of an ML module based on AlgorithmModule.

Constructor & Destructor Documentation

AlgorithmModuleExample()

AlgorithmModuleExample::AlgorithmModuleExample

(

)

~AlgorithmModuleExample()

AlgorithmModuleExample::~AlgorithmModuleExample ( )

finaloverride

Member Function Documentation

clear()

void AlgorithmModuleExample::clear ( )

finaloverrideprotectedvirtual

Clears the values of module's output fields (object and parameter fields).

Implements AlgorithmModule.

update()

void AlgorithmModuleExample::update ( )

finaloverrideprotectedvirtual

Executes the algorithm and updates the values of module's output fields with results.

Exceptions

Throws

an exception of type AlgorithmModule::Error on failure.

Implements AlgorithmModule.

validateInput()

void AlgorithmModuleExample::validateInput ( )

finaloverrideprotectedvirtual

Validates the values of module's input fields (object and parameter fields).

Exceptions

Throws

an exception of type AlgorithmModule::Error on failure.

Implements AlgorithmModule.

---

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

• C:/jh/mevislab/4.0.2_1/source/FMEstable/ReleaseMeVis/Projects/AlgorithmModule/MLAlgorithmModuleExamples/Sources/mlAlgorithmModuleExample.h
• C:/jh/mevislab/4.0.2_1/source/FMEstable/ReleaseMeVis/Projects/AlgorithmModule/MLAlgorithmModuleExamples/Sources/mlAlgorithmModuleExample.cpp