PowerCircuit.h

Go to the documentation of this file.

/*
 * PowerCircuit.h
 *
 *  Created on: 23.03.2011
 *      Authors: Juern, ArminW
 */


#ifndef POWERCIRCUIT_H_
#define POWERCIRCUIT_H_

namespace PC
{

/*
 * Forward declarations of the main classes
 */
class PowerCircuit;
class Marking;
class Node;

class Node
{
public:
        PowerCircuit*           pc;
        int                                     id;

                                                Node(): pc(NULL), id(-1) {}
                                                Node(PowerCircuit* p, int i): pc(p), id(i) {}
        bool                            isReduced();
        bool                            isDefined();
        Node                            clone();
        int                                     getOrder();
        Marking                         getSuccessorMarking();
        bool                            operator==(Node n);

};

class Marking
{
public:
        PowerCircuit*           pc;
        int                                     id;

                                                Marking(): pc(NULL), id(-1) {}
                                                Marking(PowerCircuit* p, int i);
                                                Marking(const Marking& m);
                                                Marking& operator= (const Marking& rhs);
                                                ~Marking();

        bool                            isReduced();
        Marking                         clone();
        Marking                         copy();
        std::list<Node>         getNodes();
        int                                     getSign(Node n);
        Marking                         operator++(int dummy);
        Marking                         operator-();
        Marking                         operator+(const Marking& m);
        Marking                         operator&(const Marking& m);
        bool                            operator<(const Marking& m);
        bool                            operator>(const Marking& m);
        bool                            operator<=(const Marking& m);
        bool                            operator>=(const Marking& m);
        bool                            operator==(const Marking& m);
        bool                            operator!=(const Marking& m);
        bool                            isSuccessorMarking();
        bool                            isDefined();
        Node                            getIncidentNode();
        Node                            getSmallestNode();
};

class PowerCircuit
{
private:
        // Internal helper methods (these are mostly called by the classes Node and Marking)

        virtual void                    incMarkingRefCount(const Marking& mark) = 0;
        virtual void                    decMarkingRefCount(Marking& mark) = 0;

        virtual Marking                 addMarkings(const Marking& m1, const Marking&  m2) = 0;
        virtual Marking                 invMarking(const Marking& m) = 0;
        virtual Marking                 incMarking(const Marking& m) = 0;
        virtual Marking                 intersectMarkings(const Marking& m1, const Marking&  m2) = 0;
        virtual Marking                 cloneMarking(const Marking& m) = 0;
        virtual Node                    cloneNode(Node n) = 0;
        virtual Marking                 copyMarking(const Marking& m) = 0;
        virtual bool                    isMarkingReduced(const Marking& m) const = 0;
        virtual int                             compareMarkings(const Marking& m1, const Marking&  m2) = 0;
        virtual int                             getRedNodeOrd(Node n) = 0;
        virtual int                             getNodeSignInMarking(Node n, const Marking&  m) const = 0;
        virtual bool                    isSuccessorMarking(const Marking& m) const = 0;
        virtual Node                    getIncidentNode(const Marking& m) = 0;
        virtual Node                    getSmallestNodeInMarking(const Marking& m) = 0;
        virtual Marking                 getSuccMarking(Node n) = 0;


        friend class Node;
        friend class Marking;

public:
        // Construction and destruction
                                                        PowerCircuit() {}
        virtual                                 ~PowerCircuit() {}


        // Operations on power circuit

        virtual void                    reduce() = 0;

        virtual void                    reduce(std::vector<Node>& nodeVector, std::vector<Marking>& markingVector) = 0;

        virtual Marking                 createMarking(int i = 0) = 0;

        virtual Marking                 createMarking(const std::list<Node>& nodes) = 0;

        virtual Marking                 createMarking(const std::list<Node>& nodeList, const std::list<int>& signList) = 0;

        virtual Marking                 createMarkingFromNodes(unsigned int numNodes, ...);

        virtual Node                    createNode(const Marking& succ) = 0;

        virtual void                    connect(const Marking& m, const Marking&  p) = 0;

        virtual void                    connectInv(const Marking& m, const Marking&  p) = 0;

        virtual void                    remove(const Marking& m) = 0;

        virtual Node                    getReducedNode(unsigned int ord) = 0;

        virtual std::list<Node> getNodes() = 0;

        virtual std::list<Marking>      getMarkings() = 0;

        virtual std::list<Node> getMarkingNodes(const Marking& m)  = 0;

        virtual PowerCircuit*   clone(std::vector<Marking>& markingsToClone) = 0;

        virtual void                    draw(std::string filename, Marking highlight1 = Marking(), Marking highlight2 = Marking(), Marking highlight3 = Marking(), Marking highlight4 = Marking(), Marking highlight5 = Marking(), Marking highlight6 = Marking(), Marking highlight7 = Marking(), Marking highlight8 = Marking(), Marking highlight9 = Marking());

        // Statistical data of this power circuit
        int                                     getNumEdges();
        int                                     getNumNodes();
        int                                     getNumMarkings();

        virtual void                    printStatistics(std::ostream& os = std::cout);

        virtual void                    print(std::ostream& os= std::cout) = 0;
};

}

#endif /* POWERCIRCUIT_H_ */