1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6 Purpose: Manage output of sim parameters to file or stdout
9 ------------- Copyright (C) 1999 Jon S. Berndt (jon@jsbsim.org) -------------
11 This program is free software; you can redistribute it and/or modify it under
12 the terms of the GNU Lesser General Public License as published by the Free Software
13 Foundation; either version 2 of the License, or (at your option) any later
16 This program is distributed in the hope that it will be useful, but WITHOUT
17 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
18 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
21 You should have received a copy of the GNU Lesser General Public License along with
22 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
23 Place - Suite 330, Boston, MA 02111-1307, USA.
25 Further information about the GNU Lesser General Public License can also be found on
26 the world wide web at http://www.gnu.org.
28 FUNCTIONAL DESCRIPTION
29 --------------------------------------------------------------------------------
30 This is the place where you create output routines to dump data for perusal
34 --------------------------------------------------------------------------------
37 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
39 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
42 #include "FGAircraft.h"
43 #include "FGFDMExec.h"
45 #include "input_output/FGfdmSocket.h"
46 #include "input_output/FGXMLElement.h"
56 static const char *IdSrc = "$Id: FGInput.cpp,v 1.19 2010/02/25 05:21:36 jberndt Exp $";
57 static const char *IdHdr = ID_INPUT;
59 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
61 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
63 FGInput::FGInput(FGFDMExec* fdmex) : FGModel(fdmex)
66 sFirstPass = dFirstPass = true;
74 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
82 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
84 bool FGInput::InitModel(void)
86 if (!FGModel::InitModel()) return false;
91 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
93 // This function handles accepting input commands from the socket interface.
96 bool FGInput::Run(void)
99 size_t start=0, string_start=0, string_end=0;
101 FGPropertyManager* node=0;
103 if (FGModel::Run()) return true; // fast exit if nothing to do
104 if (port == 0) return false; // Do nothing here if port not defined
105 // return false if no error
106 // This model DOES execute if "Exec->Holding"
110 data = socket->Receive(); // get socket transmission if present
112 if (data.size() > 0) {
115 string_start = data.find_first_not_of("\r\n", start);
116 if (string_start == string::npos) break;
117 string_end = data.find_first_of("\r\n", string_start);
118 if (string_end == string::npos) break;
119 line = data.substr(string_start, string_end-string_start);
120 if (line.size() == 0) break;
122 // now parse individual line
123 vector <string> tokens = split(line,' ');
125 string command="", argument="", str_value="";
126 if (tokens.size() > 0) {
127 command = to_lower(tokens[0]);
128 if (tokens.size() > 1) {
129 argument = trim(tokens[1]);
130 if (tokens.size() > 2) {
131 str_value = trim(tokens[2]);
136 if (command == "set") { // SET PROPERTY
138 node = PropertyManager->GetNode(argument);
140 socket->Reply("Unknown property\n");
142 value = atof(str_value.c_str());
143 node->setDoubleValue(value);
147 } else if (command == "get") { // GET PROPERTY
149 if (argument.size() == 0) {
150 socket->Reply("No property argument supplied.\n");
154 node = PropertyManager->GetNode(argument);
156 socket->Reply("Badly formed property query\n");
160 if (FDMExec->Holding()) { // if holding can query property list
161 string query = FDMExec->QueryPropertyCatalog(argument);
162 socket->Reply(query);
164 socket->Reply("Must be in HOLD to search properties\n");
166 } else if (node > 0) {
168 buf << argument << " = " << setw(12) << setprecision(6) << node->getDoubleValue() << endl;
169 socket->Reply(buf.str());
172 } else if (command == "hold") { // PAUSE
177 } else if (command == "resume") { // RESUME
182 } else if (command == "quit") { // QUIT
184 // close the socket connection
188 } else if (command == "info") { // INFO
190 // get info about the sim run and/or aircraft, etc.
192 info << "JSBSim version: " << JSBSim_version << endl;
193 info << "Config File version: " << needed_cfg_version << endl;
194 // info << "Aircraft simulated: " << Aircraft->GetAircraftName() << endl;
195 info << "Simulation time: " << setw(8) << setprecision(3) << FDMExec->GetSimTime() << endl;
196 socket->Reply(info.str());
198 } else if (command == "help") { // HELP
201 " JSBSim Server commands:\n\n"
202 " get {property name}\n"
203 " set {property name} {value}\n"
211 socket->Reply(string("Unknown command: ") + token + string("\n"));
223 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
225 bool FGInput::Load(Element* element)
227 string type="", parameter="";
228 string name="", fname="";
231 // if the input has already been set up, print a warning message and return
233 cerr << "An input port has already been assigned for this run" << endl;
237 port = int(element->GetAttributeValueAsNumber("port"));
239 cerr << endl << "No port assigned in input element" << endl;
241 socket = new FGfdmSocket(port);
249 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
250 // The bitmasked value choices are as follows:
251 // unset: In this case (the default) JSBSim would only print
252 // out the normally expected messages, essentially echoing
253 // the config files as they are read. If the environment
254 // variable is not set, debug_lvl is set to 1 internally
255 // 0: This requests JSBSim not to output any messages
257 // 1: This value explicity requests the normal JSBSim
259 // 2: This value asks for a message to be printed out when
260 // a class is instantiated
261 // 4: When this value is set, a message is displayed when a
262 // FGModel object executes its Run() method
263 // 8: When this value is set, various runtime state variables
264 // are printed out periodically
265 // 16: When set various parameters are sanity checked and
266 // a message is printed out when they go out of bounds
268 void FGInput::Debug(int from)
272 if (debug_lvl <= 0) return;
274 if (debug_lvl & 1) { // Standard console startup message output
275 if (from == 0) { // Constructor
280 if (debug_lvl & 2 ) { // Instantiation/Destruction notification
281 if (from == 0) cout << "Instantiated: FGInput" << endl;
282 if (from == 1) cout << "Destroyed: FGInput" << endl;
284 if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
286 if (debug_lvl & 8 ) { // Runtime state variables
288 if (debug_lvl & 16) { // Sanity checking
290 if (debug_lvl & 64) {
291 if (from == 0) { // Constructor
292 cout << IdSrc << endl;
293 cout << IdHdr << endl;