circuitdocument.h

/***************************************************************************
 *   Copyright (C) 2003-2005 by David Saxton                               *
 *   david@bluehaze.org                                                    *
 *                                                                         *
 *   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 2 of the License, or     *
 *   (at your option) any later version.                                   *
 ***************************************************************************/

#ifndef CIRCUITDOCUMENT_H
#define CIRCUITDOCUMENT_H

#include "icndocument.h"

// TODO: should probably be moved to electronics.

class Circuit;
class Component;
class Connector;
class ECNode;
class Element;
class ICNDocument;
class KTechlab;
class Pin;
class QTimer;
class Switch;
class Wire;

class KActionMenu;

typedef QValueList<Circuit*> CircuitList;
typedef QValueList<Component*> ComponentList;
typedef QValueList<QGuardedPtr<Connector> > ConnectorList;
typedef QValueList<ECNode*> ECNodeList;
typedef QValueList<Element*> ElementList;
typedef QValueList<QGuardedPtr<Pin> > PinList;
typedef QValueList<Switch*> SwitchList;
typedef QValueList<QGuardedPtr<Wire> > WireList;

class Circuitoid
{
public:
        bool contains( Pin *node ) { return pinList.contains(node); }
        bool contains( Wire *con ) { return wireList.contains(con); }
        bool contains( Element *ele ) { return elementList.contains(ele); }
        
        void addPin( Pin *node ) { if (node && !contains(node)) pinList += node; }
        void addWire( Wire *con ) { if (con && !contains(con)) wireList += con; }
        void addElement( Element *ele ) { if (ele && !contains(ele)) elementList += ele; }

        WireList wireList;
        PinList pinList;
        ElementList elementList;
};

class CircuitDocument : public ICNDocument
{
        Q_OBJECT
        public:
                CircuitDocument( const QString &caption, KTechlab *ktechlab, const char *name = 0 );
                ~CircuitDocument();
        
                virtual View *createView( ViewContainer *viewContainer, uint viewAreaId, const char *name = 0 );
        
                void calculateConnectorCurrents();
                int countExtCon( const ItemList &cnItemList ) const;
                
                virtual void update();
        
        public slots:
                void createSubcircuit();
                void displayEquations();
                void setOrientation0();
                void setOrientation90();
                void setOrientation180();
                void setOrientation270();
                void rotateCounterClockwise();
                void rotateClockwise();
                void itemFlip();
                virtual void slotInitItemActions( Item *item = 0 );
                void requestAssignCircuits();
                void componentAdded( Item * item );
                void componentRemoved( Item * item );
                void connectorAdded( Connector * connector );
                virtual void slotUpdateConfiguration();
        
        protected:
                virtual void itemAdded( Item * item );
                virtual void fillContextMenu( const QPoint &pos );
                virtual bool isValidItem( Item *item );
                virtual bool isValidItem( const QString &itemId );
                
                KActionMenu * m_pOrientationAction;
        
        private slots:
                void assignCircuits();
        
        private:
                bool tryAsLogicCircuit( Circuitoid *circuitoid );
                Circuit *createCircuit( Circuitoid *circuitoid );
                void getPartition( Pin * pin, PinList * pinList, PinList * unassignedPins, bool onlyGroundDependent = false );
                void splitIntoCircuits( PinList * pinList );
                void recursivePinAdd( Pin * pin, Circuitoid *circuitoid, PinList * unassignedPins );
                void deleteCircuits();
        
                QTimer *m_updateCircuitsTmr;
                CircuitList m_circuitList;
                ComponentList m_toSimulateList;
                ComponentList m_componentList; // List is built up during call to assignCircuits
                PinList m_pinList;
                WireList m_wireList;
                SwitchList m_switchList;
};

#endif

---