DAAbstractNode.h

#ifndef DAABSTRACTNODE_H
#define DAABSTRACTNODE_H
#include <memory>
#include <QMetaEnum>
#include <QVersionNumber>
#include "DAWorkFlowAPI.h"
#include "DANodeMetaData.h"
class QDomElement;
class QDomDocument;
 
namespace DA
{
 
class DAAbstractNodeGraphicsItem;
class DAWorkFlow;
class DAAbstractNodeFactory;
class DAAbstractNodeLinkGraphicsItem;
class DAWORKFLOW_API DAAbstractNode : public std::enable_shared_from_this< DAAbstractNode >
{
    DA_DECLARE_PRIVATE(DAAbstractNode)
    friend class DAAbstractNodeLinkGraphicsItem;
    friend class DAAbstractNodeGraphicsItem;
    friend class DAAbstractNodeFactory;
    friend class DAWorkFlow;
 
public:
    using SharedPointer = std::shared_ptr< DAAbstractNode >;
    using WeakPointer   = std::weak_ptr< DAAbstractNode >;
    using IdType        = uint64_t;
 
public:
    class LinkInfo
    {
    public:
        LinkInfo();
        QString key;                                                     
        QList< QPair< QString, DAAbstractNode::SharedPointer > > nodes;  
    };
 
    enum NodeType
    {
        NormalNode,  
        GlobalNode   
    };
 
public:
    DAAbstractNode();
    virtual ~DAAbstractNode();
 
    // 获取node的名字
    QString getNodeName() const;
    virtual void setNodeName(const QString& name);
 
    // 获取node的类型，这个类型可以表征同一类型的node 这个不会进行翻译
    QString getNodePrototype() const;
    // 获取分组
    QString getNodeGroup() const;
 
    // 获取图标，图标是节点对应的图标
    QIcon getIcon() const;
    void setIcon(const QIcon& icon);
 
    // 获取节点的元数据
    const DANodeMetaData& metaData() const;
    DANodeMetaData& metaData();
 
    // 说明
    QString getNodeTooltip() const;
    void setNodeTooltip(const QString& tp);
 
    // 设置元数据
    void setMetaData(const DANodeMetaData& metadata);
 
    // 返回自身智能指针
    SharedPointer pointer();
    // id操作
    IdType getID() const;
    void setID(const IdType& d);
 
    // 属性操作，如果节点有一些额外属性，通过此函数保存才能存入文件系统中
    bool hasProperty(const QString& k) const;
    void setProperty(const QString& k, const QVariant& v);
    QVariant getProperty(const QString& k, const QVariant& defaultVal = QVariant()) const;
    bool removeProperty(const QString& k);
    QList< QString > getPropertyKeys() const;
    // 属性引用
    const QHash< QString, QVariant >& propertys() const;
    QHash< QString, QVariant >& propertys();
    // 把扩展信息保存到xml上
    virtual void saveExternInfoToXml(QDomDocument* doc, QDomElement* nodeElement, const QVersionNumber& ver) const;
    // 从xml加载扩展信息
    virtual void loadExternInfoFromXml(const QDomElement* nodeElement, const QVersionNumber& ver);
    // 节点类型默认都为NormalNode
    virtual NodeType nodeType() const;
 
public:  // 连接相关
    // 获取所有输入的参数名
    QList< QString > getInputKeys() const;
    // 获取输入节点的数量
    int getInputKeysConut() const;
    // 获取所有已经链接上的输入节点
    QList< QString > getLinkedInputKeys() const;
    // 获取所有输出的参数名
    QList< QString > getOutputKeys() const;
    // 获取输出节点的数量
    int getOutputKeysConut() const;
    // 获取所有已经链接上的输出的参数名
    QList< QString > getLinkedOutputKeys() const;
    // 添加一个输入参数
    void addInputKey(const QString& k);
    // 添加一个输出参数
    void addOutputKey(const QString& k);
    // 建立连接,如果基础的对象需要校验，可继承此函数
    virtual bool linkTo(const QString& outKey, SharedPointer inNode, const QString& inKey);
    // 移除连接,节点对应的连接全部解除
    bool detachLink(const QString& key);
    // 移除连接,节点对应的连接全部解除
    bool detachInputLinks(const QString& key);
    // 移除连接,节点对应的连接全部解除
    bool detachOutputLinks(const QString& key);
    // 移除所有依赖，一般是节点被删除时会调用此函数
    void detachAll();
    // 获取所有连接了输入keys的节点
    QList< SharedPointer > getInputNodes() const;
    QList< SharedPointer > getInputNodes(const QString inputkey) const;
    // 获取此节点输出到其他的节点
    QList< SharedPointer > getOutputNodes() const;
    QList< SharedPointer > getOutputNodes(const QString outputkey) const;
    // 获取输入节点的数量
    int getInputNodesCount() const;
    // 获取输出节点的数量
    int getOutputNodesCount() const;
    // 数据操作
    // 输入参数，in-degree 属性
    void setInputData(const QString& key, const QVariant& dp);
    // 设置输出的参数 out-degree 属性
    void setOutputData(const QString& key, const QVariant& dp);
    // 移除输入
    void removeInputKey(const QString& key);
    void removeAllInputKeys();
    // 移除输出
    void removeOutputKey(const QString& key);
    void removeAllOutputKeys();
    // 获取input的数据包,此函数返回的FCDataPackage是引用，不发生拷贝，修改将直接改变input所维护的FCDataPackage内容
    QVariant getInputData(const QString& key) const;
    // 输出参数
    QVariant getOutputData(const QString& key) const;
    // 获取输入的链接信息
    QList< LinkInfo > getAllInputLinkInfo() const;
    // 获取输出的链接信息
    QList< LinkInfo > getAllOutputLinkInfo() const;
    // 生成一个uint64_t的唯一id
    static IdType generateID();
    // 获取工作流,有可能返回nullptr
    DAWorkFlow* workflow() const;
    // 获取工厂
    std::shared_ptr< DAAbstractNodeFactory > factory() const;
 
    template< typename T >
    std::shared_ptr< T > castTo()
    {
        return std::dynamic_pointer_cast< T >(pointer());
    }
 
public:
    // 执行
    virtual bool exec() = 0;
 
public:
    // 节点对应的item显示接口，所有node都需要提供一个供前端的显示接口
    virtual DAAbstractNodeGraphicsItem* createGraphicsItem() = 0;
 
    // 获取item
    DAAbstractNodeGraphicsItem* graphicsItem() const;
 
protected:
    // 记录item，此函数在DAAbstractNodeGraphicsItem构造函数中调用
    void registItem(DAAbstractNodeGraphicsItem* it);
    // 解除对item的记录
    void unregistItem();
    // linkTo的实现
    bool linkTo_(const QString& outKey, SharedPointer inNode, const QString& inKey);
 
protected:
    // 注册工作流
    void registFactory(const std::shared_ptr< DAAbstractNodeFactory >& fc);
};
#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
DAWORKFLOW_API uint qHash(const std::shared_ptr< DAAbstractNode >& ptr, uint seed = 0) noexcept;
#else
DAWORKFLOW_API std::size_t qHash(const std::shared_ptr< DAAbstractNode >& ptr, std::size_t seed = 0) noexcept;
#endif
}  // end DA
// 为std::shared_ptr<DA::DAAbstractNode>定义qHash
 
Q_DECLARE_METATYPE(std::shared_ptr< DA::DAAbstractNode >)
#endif  // DAABSTRACTNODE_H