ml::AlgorithmModule::Error Class Reference

Data structure to indicate an error within an AlgorithmModule derivative's implementation of interface methods. More...

#include <mlAlgorithmModule.h>

Inheritance diagram for ml::AlgorithmModule::Error:

Public Member Functions
	Error (const AlgorithmModule::EStatusCode statusCode, const std::string &message)
	~Error () override
AlgorithmModule::EStatusCode	getStatusCode () const
const std::string &	getMessage () const

Detailed Description

Data structure to indicate an error within an AlgorithmModule derivative's implementation of interface methods.

There are some interface methods allowing an AlgorithmModule derivative to throw an object of this error class or one of its derivatives to indicate occurrence of an error during execution. There are specialized derivatives available.

Definition at line 91 of file mlAlgorithmModule.h.

Constructor & Destructor Documentation

Error()

ml::AlgorithmModule::Error::Error	(	const AlgorithmModule::EStatusCode	statusCode,
		const std::string &	message
	)

~Error()

ml::AlgorithmModule::Error::~Error ( )

override

Member Function Documentation

getMessage()

const std::string& ml::AlgorithmModule::Error::getMessage

(

)

const

getStatusCode()

AlgorithmModule::EStatusCode ml::AlgorithmModule::Error::getStatusCode

(

)

const

---

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

• FMEstable/ReleaseMeVis/Projects/AlgorithmModule/MLAlgorithmModule/Sources/mlAlgorithmModule.h