GraphStructure.h

Go to the documentation of this file.

/*
    This file is part of Rocs.
    Copyright 2011       Tomaz Canabrava <tomaz.canabrava@gmail.com>
    Copyright 2011       Wagner Reck <wagner.reck@gmail.com>
    Copyright 2011-2012  Andreas Cord-Landwehr <cola@uni-paderborn.de>

    This program is free software; you can redistribute it and/or
    modify it under the terms of the GNU General Public License as
    published by the Free Software Foundation; either version 2 of
    the License, or (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef GRAPHSTRUCTURE_H
#define GRAPHSTRUCTURE_H

#include "rocs_graphstructure_export.h"
#include "DataStructure.h"

namespace Rocs
{
class ROCS_GRAPHSTRUCTURE_EXPORT GraphStructure : public DataStructure
{
    Q_OBJECT
    Q_PROPERTY(QString name READ name WRITE setName)

public:
    typedef enum {
        Graph,
        Multigraph
    } GRAPH_TYPE;

    //to avoid hide some methods
    using DataStructure::remove;
    using DataStructure::createPointer;
    using DataStructure::createData;

    static DataStructurePtr create(Document *parent);
    static DataStructurePtr create(DataStructurePtr other, Document *parent);

    explicit GraphStructure(Document* parent = 0);
    ~GraphStructure();
    void importStructure(DataStructurePtr other);

    PointerPtr createPointer(DataPtr from, DataPtr to, int pointerType);

    DataPtr createData(const QString& name, int dataType);

    GRAPH_TYPE graphType() const;

    bool multigraph() const;

    QMap<QString, QString> pluginProperties() const;

    void setPluginProperty(const QString& identifier, const QString& property);

    QMap<DataPtr,PointerList> dijkstraShortestPaths(DataPtr from);

    Q_INVOKABLE QScriptValue nodes();

    Q_INVOKABLE QScriptValue nodes(int type);

    Q_INVOKABLE QScriptValue edges();

    Q_INVOKABLE QScriptValue edges(int type);

    Q_INVOKABLE QScriptValue createNode(int type);

    Q_INVOKABLE QScriptValue createNode();

    Q_INVOKABLE QScriptValue createEdge(Data* fromRaw, Data* toRaw, int type);

    Q_INVOKABLE QScriptValue createEdge(Data* fromRaw, Data* toRaw);


public slots:
    void setGraphType(int type);

    QScriptValue list_nodes();

    QScriptValue list_nodes(int type);

    QScriptValue list_edges();

    QScriptValue list_edges(int type);

    QScriptValue overlay_edges(int overlay);

    QScriptValue add_node(const QString& name);

    QScriptValue add_overlay_edge(Data* fromRaw, Data* toRaw, int overlay);

    QScriptValue add_edge(Data* fromRaw, Data* toRaw);

    QScriptValue dijkstra_shortest_path(Data* fromRaw, Data* toRaw);

    QScriptValue distances(Data* fromRaw);

private:
    GraphStructure::GRAPH_TYPE _type;
};
}
#endif // GRAPHSTRUCTURE_H