DAWorkFlow.h

#ifndef DAWORKFLOW_H
#define DAWORKFLOW_H
#include <QtCore/qglobal.h>
#include <memory>
#include <QObject>
#include <QVersionNumber>
#include "DAWorkFlowAPI.h"
#include "DAAbstractNode.h"
class QDomDocument;
class QDomElement;
 
namespace DA
{
class DAWorkFlowExecuter;
class DAAbstractNodeFactory;
class DANodeGraphicsScene;
class DAWORKFLOW_API DAWorkFlow : public QObject
{
    Q_OBJECT
    DA_DECLARE_PRIVATE(DAWorkFlow)
    friend class DAAbstractNode;
    friend class DANodeGraphicsScene;
 
public:
    using CallbackPrepareStartExecute = std::function< bool(DAWorkFlowExecuter*) >;
    using CallbackPrepareEndExecute   = std::function< bool(DAWorkFlowExecuter*) >;
 
public:
    DAWorkFlow(QObject* p = nullptr);
    virtual ~DAWorkFlow();
    // 工厂相关
    void registFactory(std::shared_ptr< DAAbstractNodeFactory > factory);
    void registFactorys(const QList< std::shared_ptr< DAAbstractNodeFactory > > factorys);
    // 删除工厂，此函数一般在插件卸载时调用
    void removeFactory(std::shared_ptr< DAAbstractNodeFactory > fac);
    // 获取所有的工厂
    QList< std::shared_ptr< DAAbstractNodeFactory > > getAllFactorys() const;
    // 获取使用到的工厂
    QList< std::shared_ptr< DAAbstractNodeFactory > > usedFactorys() const;
    // 获取工程的数量
    int getFactoryCount() const;
    // 通过工厂名字获取工厂
    std::shared_ptr< DAAbstractNodeFactory > getFactory(const QString& factoryPrototypes);
    // 通过protoType获取DANodeMetaData
    DANodeMetaData getNodeMetaData(const QString& protoType) const;
    // 创建节点，会触发信号nodeCreated,FCWorkFlow保留节点的内存管理权
    DAAbstractNode::SharedPointer createNode(const DANodeMetaData& md);
    // 添加节点
    void addNode(DAAbstractNode::SharedPointer n);
    // 获取节点列表
    QList< DAAbstractNode::SharedPointer > nodes() const;
    // 清空节点
    void clear();
    // 删除节点
    void removeNode(const DAAbstractNode::SharedPointer& n);
    // 是否在workflow存在id
    bool hasNodeID(const DAAbstractNode::IdType id);
    // 通过节点ID获取节点Item
    DAAbstractNode::SharedPointer getNode(const DAAbstractNode::IdType id);
    // 通过节点ID获取节点Item
    DAAbstractNodeGraphicsItem* getNodeGraphicsItem(const DAAbstractNode::IdType id);
    // 把扩展信息保存到xml上
    virtual void saveExternInfoToXml(QDomDocument* doc, QDomElement* nodeElement, const QVersionNumber& ver) const;
    // 从xml加载扩展信息
    virtual void loadExternInfoFromXml(const QDomElement* nodeElement, const QVersionNumber& ver);
    // 设置开始节点
    void setStartNode(DAAbstractNode::SharedPointer p);
    // 获取开始执行的节点
    DAAbstractNode::SharedPointer getStartNode() const;
    // 判断工作量是否再运行
    bool isRunning() const;
    // 工作流中节点的数量
    int size() const;
    // 判断是否为空
    bool isEmpty() const;
    // 获取最后发生的错误信息
    QString getLastErrorString() const;
    // 注册开始执行的回调
    void registStartWorkflowCallback(CallbackPrepareStartExecute fn);
    // 注册开始结束的回调
    void registEndWorkflowCallback(CallbackPrepareEndExecute fn);
    // 获取所有注册的开始回调
    QList< CallbackPrepareStartExecute > getStartWorkflowCallback() const;
    // 获取所有注册的结束回调
    QList< CallbackPrepareEndExecute > getEndWorkflowCallback() const;
    // 获取这个工作流加入的scene
    DANodeGraphicsScene* getScene() const;
    // 触发工作流完成信号
    void callWorkflowReady();
    // 禁止所有工厂回调，这个一般用于文件加载过程，避免回调过多
    // 主要影响以下回调函数nodeAddedToWorkflow,nodeStartRemove,nodeLinkSucceed,nodeLinkDetached
    void disableFactoryCallBack();
    void enableFactoryCallBack();
    bool isEnableFactoryCallBack() const;
public slots:
    // 运行工作流
    void exec();
    // 终止
    void terminate();
 
protected:
    // 主动触发nodeNameChanged信号
    void emitNodeNameChanged(DAAbstractNode::SharedPointer node, const QString& oldName, const QString& newName);
    // 节点id变更通知
    void nodeIDChanged(const DAAbstractNode::SharedPointer& node, const DAAbstractNode::IdType& oldId);
signals:
 
    void nodeAdded(DAAbstractNode::SharedPointer node);
    void nodeStartRemove(DAAbstractNode::SharedPointer node);
    void nodeRemoved(DAAbstractNode::SharedPointer n);
    void workflowReady();
    void nodeNameChanged(DAAbstractNode::SharedPointer node, const QString& oldName, const QString& newName);
    void workflowCleared();
 
    void startExecute();
 
    void terminateExecute();
    void nodeExecuteFinished(DAAbstractNode::SharedPointer n, bool state);
 
    void finished(bool success);
private slots:
 
    // 执行器执行结束
    void onExecuteFinished(bool success);
 
private:
    // 记录工作流对应的scene
    void recordScene(DANodeGraphicsScene* sc);
};
}  // end of namespace DA
#endif  // FCWORKFLOW_H