summaryrefslogtreecommitdiffstats
path: root/src/electronics/wire.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/electronics/wire.h')
-rw-r--r--src/electronics/wire.h64
1 files changed, 64 insertions, 0 deletions
diff --git a/src/electronics/wire.h b/src/electronics/wire.h
new file mode 100644
index 0000000..368004c
--- /dev/null
+++ b/src/electronics/wire.h
@@ -0,0 +1,64 @@
+/***************************************************************************
+ * Copyright (C) 2005 by David Saxton *
+ * *
+ * 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 WIRE_H
+#define WIRE_H
+
+#include <qguardedptr.h>
+#include <qobject.h>
+
+class Pin;
+
+/**
+@author David Saxton
+*/
+class Wire : public QObject
+{
+ public:
+ Wire( Pin * startPin, Pin * endPin );
+ ~Wire();
+
+ /**
+ * Attempts to calculate the current that is flowing through
+ * the connector. Returns true if successfuly, otherwise returns false
+ */
+ bool calculateCurrent();
+ /**
+ * Returns true if the current flowing through the connector is known
+ */
+ bool currentIsKnown() const { return m_bCurrentIsKnown; }
+ /**
+ * Set whether the actual current flowing into this node is known (in some
+ * cases - such as this node being ground - it is not known, and so the
+ * value returned by current() cannot be relied on.
+ */
+ void setCurrentKnown( bool known );
+ /**
+ * Returns the current flowing through the connector.
+ * This only applies for electronic connectors
+ */
+ double current() const { return m_current; }
+ /**
+ * Returns the voltage at the connector. This is an average of the
+ * voltages at either end.
+ */
+ double voltage() const;
+
+ Pin * startPin() const { return m_pStartPin; }
+ Pin * endPin() const { return m_pEndPin; }
+
+ protected:
+ double m_current;
+ bool m_bCurrentIsKnown;
+ QGuardedPtr<Pin> m_pStartPin;
+ QGuardedPtr<Pin> m_pEndPin;
+};
+
+#endif