PyImportAssistant Class Reference

Assists in importing Python object to GUI models. More...

Inheritance diagram for PyImportAssistant:

Collaboration diagram for PyImportAssistant:

Public Member Functions
	PyImportAssistant (MainWindow *mainwin)
void	exec ()

Private Member Functions
std::unique_ptr< MultiLayer >	createMultiLayer (const QString &snippet, const QString &funcName)
	Creates a multi-layer by executing a funcName in embedded Python. More...
QString	fileNameToOpen ()
	Lets user to select Python file on disk. More...
QString	getPySampleFunctionName (const QString &snippet)
	Returns the name of function which might generate a MultiLayer in Python code snippet. More...
void	populateModels (const MultiLayer &multilayer, const QString &sampleName)
	Populates GUI models with domain multilayer. More...
QString	readFile (const QString &fileName)
	Read content of text file and returns it as a multi-line string. More...
void	saveImportDir (const QString &fileName)
	Saves file location as a future import dir. More...
QString	selectPySampleFunction (const QStringList &funcNames)
	Lets user select a function name which generates a MultiLayer. More...

Private Attributes
MainWindow *	m_mainWindow

Detailed Description

Assists in importing Python object to GUI models.

Definition at line 28 of file PyImportAssistant.h.

Constructor & Destructor Documentation

PyImportAssistant()

PyImportAssistant::PyImportAssistant

(

MainWindow *

mainwin

)

Definition at line 65 of file PyImportAssistant.cpp.

                                                        : QObject(mainwin), m_mainWindow(mainwin)
{
}

Member Function Documentation

createMultiLayer()

std::unique_ptr< MultiLayer > PyImportAssistant::createMultiLayer ( const QString &  snippet, const QString &  funcName  )

private

Creates a multi-layer by executing a funcName in embedded Python.

Function is supposed to be in code provided by 'snippet'.

Definition at line 189 of file PyImportAssistant.cpp.

{
    std::unique_ptr<MultiLayer> result;
 
    QApplication::setOverrideCursor(Qt::WaitCursor);
    try {
        result = PyImport::createFromPython(snippet.toStdString(), funcName.toStdString(),
                                            bornagainDir());
 
    } catch (const std::exception& ex) {
        QApplication::restoreOverrideCursor();
        QString message("Exception thrown while executing Python code to create multilayer.\n\n");
        QString details = QString::fromStdString(std::string(ex.what()));
        DetailedMessageBox(m_mainWindow, "Python failure", message, details).exec();
    }
    QApplication::restoreOverrideCursor();
 
    return result;
}

References PyImport::createFromPython(), and m_mainWindow.

Referenced by exec().

Here is the call graph for this function:

exec()

void PyImportAssistant::exec

(

)

Definition at line 69 of file PyImportAssistant.cpp.

{
    auto fileName = fileNameToOpen();
 
    if (fileName.isEmpty())
        return;
 
    QString snippet = readFile(fileName);
    if (snippet.isEmpty())
        return;
 
    QString funcName = getPySampleFunctionName(snippet);
    if (funcName.isEmpty())
        return;
 
    auto multilayer = createMultiLayer(snippet, funcName);
    if (!multilayer)
        return;
 
    populateModels(*multilayer, GUIHelpers::baseName(fileName));
}

References GUIHelpers::baseName(), createMultiLayer(), fileNameToOpen(), getPySampleFunctionName(), populateModels(), and readFile().

Referenced by ActionManager::onImportFromPythonScript().

Here is the call graph for this function:

fileNameToOpen()

QString PyImportAssistant::fileNameToOpen ( )

private

Lets user to select Python file on disk.

Definition at line 93 of file PyImportAssistant.cpp.

{
    QString dirname = AppSvc::projectManager()->userImportDir();
 
    QString result = QFileDialog::getOpenFileName(m_mainWindow, "Open python script", dirname,
                                                  "Python scripts (*.py)");
 
    saveImportDir(result);
 
    return result;
}

References m_mainWindow, AppSvc::projectManager(), saveImportDir(), and ProjectManager::userImportDir().

Referenced by exec().

Here is the call graph for this function:

getPySampleFunctionName()

QString PyImportAssistant::getPySampleFunctionName ( const QString &  snippet )

private

Returns the name of function which might generate a MultiLayer in Python code snippet.

Pop-ups dialog and asks user for help in the case of doubts.

Definition at line 137 of file PyImportAssistant.cpp.

{
    QStringList funcList;
 
    QApplication::setOverrideCursor(Qt::WaitCursor);
    try {
        auto funcs = PyImport::listOfFunctions(snippet.toStdString(), bornagainDir());
        funcList = GUIHelpers::fromStdStrings(funcs);
 
    } catch (const std::exception& ex) {
        QApplication::restoreOverrideCursor();
        QString message("Exception thrown while acquiring functions from Python code.\n\n");
        QString details = QString::fromStdString(std::string(ex.what()));
        DetailedMessageBox(m_mainWindow, "Python failure", message, details).exec();
 
        return "";
    }
    QApplication::restoreOverrideCursor();
 
    return selectPySampleFunction(funcList);
}

