mlParameterInfoDoc.h

Go to the documentation of this file.

// Copyright (c) Fraunhofer MEVIS, Germany. All rights reserved.
// **InsertLicense** code
 
#pragma once
#include "mlParameterInfo.h"
#include "mlParameterInfoUtils.h"
#include "../../MLParameterInfoWrappers/Sources/mlParameterInfoWrapper.h"
 
ML_START_NAMESPACE

class MyAlgorithm : public BaseWithParameterInfo {
 
private:
  ParameterInfo _getParameterInfo() const override;
 
  int _exampleInt{ 4711 };
  double _exampleDouble{ 47.11 };
  std::string _exampleString{ "Some String" };
 
  // Complex data types
  ml::ImageVector _exampleImageVector{ 1, 2, 3, 4, 5, 6 };
  ml::Vector3 _exampleFloatVector{ 1.1, 2.2, 3.3 };
  ml::SubImageBox _exampleSubImageBox{ { 1, 2, 3, 4, 5, 6 }, { 1, 2, 3, 4, 5, 6 } };  
 
  ML_CLASS_HEADER( BaseWithParameterInfoExample )
};
 
ML_END_NAMESPACE
  \endcode
 
  In the MeVisLab network, we would want the ParameterInfoInspector module to show for that object:
  
  \code{.json}
  {
    "ExampleInt": 4711,
    "ExampleDouble": 47.11,
    "ExampleString": "Some String",
    "ComplexDatatypes": {
      "ExampleImageVector": [ 1, 2, 3, 4, 5, 6 ],
      "ExampleFloatVector": [ 1.1, 2.2, 3.3 ],
      "ExampleSubImageBox": [ [ 1, 2, 3, 4, 5, 6 ], [ 1, 2, 3, 4, 5, 6 ] ]
    }
  }
  \endcode
  
  We could achieve this with this implementation in the corresponding source file:
  \code{.cpp}
// [...]
 
void MyAlgorithm::_getParameterInfo() const {
  ParameterInfo pi;
  // Values need to be (convertible to) QVariant. This is how it works:
  pi[ "ExampleInt" ] = _exampleInt;
  pi[ "ExampleDouble" ] = _exampleDouble;
  pi[ "ExampleString" ] = QString::fromStdString( _exampleString );
  ParameterInfo complexPi;
  complexPi[ "ExampleImageVector" ] = parameter_info_utils::ToQVariantList( _exampleImageVector );
  complexPi[ "ExampleFloatVector" ] = parameter_info_utils::FloatVectorToQVariantList( _exampleFloatVector );
  complexPi[ "ExampleSubImageBox" ] = parameter_info_utils::ToQVariantList( _exampleSubImageBox );
  pi[ "ComplexDatatypes" ] = complexPi;
  return pi;
}
 
ML_CLASS_SOURCE( MyAlgorithm, BaseWithParameterInfo )
 
// [...]
  \endcode
  */
 
 
 
 
ML_END_NAMESPACE