1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7 ------------- Copyright (C) 2000 -------------
9 This program is free software; you can redistribute it and/or modify it under
10 the terms of the GNU Lesser General Public License as published by the Free Software
11 Foundation; either version 2 of the License, or (at your option) any later
14 This program is distributed in the hope that it will be useful, but WITHOUT
15 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
19 You should have received a copy of the GNU Lesser General Public License along with
20 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
21 Place - Suite 330, Boston, MA 02111-1307, USA.
23 Further information about the GNU Lesser General Public License can also be found on
24 the world wide web at http://www.gnu.org.
26 FUNCTIONAL DESCRIPTION
27 --------------------------------------------------------------------------------
30 --------------------------------------------------------------------------------
32 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
33 COMMENTS, REFERENCES, and NOTES
34 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
36 The switch component is defined as follows (see the API documentation for more
40 <switch name="switch1">
41 <default value="{property|value}"/>
42 <test logic="{AND|OR}" value="{property|value}">
43 {property} {conditional} {property|value}
44 <test logic="{AND|OR}">
45 {property} {conditional} {property|value}
50 <test logic="{AND|OR}" value="{property|value}">
51 {property} {conditional} {property|value}
58 Also, see the header file (FGSwitch.h) for further details.
60 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
62 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
68 static const char *IdSrc = "$Id$";
69 static const char *IdHdr = ID_SWITCH;
71 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
73 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
75 FGSwitch::FGSwitch(FGFCS* fcs, Element* element) : FGFCSComponent(fcs, element)
78 struct test *current_test;
79 Element *test_element, *condition_element;
81 FGFCSComponent::bind(); // Bind() this component here in case it is used
82 // in its own definition for a sample-and-hold
84 test_element = element->GetElement();
85 while (test_element) {
86 if (test_element->GetName() == "default") {
87 current_test = new struct test;
88 current_test->Logic = eDefault;
89 tests.push_back(current_test);
90 } else if (test_element->GetName() == "test") { // here's a test
91 current_test = new struct test;
92 logic = test_element->GetAttributeValue("logic");
93 if (logic == "OR") current_test->Logic = eOR;
94 else if (logic == "AND") current_test->Logic = eAND;
95 else if (logic.size() == 0) current_test->Logic = eAND; // default
97 cerr << "Unrecognized LOGIC token " << logic << " in switch component: " << Name << endl;
99 for (unsigned int i=0; i<test_element->GetNumDataLines(); i++) {
100 string input_data = test_element->GetDataLine(i);
101 if (input_data.size() <= 1) {
102 // Make sure there are no bad data lines that consist solely of whitespace
103 cerr << fgred << " Bad data line in switch component: " << Name << reset << endl;
106 current_test->conditions.push_back(new FGCondition(input_data, PropertyManager));
109 condition_element = test_element->GetElement(); // retrieve condition groups
110 while (condition_element) {
111 current_test->conditions.push_back(new FGCondition(condition_element, PropertyManager));
112 condition_element = test_element->GetNextElement();
115 tests.push_back(current_test);
118 if (test_element->GetName() != "output"
119 && test_element->GetName() != "description") { // this is not an output element
120 value = test_element->GetAttributeValue("value");
122 cerr << "No VALUE supplied for switch component: " << Name << endl;
124 if (is_number(value)) {
125 current_test->OutputVal = atof(value.c_str());
127 // "value" must be a property if execution passes to here.
128 if (value[0] == '-') {
129 current_test->sign = -1.0;
132 current_test->sign = 1.0;
134 current_test->OutputProp = PropertyManager->GetNode(value);
138 test_element = element->GetNextElement();
144 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
146 FGSwitch::~FGSwitch()
148 for (unsigned int i=0; i<tests.size(); i++) {
149 for (unsigned int j=0; j<tests[i]->conditions.size(); j++) delete tests[i]->conditions[j];
156 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
158 bool FGSwitch::Run(void )
161 double default_output=0.0;
163 for (unsigned int i=0; i<tests.size(); i++) {
164 if (tests[i]->Logic == eDefault) {
165 default_output = tests[i]->GetValue();
166 } else if (tests[i]->Logic == eAND) {
168 for (unsigned int j=0; j<tests[i]->conditions.size(); j++) {
169 if (!tests[i]->conditions[j]->Evaluate()) pass = false;
171 } else if (tests[i]->Logic == eOR) {
173 for (unsigned int j=0; j<tests[i]->conditions.size(); j++) {
174 if (tests[i]->conditions[j]->Evaluate()) pass = true;
177 cerr << "Invalid logic test" << endl;
181 Output = tests[i]->GetValue();
186 if (!pass) Output = default_output;
189 if (IsOutput) SetOutput();
194 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
195 // The bitmasked value choices are as follows:
196 // unset: In this case (the default) JSBSim would only print
197 // out the normally expected messages, essentially echoing
198 // the config files as they are read. If the environment
199 // variable is not set, debug_lvl is set to 1 internally
200 // 0: This requests JSBSim not to output any messages
202 // 1: This value explicity requests the normal JSBSim
204 // 2: This value asks for a message to be printed out when
205 // a class is instantiated
206 // 4: When this value is set, a message is displayed when a
207 // FGModel object executes its Run() method
208 // 8: When this value is set, various runtime state variables
209 // are printed out periodically
210 // 16: When set various parameters are sanity checked and
211 // a message is printed out when they go out of bounds
213 void FGSwitch::Debug(int from)
215 string comp, scratch;
219 if (debug_lvl <= 0) return;
221 if (debug_lvl & 1) { // Standard console startup message output
222 if (from == 0) { // Constructor
223 for (unsigned int i=0; i<tests.size(); i++) {
227 switch(tests[i]->Logic) {
230 cerr << "Unset logic for test condition" << endl;
239 scratch = " by default.";
243 cerr << "Unknown logic for test condition" << endl;
246 if (tests[i]->OutputProp != 0L)
247 if (tests[i]->sign < 0)
248 cout << indent << "Switch VALUE is - " << tests[i]->OutputProp->GetName() << scratch << endl;
250 cout << indent << "Switch VALUE is " << tests[i]->OutputProp->GetName() << scratch << endl;
252 cout << indent << "Switch VALUE is " << tests[i]->OutputVal << scratch << endl;
255 for (unsigned int j=0; j<tests[i]->conditions.size(); j++) {
256 if (!first) cout << indent << comp << " ";
257 else cout << indent << " ";
259 tests[i]->conditions[j]->PrintCondition();
265 for (unsigned int i=0; i<OutputNodes.size(); i++)
266 cout << " OUTPUT: " << OutputNodes[i]->getName() << endl;
270 if (debug_lvl & 2 ) { // Instantiation/Destruction notification
271 if (from == 0) cout << "Instantiated: FGSwitch" << endl;
272 if (from == 1) cout << "Destroyed: FGSwitch" << endl;
274 if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
276 if (debug_lvl & 8 ) { // Runtime state variables
278 if (debug_lvl & 16) { // Sanity checking
280 if (debug_lvl & 64) {
281 if (from == 0) { // Constructor
282 cout << IdSrc << endl;
283 cout << IdHdr << endl;