References GUIHelpers::fromStdStrings(), PyImport::listOfFunctions(), m_mainWindow, and selectPySampleFunction().

Referenced by exec().

Here is the call graph for this function:

populateModels()

void PyImportAssistant::populateModels ( const MultiLayer &  multilayer, const QString &  sampleName  )

private

Populates GUI models with domain multilayer.

Definition at line 212 of file PyImportAssistant.cpp.

{
    try {
        QString name = sampleName;
        if (multilayer.getName() != "MultiLayer")
            name = QString::fromStdString(multilayer.getName());
 
        GUIObjectBuilder::populateSampleModel(m_mainWindow->sampleModel(),
                                              m_mainWindow->materialModel(), multilayer, name);
 
        QString message("Seems that import was successfull.\n\n"
                        "Check SampleView for new sample and material editor for new materials.");
        GUIHelpers::information(m_mainWindow, "PyImport", message);
 
    } catch (const std::exception& ex) {
        QString message("Exception thrown while trying to build GUI models.\n"
                        "GUI models might be in unconsistent state.\n\n");
        QString details = QString::fromStdString(std::string(ex.what()));
        DetailedMessageBox(m_mainWindow, "GUIObjectBuilder failure", message, details).exec();
    }
}

References IParametricComponent::getName(), GUIHelpers::information(), m_mainWindow, MainWindow::materialModel(), RealSpace::Particles::name(), GUIObjectBuilder::populateSampleModel(), and MainWindow::sampleModel().

Referenced by exec().

Here is the call graph for this function:

readFile()

QString PyImportAssistant::readFile ( const QString &  fileName )

private

Read content of text file and returns it as a multi-line string.

Pop-ups warning dialog in the case of failure.

Definition at line 118 of file PyImportAssistant.cpp.

{
    QString result;
 
    try {
        result = ProjectUtils::readTextFile(fileName);
 
    } catch (const std::exception& ex) {
        QString message("Can't read the file. \n\n");
        message += QString::fromStdString(std::string(ex.what()));
        GUIHelpers::warning(m_mainWindow, "File read failure.", message);
    }
 
    return result;
}

References m_mainWindow, ProjectUtils::readTextFile(), and GUIHelpers::warning().

Referenced by exec().

Here is the call graph for this function:

saveImportDir()

void PyImportAssistant::saveImportDir ( const QString &  fileName )

private

Saves file location as a future import dir.

Definition at line 107 of file PyImportAssistant.cpp.

{
    if (fileName.isEmpty())
        return;
 
    AppSvc::projectManager()->setImportDir(GUIHelpers::fileDir(fileName));
}

References GUIHelpers::fileDir(), AppSvc::projectManager(), and ProjectManager::setImportDir().

Referenced by fileNameToOpen().

Here is the call graph for this function:

selectPySampleFunction()

QString PyImportAssistant::selectPySampleFunction ( const QStringList &  funcNames )

private

Lets user select a function name which generates a MultiLayer.

Definition at line 161 of file PyImportAssistant.cpp.

{
    QString result;
 
    if (funcNames.empty()) {
        QString message("Python code doesn't contain any functions.\n\n");
        GUIHelpers::warning(m_mainWindow, "Python failure", message);
 
    } else if (funcNames.size() == 1) {
        return funcNames.front();
 
    } else {
        ComboSelectorDialog dialog;
        dialog.addItems(funcNames, getCandidate(funcNames));
        dialog.setTextTop("Python code contains a few functions. Do you know by chance, "
                          "which one is intended to produce a valid MultiLayer?");
        dialog.setTextBottom(
            "Please select a valid function in combo box and press OK to continue.");
        if (dialog.exec() == QDialog::Accepted)
            result = dialog.currentText();
    }
 
    return result;
}

References ComboSelectorDialog::addItems(), ComboSelectorDialog::currentText(), m_mainWindow, ComboSelectorDialog::setTextBottom(), ComboSelectorDialog::setTextTop(), and GUIHelpers::warning().

Referenced by getPySampleFunctionName().

Here is the call graph for this function:

Member Data Documentation

m_mainWindow

MainWindow* PyImportAssistant::m_mainWindow

private

Definition at line 44 of file PyImportAssistant.h.

Referenced by createMultiLayer(), fileNameToOpen(), getPySampleFunctionName(), populateModels(), readFile(), and selectPySampleFunction().

---

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

• /home/www/ba/GUI/coregui/mainwindow/PyImportAssistant.h
• /home/www/ba/GUI/coregui/mainwindow/PyImportAssistant.cpp