MLAlgorithmModule
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 AlgorithmModule::Error:
AlgorithmModule::InputObjectError AlgorithmModule::InputParameterError AlgorithmModule::InternalError

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.

Constructor & Destructor Documentation

◆ Error()

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

◆ ~Error()

AlgorithmModule::Error::~Error ( )
override

Member Function Documentation

◆ getMessage()

const std::string & AlgorithmModule::Error::getMessage ( ) const

◆ getStatusCode()

AlgorithmModule::EStatusCode AlgorithmModule::Error::getStatusCode ( ) const

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