ExecObject.h

Go to the documentation of this file.

#pragma once
#pragma warning(disable : 4251)

#include <Core/DocObject.h>

class QMutex;

namespace App
{
class ElementTool;
}


namespace Core
{
class ExecObject;

enum ExecuteStatus
{
    EXECUTE_OK = 0,
    EXECUTE_FAILED = 1
};

class LX_CORE_EXPORT ExecuteError
{
public:
    ExecuteError(Core::DocObject* obj, const std::string& m = "");
    Core::DocObject* obj;
    std::string msg;
};

class LX_CORE_EXPORT ExecuteContext
{
public:
    ExecuteContext(QMutex& aMutex) : mutex(aMutex) {}
    std::vector<Core::ExecuteError> objects_with_errors;
    // Holds an array of error message that are recorded when executing the object
    std::map<Core::DocObject*, std::vector<std::string> > errorMsgPerObject;

    bool throwException_On_Error = true;
    bool checkShape = true;
    bool checkFacetedBrep = false;
    bool checkSliverFaces = false;
    bool printErrorMessage = true;
    bool checkResultFromPolyToAcisConverter = false;  // PolyToAcisConverter has sometimes problems, removing loops etc
    int checkLevel = 20;
    double _tolerance;

#ifdef SWIG
    private:
#endif
    QMutex& mutex;
    void addErrorMsg(Core::DocObject* o, const std::string& msg);
};

class LX_CORE_EXPORT ExecObject : public Core::DocObject
{
    TYPESYSTEM_HEADER();
    LX_NODE_HEADER();
    // PROPERTYCONTAINER_HEADER( Core::ExecObject );

public:
    //                                                       //
    // --------------------- BEGIN API --------------------- //
    //                                                       //
    // ATTENTION: DO NOT CHANGE ANY SIGNATURES IN THE API !  //
    //                                                       //

    friend class ::App::ElementTool;


    virtual Core::ExecuteStatus execute(Core::ExecuteContext* context) = 0;
    bool isExecutable() const { return true; }
    void skipExecution(bool yesno);
    bool skipExecution() const;

    static void getOrderedLinks(const Core::ExecObject* obj, std::vector<Core::ExecObject*>& ordered_links);
    static void getLinks(const Core::ExecObject* obj, std::vector<Core::ExecObject*>& links);

protected:
    ExecObject();
    virtual ~ExecObject();

    //                                                       //
    // ---------------------- END API ---------------------- //
    //                                                       //

#ifndef LXAPI  // INTERFACES BELOW ARE -NOT- PART OF THE LEXOCAD API

private:
    bool _skipExecution;


#endif
};


}  // namespace Core