GraphNode.hh

Go to the documentation of this file.

/*
    Copyright (c) 2002-2009 Tampere University.
 
    This file is part of TTA-Based Codesign Environment (TCE).
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
    THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
 */
/**
 * @file GraphNode.hh
 *
 * Prototype of graph-based program representation: declaration of graph
 * node.
 *
 * @author Vladimir Guzma 2006 (vladimir.guzma-no.spam-tut.fi)
 * @note rating: red
 */
 
#ifndef TTA_GRAPH_NODE_HH
#define TTA_GRAPH_NODE_HH
 
#include <string>
 
/**
 * Node of the graph-based program representation.
 */
class GraphNode {
public:
    // Client may give specific id. Those ID's must be unique.
    GraphNode(int nodeID) : nodeID_(nodeID) {}
    // Node id is autogenerated on this constructor
    GraphNode();
    virtual ~GraphNode();
 
    virtual GraphNode* clone() const;
 
    inline int nodeID() const;
    virtual std::string toString() const;
    virtual std::string dotString() const;
 
    class Comparator {
    public:
        inline bool operator()(
            const GraphNode* gn1, const GraphNode* gn2) const;
 
    };
private:
    int nodeID_;
    static int idCounter_;
};
 
#include "GraphNode.icc"
 
#endif