mitkIPythonService.h

Go to the documentation of this file.

/*============================================================================
 
The Medical Imaging Interaction Toolkit (MITK)
 
Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.
 
Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.
 
============================================================================*/
#ifndef mitkIPythonService_h
#define mitkIPythonService_h
 
// mitk
#include <mitkImage.h>
#include <mitkSurface.h>
#include <MitkPythonExports.h>
 
//for microservices
#include <mitkServiceInterface.h>
 
#include <vector>
 
 
class ctkAbstractPythonManager;
 
namespace mitk
{
    struct PythonVariable
    {
      std::string m_Name;
      std::string m_Type;
      std::string m_Value;
    };
 
    class PythonCommandObserver
    {
    public:
      virtual void CommandExecuted(const std::string& pythonCommand) = 0;
    };
 
    class MITKPYTHON_EXPORT IPythonService
    {
    public:
        static const int SINGLE_LINE_COMMAND = 0;
        static const int MULTI_LINE_COMMAND = 1;
        static const int EVAL_COMMAND = 2;
 
        virtual std::string Execute( const std::string& pythonCommand, int commandType = SINGLE_LINE_COMMAND ) = 0;
        virtual void ExecuteScript( const std::string& pathToPythonScript ) = 0;
        virtual bool PythonErrorOccured() const = 0;
        virtual std::vector<PythonVariable> GetVariableStack() const = 0;
        virtual bool DoesVariableExist(const std::string& name) const = 0;
        virtual std::string GetVariable(const std::string& name) const = 0;
        virtual void AddPythonCommandObserver( PythonCommandObserver* observer ) = 0;
        virtual void RemovePythonCommandObserver( PythonCommandObserver* observer ) = 0;
        virtual void NotifyObserver( const std::string& command ) = 0;
 
        virtual bool IsSimpleItkPythonWrappingAvailable() = 0;
        virtual bool CopyToPythonAsSimpleItkImage( mitk::Image* image, const std::string& varName ) = 0;
        virtual mitk::Image::Pointer CopySimpleItkImageFromPython( const std::string& varName ) = 0;
 
        virtual bool IsVtkPythonWrappingAvailable() = 0;
        virtual bool CopyToPythonAsVtkPolyData( mitk::Surface* surface, const std::string& varName ) = 0;
 
        virtual ctkAbstractPythonManager* GetPythonManager() = 0;
 
        virtual ~IPythonService(); // leer in mitkIPythonService.cpp implementieren
 
        // force us module loading by linking
        static std::string ForceLoadModule();
 
        virtual void AddRelativeSearchDirs(std::vector< std::string > dirs) = 0;
 
        virtual void AddAbsoluteSearchDirs(std::vector< std::string > dirs) = 0;
    };
}
 
MITK_DECLARE_SERVICE_INTERFACE(mitk::IPythonService, "org.mitk.services.IPythonService")
 
#endif