Port.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 Port.hh
 *
 * Declaration of Port class.
 *
 * @author Lasse Laasonen 2003 (lasse.laasonen-no.spam-tut.fi)
 * @note reviewed 17 Jun 2004 by jn, pj, jm, ll
 * @note rating: red
 */
 
#ifndef TTA_PORT_HH
#define TTA_PORT_HH
 
#include <string>
 
#include "MachinePart.hh"
#include "Exception.hh"
 
class ObjctState;
 
namespace TTAMachine {
 
class Socket;
class Unit;
class RegisterFile;
class FunctionUnit;
 
/**
 * Represents a port between function units and sockets.
 */
class Port : public SubComponent {
public:
    Port(const std::string& name, Unit& parentUnit);
    Port(const ObjectState* state, Unit& parentUnit);
    virtual ~Port();
 
    virtual std::string name() const;
    virtual void setName(const std::string& name);
    virtual int width() const = 0;
    virtual void attachSocket(Socket& socket);
    virtual void detachSocket(Socket& socket);
    virtual void detachAllSockets();
    Unit* parentUnit() const;
    virtual Socket* inputSocket() const;
    virtual Socket* outputSocket() const;
    virtual Socket* unconnectedSocket(int index) const;
    virtual int socketCount() const;
    virtual bool isConnectedTo(const Socket& socket) const;
 
    virtual ObjectState* saveState() const;
    virtual void loadState(const ObjectState* state);
 
    virtual bool isOutput() const;
    virtual bool isInput() const;
 
    /// ObjectState name for Port.
    static const std::string OSNAME_PORT;
    /// ObjectState attribute key for the name of the port.
    static const std::string OSKEY_NAME;
    /// ObjectState attribute key for the name of the connected socket.
    static const std::string OSKEY_FIRST_SOCKET;
    /// ObjectState attribute key for the name of the other connected socket.
    static const std::string OSKEY_SECOND_SOCKET;
 
    struct PairComparator {
        bool operator()(
            const std::pair<const Port*, const Port*>& pp1,
            const std::pair<const Port*, const Port*>& pp2) const;
    };
 
protected:
    Port(const std::string& name, FunctionUnit& parentUnit);
 
private:
    /// Copying forbidden.
    Port(const Port&);
    /// Assingment forbidden.
    Port& operator=(const Port&);
 
    void loadStateWithoutReferences(const ObjectState* state);
    void attachSocket(const std::string& socketName);
 
    /// Name of the port.
    std::string name_;
    /// Parent unit.
    Unit* parentUnit_;
    /// Connection to the first socket.
    Socket* socket1_;
    /// Connection to the second socket.
    Socket* socket2_;
};
}
 
#include "Port.icc"
 
#endif