EdgeInsertionModule.h

Go to the documentation of this file.

/*
 * $Revision: 2615 $
 *
 * last checkin:
 *   $Author: gutwenger $
 *   $Date: 2012-07-16 14:23:36 +0200 (Mo, 16. Jul 2012) $
 ***************************************************************/

#ifdef _MSC_VER
#pragma once
#endif

#ifndef OGDF_EDGE_INSERTION_MODULE_H
#define OGDF_EDGE_INSERTION_MODULE_H


#include <ogdf/planarity/PlanRepUML.h>
#include <ogdf/basic/Logger.h>
#include <ogdf/basic/Module.h>
#include <ogdf/basic/Timeouter.h>


namespace ogdf {

class OGDF_EXPORT EdgeInsertionModule : public Module, public Timeouter {
public:
    enum RemoveReinsertType {
        rrNone,        
        rrInserted,    
        rrMostCrossed, 
        rrAll,         
        rrIncremental, 
        rrIncInserted  
    };

    EdgeInsertionModule() { }
    // destruction
    virtual ~EdgeInsertionModule() { }

    ReturnType call(PlanRep &PG, const List<edge> &origEdges) {
        return doCall(PG, origEdges, false, 0, 0, 0);
    }

    ReturnType call(PlanRep &PG,
        const EdgeArray<int> &costOrig,
        const List<edge> &origEdges)
    {
        return doCall(PG, origEdges, false, &costOrig, 0, 0);
    }

    ReturnType call(PlanRep &PG,
        const EdgeArray<int> &costOrig,
        const List<edge> &origEdges,
        const EdgeArray<unsigned int> &edgeSubGraph)
    {
        return doCall(PG, origEdges, false, &costOrig, 0, &edgeSubGraph);
    }

    ReturnType call(PlanRep &PG,
        const EdgeArray<bool> &forbidOriginal,
        const List<edge> &origEdges)
    {
        return doCall(PG, origEdges, false, 0, &forbidOriginal, 0);
    }

    ReturnType call(PlanRep &PG,
        const EdgeArray<int>  &costOrig,
        const EdgeArray<bool> &forbidOriginal,
        const List<edge> &origEdges)
    {
        return doCall(PG, origEdges, false, &costOrig, &forbidOriginal, 0);
    }

    // inserts all edges in origEdges into PG using edge costs given by costOrig and edgeSubGraph;
    // explicitly forbids crossing of those original edges for which
    // forbidOriginal[eG] == true; no such edge may be in the list origEdges!
    ReturnType call(PlanRep &PG,
        const EdgeArray<int>  &costOrig,
        const EdgeArray<bool> &forbidOriginal,
        const List<edge> &origEdges,
        const EdgeArray<unsigned int> &edgeSubGraph)
    {
        return doCall(PG, origEdges, false, &costOrig, &forbidOriginal, &edgeSubGraph);
    }

    ReturnType callForbidCrossingGens(PlanRepUML &PG,
        const List<edge> &origEdges)
    {
        return doCall(PG, origEdges, true, 0, 0, 0);
    }

    ReturnType callForbidCrossingGens(PlanRepUML &PG,
        const EdgeArray<int> &costOrig,
        const List<edge> &origEdges)
    {
        return doCall(PG, origEdges, true, &costOrig, 0, 0);
    }

    virtual int runsPostprocessing() const {
        return 0;
    }


#ifdef OGDF_DEBUG
    bool checkCrossingGens(const PlanRepUML &PG);
#endif

protected:
    virtual ReturnType doCall(PlanRep &PG,
        const List<edge> &origEdges,
        bool forbidCrossingGens,
        const EdgeArray<int>  *costOrig,
        const EdgeArray<bool> *forbiddenEdgeOrig,
        const EdgeArray<unsigned int>  *edgeSubGraph) = 0;


    OGDF_MALLOC_NEW_DELETE
};

} // end namespace ogdf

#endif