mlAlgorithmModule.h

Go to the documentation of this file.

// Copyright (c) Fraunhofer MEVIS, Germany. All rights reserved.
// **InsertLicense** code
//------------------------------------------------------------------------------
 
#pragma once
 
#include "MLAlgorithmModuleSystem.h"
#include <mlModuleIncludes.h>
#include <FMEException/Exception.h>
#include <ThirdPartyWarningsDisable.h>
#include <string>
#include <ThirdPartyWarningsRestore.h>
 
ML_START_NAMESPACE
 
class ML_ALGORITHM_MODULE_EXPORT AlgorithmModule : public Module {
  public:
    AlgorithmModule(int numInputImages, int numOutputImages);
    ~AlgorithmModule() override;
 
    void handleNotification(Field* field) override;
 
    void activateAttachments() override;
 
    void calculateOutputImageProperties(int outputIndex, PagedImage* outputImage) override;
 
  protected:
    enum EStatusCode {
      SC_OK = 0,
      SC_ERROR_INPUT_OBJECT,
      SC_ERROR_INPUT_PARAMETER,
      SC_ERROR_INTERNAL,
    };
 
    class ML_ALGORITHM_MODULE_EXPORT Error : public fme::Exception {
      public:
        Error(const AlgorithmModule::EStatusCode statusCode, const std::string& message);
        ~Error() override;
        AlgorithmModule::EStatusCode getStatusCode() const;
        const std::string& getMessage() const;
 
      private:
        AlgorithmModule::EStatusCode _statusCode;
        std::string _message;
    };
 
    class ML_ALGORITHM_MODULE_EXPORT InputObjectError : public Error {
      public:
        InputObjectError(const std::string& message);
        ~InputObjectError() override;
    };
 
    class ML_ALGORITHM_MODULE_EXPORT InputParameterError : public Error {
      public:
        InputParameterError(const std::string& message);
        ~InputParameterError() override;
    };
 
    class ML_ALGORITHM_MODULE_EXPORT InternalError : public Error {
      public:
        InternalError(const std::string& message);
        ~InternalError() override;
    };
 
    virtual void validateInput() = 0;
 
    virtual void update() = 0;
 
    virtual void clear() = 0;
 
    virtual void setOutputImageProperties(int outputIndex, PagedImage* outputImage);
 
  private:
    enum EOnInputChangeBehavior {
      OICB_Update = 0,
      OICB_Clear
    };
 
    void _addUpdateControlFields();
    void _addStatusFields();
    void _addStatusCodeField();
    bool _isFieldUpdate(Field* field) const;
    bool _isFieldOnInputChangeBehavior(Field* field) const;
    bool _shouldUpdateOnInputChange() const;
    bool _isFieldClear(Field* field) const;
    bool _isInputField(const Field* field) const;
    bool _hasNamePrefixIn(const std::string& name) const;
    bool _hasNamePrefixInput(const std::string& name) const;
    void _handleInputFieldNotification();
    void _initiateUpdate();
    void _validateInputAndUpdate();
    void _handleErrorDuringUpdate(const AlgorithmModule::Error& error);
    bool _shouldClearOnFailedUpdate();
    void _setStatusCodeAndMessageFieldValues(const EStatusCode code, const std::string& message);
    void _clearOutput();
    void _initiateClear();
    void _tryToSetOutputImageProperties(int outputIndex, PagedImage* outputImage);
    void _validateOutputImageValidity(const PagedImage* const outputImage) const;
    void _handleErrorDuringSetOutputImageProperties(PagedImage* outputImage, const AlgorithmModule::Error& error);
    void _setImageInvalid(PagedImage* const image);
 
    bool _hasValidatedInputAndInitiatedUpdate;
    bool _wasOutputCleared;
    bool _didSetOutputImagePropertiesFail;
 
    TypedEnumField<EOnInputChangeBehavior>* onInputChangeBehaviorField;
 
    NotifyField* updateField;
 
    NotifyField* clearField;
 
    NotifyField* updateDoneField;
 
    TypedEnumField<EStatusCode>* statusCodeField;
 
    StringField* statusMessageField;
 
    BoolField* hasValidOutputField;
 
    BoolField* doNotClearOnFailedUpdateField;
 
    ML_ABSTRACT_MODULE_CLASS_HEADER(AlgorithmModule)
};
 
ML_END_NAMESPACE