hyperedge.h

Go to the documentation of this file.

/*
 * vim: ts=4 sw=4 et tw=0 wm=0
 *
 * libavoid - Fast, Incremental, Object-avoiding Line Router
 *
 * Copyright (C) 2011-2015  Monash University
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * See the file LICENSE.LGPL distributed with the library.
 *
 * Licensees holding a valid commercial license may use this file in
 * accordance with the commercial license agreement provided with the 
 * library.
 *
 * This library 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.  
 *
 * Author(s):   Michael Wybrow
*/


#ifndef AVOID_HYPEREDGE_H
#define AVOID_HYPEREDGE_H

#include <cstdio>
#include <list>
#include <vector>
#include <set>

#include "libavoid/dllexport.h"

namespace Avoid {

class ConnRef;
class JunctionRef;
class Router;
class ConnEnd;
class VertInf;

typedef std::list<ConnEnd> ConnEndList;

typedef std::list<ConnRef *> ConnRefList;

typedef std::list<JunctionRef *> JunctionRefList;

typedef std::list<VertInf *> VertexList;
typedef std::set<ConnRef *> ConnRefSet;
typedef std::set<VertInf *> VertexSet;

typedef std::vector<JunctionRef *> JunctionRefVector;
typedef std::vector<ConnEndList> ConnEndListVector;
typedef std::vector<ConnRefList> ConnRefListVector;
typedef std::vector<JunctionRefList> JunctionRefListVector;
typedef std::vector<VertexSet> VertexSetVector;

struct HyperedgeNewAndDeletedObjectLists
{
        JunctionRefList  newJunctionList;

        ConnRefList      newConnectorList;
        
        JunctionRefList  deletedJunctionList;

        ConnRefList      deletedConnectorList;
        
        ConnRefList      changedConnectorList;
};


class AVOID_EXPORT HyperedgeRerouter
{
    public:
        HyperedgeRerouter();
        
        size_t registerHyperedgeForRerouting(ConnEndList terminals);

        size_t registerHyperedgeForRerouting(JunctionRef *junction);

        HyperedgeNewAndDeletedObjectLists newAndDeletedObjectLists(
                size_t index) const;

        // @brief  The number of hyperedges that are being or have been
        //         rerouted.
        // @return The number of rerouted hyperedges.
        //
        size_t count(void) const;

    private:
        friend class Router;

        // @brief  Sets the router instance that this object operates on.
        //
        // @param[in] router  The router instance to operate on.
        //
        void setRouter(Router *router);

        ConnRefSet calcHyperedgeConnectors(void);
        // Called by Router during processTransaction().
        void performRerouting(void);
        void outputInstanceToSVG(FILE *fp);
        bool findAttachedObjects(size_t index, ConnRef *connector,
                JunctionRef *ignore, ConnRefSet& hyperedgeConns);
        bool findAttachedObjects(size_t index, JunctionRef *junction,
                ConnRef *ignore, ConnRefSet& hyperedgeConns);

        Router *m_router;
        ConnEndListVector m_terminals_vector;
        JunctionRefVector m_root_junction_vector;
        JunctionRefListVector m_new_junctions_vector;
        JunctionRefListVector m_deleted_junctions_vector;
        ConnRefListVector m_new_connectors_vector;
        ConnRefListVector m_deleted_connectors_vector;
        VertexSetVector m_terminal_vertices_vector;
        VertexList m_added_vertices;
};


}

#endif