NetlistNet.hpp

Go to the documentation of this file.

// Torc - Copyright 2011-2013 University of Southern California.  All Rights Reserved.
// $HeadURL$
// $Id$

// This program is free software: you can redistribute it and/or modify it under the terms of the 
// GNU General Public License as published by the Free Software Foundation, either version 3 of the 
// License, or (at your option) any later version.
// 
// This program 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.  See 
// the GNU General Public License for more details.
// 
// You should have received a copy of the GNU General Public License along with this program.  If 
// not, see <http://www.gnu.org/licenses/>.

#ifndef TORC_PLACER_NETLISTNET_HPP
#define TORC_PLACER_NETLISTNET_HPP

#include <vector>
#include <string>
#include "torc/placer/NetlistPin.hpp"
#include "torc/physical/XilinxPhysicalTypes.hpp"

namespace torc {
namespace placer {
    class NetlistPin;

    class NetlistNet {
    // types
        typedef physical::ENetType ENetType;
        typedef boost::uint32_t uint32;
    protected:
        uint32 mIndex;
        std::string mName;
        ENetType mType;
        std::vector<NetlistPin*> mSources;
        std::vector<NetlistPin*> mSinks;
        
    public:
        NetlistNet(std::string inName, ENetType inType, uint32 inIndex) : 
            mIndex(inIndex), mName(inName), mType(inType) {}
        ~NetlistNet() {}
        uint32 addSource(NetlistPin* newPin) {
            uint32 index = mSources.size();
            mSources.push_back(newPin);
            return index;
        }
        uint32 addSink(NetlistPin* newPin) {
            uint32 index = mSinks.size();
            mSinks.push_back(newPin);
            return index;
        }
        uint32 getNumSources() {
            return mSources.size();
        }
        uint32 getNumSinks() {
            return mSinks.size();
        }
        NetlistPin* getSource(uint32 i) {
            return mSources[i];
        }
        NetlistPin* getSink(uint32 i) {
            return mSinks[i];
        }
        std::string& getName() {
            return mName;
        }
        ENetType getType() {
            return mType;
        }
        uint32 getIndex() {
            return mIndex;
        }
    }; //class NetlistNet
    
    typedef std::vector<NetlistNet*> NetlistNetPtrVector;
} // namespace placer
} // namespace torc
#endif // TORC_PLACER_NETLISTNET_HPP