src/FDM/Balloon.h

   1 /*****************************************************************************
   2
   3  Header:       BalloonSimInterface.h
   4  Author:       Christian Mayer
   5  Date started: 07.10.99
   6
   7  -------- Copyright (C) 1999 Christian Mayer (fgfs@christianmayer.de) --------
   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 FUNCTIONAL DESCRIPTION
  27 ------------------------------------------------------------------------------
  28 interface to the the hot air balloon simulator
  29
  30 HISTORY
  31 ------------------------------------------------------------------------------
  32 07.10.1999 Christian Mayer      Created
  33 *****************************************************************************/
  34
  35 /****************************************************************************/
  36 /* SENTRY                                                                   */
  37 /****************************************************************************/
  38 #ifndef BalloonSimInterface_H
  39 #define BalloonSimInterface_H
  40
  41 /****************************************************************************/
  42 /* INCLUDES                                                                 */
  43 /****************************************************************************/
  44 #include <FDM/Balloon/BalloonSim.h>
  45
  46 #include <Aircraft/aircraft.hxx>
  47
  48 #include "flight.hxx"
  49
  50 /****************************************************************************/
  51 /* DEFINES                                                                  */
  52 /****************************************************************************/
  53
  54 /****************************************************************************/
  55 /* DECLARATIONS                                                             */
  56 /****************************************************************************/
  57
  58 // reset flight params to a specific position
  59 // int fgBalloonSimInit(double dt, FGInterface& f);
  60
  61 // update position based on inputs, positions, velocities, etc.
  62 // int fgBalloonSimUpdate(FGInterface& f, int multiloop);
  63
  64 // Convert from the FGInterface struct to the BalloonSim
  65 // int FGInterface_2_fgBalloonSim (FGInterface& f);
  66
  67 // Convert from the BalloonSim to the FGInterface struct
  68 // int fgBalloonSim_2_FGInterface (FGInterface& f);
  69
  70 class FGBalloonSim: public FGInterface {
  71
  72     balloon current_balloon;
  73
  74 public:
  75
  76     // copy FDM state to BalloonSim structures
  77     bool copy_to_BalloonSim();
  78
  79     // copy FDM state from BalloonSim structures
  80     bool copy_from_BalloonSim();
  81
  82     // reset flight params to a specific position
  83     bool init( double dt );
  84
  85     // update position based on inputs, positions, velocities, etc.
  86     bool update( int multiloop );
  87 };
  88
  89
  90 /****************************************************************************/
  91 #endif /*BalloonSimInterface_H*/
  92
  93
  94
  95