-/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%\r
-\r
- Header: FGEngine.h\r
- Author: Jon S. Berndt\r
- Date started: 01/21/99\r
-\r
- ------------- Copyright (C) 1999 Jon S. Berndt (jsb@hal-pc.org) -------------\r
-\r
- This program is free software; you can redistribute it and/or modify it under\r
- the terms of the GNU General Public License as published by the Free Software\r
- Foundation; either version 2 of the License, or (at your option) any later\r
- version.\r
-\r
- This program is distributed in the hope that it will be useful, but WITHOUT\r
- ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
- FOR A PARTICULAR PURPOSE. See the GNU General Public License for more\r
- details.\r
-\r
- You should have received a copy of the GNU General Public License along with\r
- this program; if not, write to the Free Software Foundation, Inc., 59 Temple\r
- Place - Suite 330, Boston, MA 02111-1307, USA.\r
-\r
- Further information about the GNU General Public License can also be found on\r
- the world wide web at http://www.gnu.org.\r
-\r
-FUNCTIONAL DESCRIPTION\r
---------------------------------------------------------------------------------\r
-\r
-Based on Flightgear code, which is based on LaRCSim. This class simulates\r
-a generic engine.\r
-\r
-HISTORY\r
---------------------------------------------------------------------------------\r
-01/21/99 JSB Created\r
-\r
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%\r
-SENTRY\r
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/\r
-\r
-#ifndef FGENGINE_H\r
-#define FGENGINE_H\r
-\r
-/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%\r
-INCLUDES\r
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/\r
-\r
-#ifdef FGFS\r
-# include <simgear/compiler.h>\r
-# include STL_STRING\r
- SG_USING_STD(string);\r
-# ifdef SG_HAVE_STD_INCLUDES\r
-# include <vector>\r
-# else\r
-# include <vector.h>\r
-# endif\r
-#else\r
-# include <vector>\r
-# include <string>\r
-#endif\r
-\r
-#include "FGJSBBase.h"\r
-\r
-/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%\r
-DEFINITIONS\r
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/\r
-\r
-#define ID_ENGINE "$Id$"\r
-\r
-using std::string;\r
-\r
-/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%\r
-FORWARD DECLARATIONS\r
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/\r
-\r
-class FGFDMExec;\r
-class FGState;\r
-class FGAtmosphere;\r
-class FGFCS;\r
-class FGAircraft;\r
-class FGTranslation;\r
-class FGRotation;\r
-class FGPropulsion;\r
-class FGPosition;\r
-class FGAuxiliary;\r
-class FGOutput;\r
-\r
-using std::vector;\r
-\r
-/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%\r
-COMMENTS, REFERENCES, and NOTES [use "class documentation" below for API docs]\r
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/\r
-\r
-/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%\r
-CLASS DOCUMENTATION\r
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/\r
-\r
-/** Base class for all engines.\r
- This base class contains methods and members common to all engines, such as\r
- logic to drain fuel from the appropriate tank, etc.\r
- @author Jon S. Berndt\r
- @version $Id$ \r
-*/\r
-\r
-/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%\r
-CLASS DECLARATION\r
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/\r
-\r
-class FGEngine : public FGJSBBase\r
-{\r
-public:\r
- FGEngine(FGFDMExec* exec);\r
- virtual ~FGEngine();\r
-\r
- enum EngineType {etUnknown, etRocket, etPiston, etTurboProp, etTurboJet, etTurboShaft};\r
-\r
- virtual float GetThrottleMin(void) { return MinThrottle; }\r
- virtual float GetThrottleMax(void) { return MaxThrottle; }\r
- float GetThrottle(void) { return Throttle; }\r
- float GetMixture(void) { return Mixture; }\r
- int GetMagnetos(void) { return Magnetos; }\r
- bool GetStarter(void) { return Starter; }\r
- float GetThrust(void) { return Thrust; }\r
- bool GetStarved(void) { return Starved; }\r
- bool GetFlameout(void) { return Flameout; }\r
- bool GetRunning(void) { return Running; }\r
- bool GetCranking(void) { return Cranking; }\r
- int GetType(void) { return Type; }\r
- string GetName(void) { return Name; }\r
-\r
- virtual float getManifoldPressure_inHg () const {\r
- return ManifoldPressure_inHg;\r
- }\r
- virtual float getExhaustGasTemp_degF () const {\r
- return (ExhaustGasTemp_degK - 273) * (9.0 / 5.0) + 32.0;\r
- }\r
- virtual float getCylinderHeadTemp_degF () const {\r
- return (CylinderHeadTemp_degK - 273) * (9.0 / 5.0) + 32.0;\r
- }\r
- virtual float getOilPressure_psi () const {\r
- return OilPressure_psi;\r
- }\r
- virtual float getOilTemp_degF () const {\r
- return (OilTemp_degK - 273.0) * (9.0 / 5.0) + 32.0;\r
- }\r
-\r
- void SetStarved(bool tt) {Starved = tt;}\r
- void SetStarved(void) {Starved = true;}\r
-\r
- void SetRunning(bool bb) { Running=bb; }\r
- void SetName(string name) {Name = name;}\r
- void AddFeedTank(int tkID);\r
-\r
- void SetMagnetos(int m) { Magnetos = m; }\r
- void SetStarter(bool s) { Starter = s;}\r
-\r
- /** Calculates the thrust of the engine, and other engine functions.\r
- @param PowerRequired this is the power required to run the thrusting device\r
- such as a propeller. This resisting effect must be provided to the \r
- engine model.\r
- @return Thrust in pounds */\r
- virtual float Calculate(float PowerRequired) {return 0.0;};\r
-\r
- /** Reduces the fuel in the active tanks by the amount required.\r
- This function should be called from within the\r
- derived class' Calculate() function before any other calculations are\r
- done. This base class method removes fuel from the fuel tanks as\r
- appropriate, and sets the starved flag if necessary. */\r
- void ConsumeFuel(void);\r
-\r
- /** The fuel need is calculated based on power levels and flow rate for that\r
- power level. It is also turned from a rate into an actual amount (pounds)\r
- by multiplying it by the delta T and the rate.\r
- @return Total fuel requirement for this engine in pounds. */\r
- float CalcFuelNeed(void);\r
-\r
- /** The oxidizer need is calculated based on power levels and flow rate for that\r
- power level. It is also turned from a rate into an actual amount (pounds)\r
- by multiplying it by the delta T and the rate.\r
- @return Total oxidizer requirement for this engine in pounds. */\r
- float CalcOxidizerNeed(void);\r
-\r
- /// Sets engine placement information\r
- void SetPlacement(float x, float y, float z, float pitch, float yaw);\r
-\r
- virtual float GetPowerAvailable(void) {return 0.0;};\r
-\r
- bool GetTrimMode(void) {return TrimMode;}\r
- void SetTrimMode(bool state) {TrimMode = state;}\r
-\r
-protected:\r
- string Name;\r
- EngineType Type;\r
- float X, Y, Z;\r
- float EnginePitch;\r
- float EngineYaw;\r
- float SLFuelFlowMax;\r
- float SLOxiFlowMax;\r
- float MaxThrottle;\r
- float MinThrottle;\r
-\r
- float Thrust;\r
- float Throttle;\r
- float Mixture;\r
- int Magnetos;\r
- bool Starter;\r
- float FuelNeed, OxidizerNeed;\r
- bool Starved;\r
- bool Flameout;\r
- bool Running;\r
- bool Cranking;\r
- float PctPower;\r
- int EngineNumber;\r
- bool TrimMode;\r
-\r
- float ManifoldPressure_inHg;\r
- float ExhaustGasTemp_degK;\r
- float CylinderHeadTemp_degK;\r
- float OilPressure_psi;\r
- float OilTemp_degK;\r
-\r
- FGFDMExec* FDMExec;\r
- FGState* State;\r
- FGAtmosphere* Atmosphere;\r
- FGFCS* FCS;\r
- FGPropulsion* Propulsion;\r
- FGAircraft* Aircraft;\r
- FGTranslation* Translation;\r
- FGRotation* Rotation;\r
- FGPosition* Position;\r
- FGAuxiliary* Auxiliary;\r
- FGOutput* Output;\r
-\r
- vector <int> SourceTanks;\r
- void Debug(void);\r
-};\r
-\r
-#include "FGState.h"\r
-#include "FGFDMExec.h"\r
-#include "FGAtmosphere.h"\r
-#include "FGFCS.h"\r
-#include "FGAircraft.h"\r
-#include "FGTranslation.h"\r
-#include "FGRotation.h"\r
-#include "FGPropulsion.h"\r
-#include "FGPosition.h"\r
-#include "FGAuxiliary.h"\r
-#include "FGOutput.h"\r
-#include "FGDefs.h"\r
-\r
-//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%\r
-#endif\r
-\r
+/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+ Header: FGEngine.h
+ Author: Jon S. Berndt
+ Date started: 01/21/99
+
+ ------------- Copyright (C) 1999 Jon S. Berndt (jsb@hal-pc.org) -------------
+
+ This program is free software; you can redistribute it and/or modify it under
+ the terms of the GNU General Public License as published by the Free Software
+ Foundation; either version 2 of the License, or (at your option) any later
+ version.
+
+ This program is distributed in the hope that it will be useful, but WITHOUT
+ ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+ details.
+
+ You should have received a copy of the GNU General Public License along with
+ this program; if not, write to the Free Software Foundation, Inc., 59 Temple
+ Place - Suite 330, Boston, MA 02111-1307, USA.
+
+ Further information about the GNU General Public License can also be found on
+ the world wide web at http://www.gnu.org.
+
+FUNCTIONAL DESCRIPTION
+--------------------------------------------------------------------------------
+
+Based on Flightgear code, which is based on LaRCSim. This class simulates
+a generic engine.
+
+HISTORY
+--------------------------------------------------------------------------------
+01/21/99 JSB Created
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+SENTRY
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
+
+#ifndef FGENGINE_H
+#define FGENGINE_H
+
+/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+INCLUDES
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
+
+#ifdef FGFS
+# include <simgear/compiler.h>
+# include STL_STRING
+ SG_USING_STD(string);
+# ifdef SG_HAVE_STD_INCLUDES
+# include <vector>
+# else
+# include <vector.h>
+# endif
+#else
+# include <vector>
+# include <string>
+#endif
+
+#include "FGJSBBase.h"
+
+/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+DEFINITIONS
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
+
+#define ID_ENGINE "$Id$"
+
+using std::string;
+
+/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+FORWARD DECLARATIONS
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
+
+class FGFDMExec;
+class FGState;
+class FGAtmosphere;
+class FGFCS;
+class FGAircraft;
+class FGTranslation;
+class FGRotation;
+class FGPropulsion;
+class FGPosition;
+class FGAuxiliary;
+class FGOutput;
+
+using std::vector;
+
+/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+COMMENTS, REFERENCES, and NOTES [use "class documentation" below for API docs]
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
+
+/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+CLASS DOCUMENTATION
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
+
+/** Base class for all engines.
+ This base class contains methods and members common to all engines, such as
+ logic to drain fuel from the appropriate tank, etc.
+ @author Jon S. Berndt
+ @version $Id$
+*/
+
+/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+CLASS DECLARATION
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
+
+class FGEngine : public FGJSBBase
+{
+public:
+ FGEngine(FGFDMExec* exec);
+ virtual ~FGEngine();
+
+ enum EngineType {etUnknown, etRocket, etPiston, etTurboProp, etTurboJet, etTurboShaft};
+
+ virtual double GetThrottleMin(void) { return MinThrottle; }
+ virtual double GetThrottleMax(void) { return MaxThrottle; }
+ virtual double GetThrottle(void) { return Throttle; }
+ virtual double GetMixture(void) { return Mixture; }
+ virtual int GetMagnetos(void) { return Magnetos; }
+ virtual bool GetStarter(void) { return Starter; }
+ virtual double GetThrust(void) { return Thrust; }
+ virtual bool GetStarved(void) { return Starved; }
+ virtual bool GetFlameout(void) { return Flameout; }
+ virtual bool GetRunning(void) { return Running; }
+ virtual bool GetCranking(void) { return Cranking; }
+ virtual int GetType(void) { return Type; }
+ virtual string GetName(void) { return Name; }
+
+ virtual double getFuelFlow_gph () const {
+ return FuelFlow_gph;
+ }
+
+ virtual double getManifoldPressure_inHg () const {
+ return ManifoldPressure_inHg;
+ }
+ virtual double getExhaustGasTemp_degF () const {
+ return (ExhaustGasTemp_degK - 273) * (9.0 / 5.0) + 32.0;
+ }
+ virtual double getCylinderHeadTemp_degF () const {
+ return (CylinderHeadTemp_degK - 273) * (9.0 / 5.0) + 32.0;
+ }
+ virtual double getOilPressure_psi () const {
+ return OilPressure_psi;
+ }
+ virtual double getOilTemp_degF () const {
+ return (OilTemp_degK - 273.0) * (9.0 / 5.0) + 32.0;
+ }
+
+ virtual void SetStarved(bool tt) {Starved = tt;}
+ virtual void SetStarved(void) {Starved = true;}
+
+ virtual void SetRunning(bool bb) { Running=bb; }
+ virtual void SetName(string name) {Name = name;}
+ virtual void AddFeedTank(int tkID);
+
+ virtual void SetMagnetos(int m) { Magnetos = m; }
+ virtual void SetStarter(bool s) { Starter = s;}
+
+ /** Calculates the thrust of the engine, and other engine functions.
+ @param PowerRequired this is the power required to run the thrusting device
+ such as a propeller. This resisting effect must be provided to the
+ engine model.
+ @return Thrust in pounds */
+ virtual double Calculate(double PowerRequired) {return 0.0;};
+
+ /** Reduces the fuel in the active tanks by the amount required.
+ This function should be called from within the
+ derived class' Calculate() function before any other calculations are
+ done. This base class method removes fuel from the fuel tanks as
+ appropriate, and sets the starved flag if necessary. */
+ virtual void ConsumeFuel(void);
+
+ /** The fuel need is calculated based on power levels and flow rate for that
+ power level. It is also turned from a rate into an actual amount (pounds)
+ by multiplying it by the delta T and the rate.
+ @return Total fuel requirement for this engine in pounds. */
+ virtual double CalcFuelNeed(void);
+
+ /** The oxidizer need is calculated based on power levels and flow rate for that
+ power level. It is also turned from a rate into an actual amount (pounds)
+ by multiplying it by the delta T and the rate.
+ @return Total oxidizer requirement for this engine in pounds. */
+ virtual double CalcOxidizerNeed(void);
+
+ /// Sets engine placement information
+ virtual void SetPlacement(double x, double y, double z, double pitch, double yaw);
+
+ /// Sets the engine number
+ virtual void SetEngineNumber(int nn) {EngineNumber = nn;}
+
+ virtual double GetPowerAvailable(void) {return 0.0;};
+
+ virtual bool GetTrimMode(void) {return TrimMode;}
+ virtual void SetTrimMode(bool state) {TrimMode = state;}
+
+protected:
+ string Name;
+ EngineType Type;
+ double X, Y, Z;
+ double EnginePitch;
+ double EngineYaw;
+ double SLFuelFlowMax;
+ double SLOxiFlowMax;
+ double MaxThrottle;
+ double MinThrottle;
+
+ double Thrust;
+ double Throttle;
+ double Mixture;
+ int Magnetos;
+ bool Starter;
+ double FuelNeed, OxidizerNeed;
+ bool Starved;
+ bool Flameout;
+ bool Running;
+ bool Cranking;
+ double PctPower;
+ int EngineNumber;
+ bool TrimMode;
+
+ double FuelFlow_gph;
+ double ManifoldPressure_inHg;
+ double ExhaustGasTemp_degK;
+ double CylinderHeadTemp_degK;
+ double OilPressure_psi;
+ double OilTemp_degK;
+
+ FGFDMExec* FDMExec;
+ FGState* State;
+ FGAtmosphere* Atmosphere;
+ FGFCS* FCS;
+ FGPropulsion* Propulsion;
+ FGAircraft* Aircraft;
+ FGTranslation* Translation;
+ FGRotation* Rotation;
+ FGPosition* Position;
+ FGAuxiliary* Auxiliary;
+ FGOutput* Output;
+
+ vector <int> SourceTanks;
+ virtual void Debug(int from);
+};
+
+#include "FGState.h"
+#include "FGFDMExec.h"
+#include "FGAtmosphere.h"
+#include "FGFCS.h"
+#include "FGAircraft.h"
+#include "FGTranslation.h"
+#include "FGRotation.h"
+#include "FGPropulsion.h"
+#include "FGPosition.h"
+#include "FGAuxiliary.h"
+#include "FGOutput.h"
+
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+#endif
+
projects / flightgear.git / blobdiff