src/FDM/JSBSim/FGConfigFile.h

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Header:       FGConfigFile.h
   4  Author:       Jon Berndt
   5  Date started: 03/29/00
   6
   7  ------------- Copyright (C) 1999  Jon S. Berndt (jsb@hal-pc.org) -------------
   8
   9  This program is free software; you can redistribute it and/or modify it under
  10  the terms of the GNU General Public License as published by the Free Software
  11  Foundation; either version 2 of the License, or (at your option) any later
  12  version.
  13
  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 General Public License for more
  17  details.
  18
  19  You should have received a copy of the GNU 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.
  22
  23  Further information about the GNU General Public License can also be found on
  24  the world wide web at http://www.gnu.org.
  25
  26 HISTORY
  27 --------------------------------------------------------------------------------
  28 03/29/00   JSB   Created
  29
  30 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  31 SENTRY
  32 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  33
  34 #ifndef FGCONFIGFILE_H
  35 #define FGCONFIGFILE_H
  36
  37 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  38 INCLUDES
  39 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  40
  41 #ifdef FGFS
  42 #  include <simgear/compiler.h>
  43 #  include STL_STRING
  44 #  include STL_FSTREAM
  45 #  include STL_IOSTREAM
  46    SG_USING_STD(string);
  47    SG_USING_STD(ostream);
  48    SG_USING_STD(istream);
  49    SG_USING_STD(ifstream);
  50    SG_USING_STD(cerr);
  51    SG_USING_STD(endl);
  52    SG_USING_STD(ios);
  53    SG_USING_STD(cout);
  54 #else
  55 #  include <fstream>
  56 #  include <iostream>
  57 #  include <string>
  58    using std::string;
  59    using std::ostream;
  60    using std::istream;
  61    using std::ifstream;
  62    using std::ios;
  63    using std::cerr;
  64    using std::endl;
  65    using std::cout;
  66 #endif
  67
  68 #include "FGDefs.h"
  69
  70 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  71 DEFINITIONS
  72 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  73
  74 #define ID_CONFIGFILE "$Id$"
  75
  76 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  77 FORWARD DECLARATIONS
  78 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  79
  80 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  81 COMMENTS, REFERENCES, and NOTES [use "class documentation" below for API docs]
  82 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  83
  84 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  85 CLASS DOCUMENTATION
  86 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  87
  88 /** Encapsulates reading a JSBSim config file.
  89     JSBSim config files are in XML format.
  90     @author Jon S. Berndt
  91     @version $Id$
  92     @see -
  93 */
  94
  95 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  96 CLASS DECLARATION
  97 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  98
  99 class FGConfigFile
 100 {
 101 public:
 102   /** Constructor
 103       @param Filename the name of the config file to be read. */
 104   FGConfigFile(string Filename);
 105   /// Destructor
 106   ~FGConfigFile();
 107
 108   string GetLine(void);
 109   string GetNextConfigLine(void);
 110   string GetValue(string);
 111   string GetValue(void);
 112   bool IsCommentLine(void);
 113   bool IsOpen(void) {return Opened;}
 114   FGConfigFile& operator>>(double&);
 115   FGConfigFile& operator>>(float&);
 116   FGConfigFile& operator>>(int&);
 117   FGConfigFile& operator>>(string&);
 118   FGConfigFile& operator>>(eParam&);
 119   void ResetLineIndexToZero(void);
 120
 121 private:
 122   ifstream cfgfile;
 123   string   CurrentLine;
 124   bool     CommentsOn;
 125   bool     Opened;
 126   unsigned int      CurrentIndex;
 127   void Debug(void);
 128 };
 129
 130 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 131 #endif
 132