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/misc/props.hxx>
42 #include <Main/fgfs.hxx>
49 #define FG_CONNECTOR 3
51 // Base class for other electrical components
52 class FGElectricalComponent {
56 typedef vector<FGElectricalComponent *> comp_list;
57 typedef vector<string> string_list;
69 FGElectricalComponent();
70 virtual ~FGElectricalComponent() {}
72 inline string get_name() { return name; }
73 inline string get_prop() { return prop; }
75 inline int get_kind() const { return kind; }
76 inline double get_value() const { return value; }
77 inline void set_value( double val ) { value = val; }
79 inline int get_num_outputs() const { return outputs.size(); }
80 inline FGElectricalComponent *get_output( const int i ) {
83 inline void add_output( FGElectricalComponent *c ) {
84 outputs.push_back( c );
87 inline int get_num_inputs() const { return outputs.size(); }
88 inline FGElectricalComponent *get_input( const int i ) {
91 inline void add_input( FGElectricalComponent *c ) {
92 inputs.push_back( c );
97 // Electrical supplier
98 class FGElectricalSupplier : public FGElectricalComponent {
100 SGPropertyNode_ptr _rpm_node;
102 enum FGSupplierType {
114 FGElectricalSupplier ( string _name, string _prop, string _model,
115 double _volts, double _amps );
116 ~FGElectricalSupplier () {}
122 // Electrical bus (can take multiple inputs and provide multiple
124 class FGElectricalBus : public FGElectricalComponent {
128 FGElectricalBus ( string _name, string _prop );
129 ~FGElectricalBus () {}
133 // A lot like an FGElectricalBus, but here for convenience and future
135 class FGElectricalOutput : public FGElectricalComponent {
139 FGElectricalOutput ( string _name, string _prop );
140 ~FGElectricalOutput () {}
144 // Connects multiple sources to multiple destinations with optional
145 // switches/fuses/circuit breakers inline
146 class FGElectricalConnector : public FGElectricalComponent {
150 typedef vector<SGPropertyNode *> switch_list;
151 switch_list switches;
155 FGElectricalConnector ();
156 ~FGElectricalConnector () {}
158 void add_switch( SGPropertyNode *node ) {
159 switches.push_back( node );
167 * Model an electrical system. This is a simple system with the
168 * alternator hardwired to engine[0]/rpm
172 * /engines/engine[0]/rpm
179 class FGElectricalSystem : public FGSubsystem
184 FGElectricalSystem ();
185 virtual ~FGElectricalSystem ();
187 virtual void init ();
188 virtual void bind ();
189 virtual void unbind ();
190 virtual void update (double dt);
193 void propogate( FGElectricalComponent *node, double val, string s = "" );
194 FGElectricalComponent *find ( const string &name );
198 typedef vector<FGElectricalComponent *> comp_list;
202 SGPropertyNode *config_props;
209 comp_list connectors;
213 #endif // _SYSTEMS_ELECTRICAL_HXX