Net.hpp

 
#ifndef GYM_PCB_NET_H
#define GYM_PCB_NET_H
 
#include "Defs.hpp"
#include "Color.hpp"
#include "Connection.hpp"
#include "Layer.hpp"
#include <set>
#include <string>
 
class CloneEnv;
class PCBoard;
class Pin;
class NavGrid;
class Track;
 
class Net
{
public:
    Net(const std::string &name);
    ~Net();
    Net *clone(CloneEnv&) const;

    PCBoard *getBoard() const { return mBoard; }
    std::string name() const { return mName; }
    uint id() const { return mId; }
    const Color& getColor() const { return mColor; }
 
    const std::set<Pin *>& getPins() const { return mPins; }
    uint numPins() const { return mPins.size(); }
    bool contains(const Pin *T) const { return mPins.find(const_cast<Pin *>(T)) != mPins.end(); }
    bool empty() const { return mPins.empty(); }
 
    uint numConnections() const { return mConnections.size(); }
    const std::vector<Connection *>& connections() const { return mConnections; }
    Connection *connection(uint i) const { return mConnections.at(i); }
    Connection *getConnectionBetween(const Pin&, const Pin&) const;
 
    // Return if the track is valid for this net (0x1) and board (0x2, if this is not set the track must not be used).
    uint validateTrack(const Track&) const;
 
    Real getMinTrackWidth() const { return mMinTrackWidth; }
    Real getMinClearance() const { return mMinClearance; }
    bool hasViaExtent() const { return mViaHeight != 0; }
    uint getViaStartLayer() const { return mViaStartLayer; }
    uint getViaHeight() const { return mViaHeight; }
    Real getViaDiameter() const { return mViaDiameter; }
    bool buriedViasOK() const { return mBuriedViasOK; }
    uint32_t getLayerMask() const { return mLayerMask; }
    bool isGroundOrPower() const { return mSignalType & SignalType::POWER_GROUND; }
    bool isGround() const { return mSignalType == SignalType::GROUND; }
    SignalType signalType() const { return mSignalType; }
 
    void insert(Pin&);
    void remove(Pin&);
    Connection *addConnection(Pin *sourcePin, const Point_25& source, Pin *targetPin, const Point_25& target);
    void autocreateConnections();
    void sortConnections();
 
    void setMinTrackWidth(Real);
    void setMinClearance(Real c);
    void setViaExtent(uint start, uint h) { mViaStartLayer = start; mViaHeight = h; }
    void setViaDiameter(Real d);
    void setLayerMask(uint32_t m);
    void setLayerMaskFromSignalType();
    void setSignalType(SignalType t) { mSignalType = t; }
 
    static SignalType getLikelySignalTypeForName(const std::string&);
 
    void setBoard(PCBoard *board) { mBoard = board; }
    void setId(uint id);
    void setColor(const Color &c) { mColor = c; }
    void setColorAuto(bool singleColorPerType = false);

    bool extract(Component&);
    bool pruneConnections(std::set<Connection *> &keep);
 
    std::string str() const;
    PyObject *getConnectionsPy(uint depth, bool asNumpy) const;
    PyObject *getPinsPy() const;
    PyObject *getPy(uint depth, bool asNumpy) const;
 
private:
    std::set<Pin *> mPins;
    std::vector<Connection *> mConnections; // These are owned by the net!
    const std::string mName;
    PCBoard *mBoard{0};
    uint mId;
    uint mViaStartLayer{0};
    uint mViaHeight{0};
    bool mBuriedViasOK{false};
    Real mViaDiameter{0.0};
    Real mMinTrackWidth{0.0};
    Real mMinClearance{0.0};
    uint32_t mLayerMask{0xffffffff};
    Color mColor;
    SignalType mSignalType{SignalType::ANY};
 
private:
    void removeConnectionsWithNonmemberPins();
    void rebuildPinSetFromConnections();
};
 
#endif // GYM_PCB_NET_H