1 // electrical.hxx - a flexible, generic electrical system model.
3 // Written by Curtis Olson, started September 2002.
5 // Copyright (C) 2002 Curtis L. Olson - curt@flightgear.org
7 // This program is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU General Public License as
9 // published by the Free Software Foundation; either version 2 of the
10 // License, or (at your option) any later version.
12 // This program is distributed in the hope that it will be useful, but
13 // WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 // General Public License for more details.
17 // You should have received a copy of the GNU General Public License
18 // along with this program; if not, write to the Free Software
19 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 #ifndef _SYSTEMS_ELECTRICAL_HXX
25 #define _SYSTEMS_ELECTRICAL_HXX 1
28 # error This library requires C++
41 #include <simgear/props/props.hxx>
43 #include <Main/fgfs.hxx>
46 // Forward declaration
47 class FGElectricalSystem;
54 #define FG_CONNECTOR 3
56 // Base class for other electrical components
57 class FGElectricalComponent {
61 typedef vector<FGElectricalComponent *> comp_list;
62 typedef vector<string> string_list;
74 FGElectricalComponent();
75 virtual ~FGElectricalComponent() {}
77 inline string get_name() { return name; }
79 inline int get_kind() const { return kind; }
80 inline double get_value() const { return value; }
81 inline void set_value( double val ) { value = val; }
83 inline int get_num_inputs() const { return outputs.size(); }
84 inline FGElectricalComponent *get_input( const int i ) {
87 inline void add_input( FGElectricalComponent *c ) {
88 inputs.push_back( c );
91 inline int get_num_outputs() const { return outputs.size(); }
92 inline FGElectricalComponent *get_output( const int i ) {
95 inline void add_output( FGElectricalComponent *c ) {
96 outputs.push_back( c );
99 inline int get_num_props() const { return props.size(); }
100 inline string get_prop( const int i ) {
103 inline void add_prop( const string &s ) {
104 props.push_back( s );
110 // Electrical supplier
111 class FGElectricalSupplier : public FGElectricalComponent {
113 SGPropertyNode_ptr _rpm_node;
115 enum FGSupplierType {
128 FGElectricalSupplier ( SGPropertyNode *node );
129 ~FGElectricalSupplier () {}
135 // Electrical bus (can take multiple inputs and provide multiple
137 class FGElectricalBus : public FGElectricalComponent {
141 FGElectricalBus ( SGPropertyNode *node );
142 ~FGElectricalBus () {}
146 // A lot like an FGElectricalBus, but here for convenience and future
148 class FGElectricalOutput : public FGElectricalComponent {
152 FGElectricalOutput ( SGPropertyNode *node );
153 ~FGElectricalOutput () {}
157 // Connects multiple sources to multiple destinations with optional
158 // switches/fuses/circuit breakers inline
159 class FGElectricalConnector : public FGElectricalComponent {
163 typedef vector<SGPropertyNode *> switch_list;
164 switch_list switches;
168 FGElectricalConnector ( SGPropertyNode *node, FGElectricalSystem *es );
169 ~FGElectricalConnector () {}
171 void add_switch( SGPropertyNode *node ) {
172 switches.push_back( node );
175 // set all switches to the specified state
176 void set_switches( bool state );
183 * Model an electrical system. This is a fairly simplistic system
187 class FGElectricalSystem : public FGSubsystem
192 FGElectricalSystem ();
193 virtual ~FGElectricalSystem ();
195 virtual void init ();
196 virtual void bind ();
197 virtual void unbind ();
198 virtual void update (double dt);
201 void propagate( FGElectricalComponent *node, double val, string s = "" );
202 FGElectricalComponent *find ( const string &name );
206 typedef vector<FGElectricalComponent *> comp_list;
210 SGPropertyNode *config_props;
217 comp_list connectors;
221 #endif // _SYSTEMS_ELECTRICAL_HXX