FGScript Class Reference

Detailed Description

Encapsulates the JSBSim scripting capability.

Scripting support provided via FGScript.

There is support for scripting provided in the FGScript class. Commands are specified using the Scripting Directives for JSBSim. The script file is in XML format. A test condition (or conditions) can be set up in an event in a script and when the condition evaluates to true, the specified action[s] is/are taken. An event can be persistent, meaning that at every time the test condition first evaluates to true (toggling from false to true) then the specified set actions take place. An event can also be defined to execute or evaluate continuously while the condition is true. When the set of tests evaluates to true for a given condition, an item may be set to another value. This value may be a value, or a delta value, and the change from the current value to the new value can be either via a step action, a ramp, or an exponential approach. The speed of a ramp or exponential approach is specified via the time constant. Here is an example illustrating the format of the script file:

<?xml version="1.0"?>
<runscript name="C172-01A takeoff run">
  <!--
    This run is for testing the C172 altitude hold autopilot
  -->
 
  <use aircraft="c172x"/>
  <use initialize="reset00"/>
  <run start="0.0" end="3000" dt="0.0083333">
 
    <event name="engine start">
      <notify/>
      <condition>
        sim-time-sec >= 0.25
      </condition>
      <set name="fcs/throttle-cmd-norm" value="1.0" action="FG_RAMP" tc ="0.5"/>
      <set name="fcs/mixture-cmd-norm" value="0.87" action="FG_RAMP" tc ="0.5"/>
      <set name="propulsion/magneto_cmd" value="3"/>
      <set name="propulsion/starter_cmd" value="1"/>
    </event>
 
    <event name="set heading hold">
      <!-- Set Heading when reach 5 ft -->
      <notify/>
      <condition>
        position/h-agl-ft >= 5
      </condition>
      <set name="ap/heading_setpoint" value="200"/>
      <set name="ap/attitude_hold" value="0"/>
      <set name="ap/heading_hold" value="1"/>
    </event>
 
    <event name="set autopilot">
      <!-- Set Autopilot for 20 ft -->
      <notify/>
      <condition>
        aero/qbar-psf >= 4
      </condition>
      <set name="ap/altitude_setpoint" value="100.0" action="FG_EXP" tc ="2.0"/>
      <set name="ap/altitude_hold" value="1"/>
      <set name="fcs/flap-cmd-norm" value=".33"/>
    </event>
 
    <event name="set autopilot 2" persistent="true">
      <!-- Set Autopilot for 6000 ft -->
      <notify/>
      <condition>
        aero/qbar-psf > 5
      </condition>
      <set name="ap/altitude_setpoint" value="6000.0"/>
    </event>
 
    <event name="Time Notify">
      <notify/>
      <condition> sim-time-sec >= 500 </condition>
    </event>
 
    <event name="Time Notify">
      <notify/>
      <condition> sim-time-sec >= 1000 </condition>
    </event>
 
  </run>
 
</runscript>

The first line must always be present - it identifies the file as an XML format file. The second line identifies this file as a script file, and gives a descriptive name to the script file. Comments are next, delineated by the <!– and –> symbols. The aircraft and initialization files to be used are specified in the "use" lines. Next, comes the "run" section, where the conditions are described in "event" clauses.

Author

Jon S. Berndt

Definition at line 167 of file FGScript.h.

#include <FGScript.h>

Inheritance diagram for FGScript:

Collaboration diagram for FGScript:

Public Member Functions
	FGScript (FGFDMExec *exec)
	Default constructor.
	~FGScript ()
	Default destructor.
bool	LoadScript (const SGPath &script, double default_dT, const SGPath &initfile)
	Loads a script to drive JSBSim (usually in standalone mode).
void	ResetEvents (void)
bool	RunScript (void)
	This function is called each pass through the executive Run() method IF scripting is enabled.
Public Member Functions inherited from FGJSBBase
	FGJSBBase ()
	Constructor for FGJSBBase.
virtual	~FGJSBBase ()
	Destructor for FGJSBBase.
void	disableHighLighting (void)
	Disables highlighting in the console output.

Additional Inherited Members
Public Types inherited from FGJSBBase
enum	{ eL = 1 , eM , eN }
	Moments L, M, N. More...
enum	{ eP = 1 , eQ , eR }
	Rates P, Q, R. More...
enum	{ eU = 1 , eV , eW }
	Velocities U, V, W. More...
enum	{ eX = 1 , eY , eZ }
	Positions X, Y, Z. More...
enum	{ ePhi = 1 , eTht , ePsi }
	Euler angles Phi, Theta, Psi. More...
enum	{ eDrag = 1 , eSide , eLift }
	Stability axis forces, Drag, Side force, Lift. More...
enum	{ eRoll = 1 , ePitch , eYaw }
	Local frame orientation Roll, Pitch, Yaw. More...
enum	{ eNorth = 1 , eEast , eDown }
	Local frame position North, East, Down. More...
enum	{ eLat = 1 , eLong , eRad }
	Locations Radius, Latitude, Longitude. More...
enum	{   inNone = 0 , inDegrees , inRadians , inMeters ,   inFeet }
	Conversion specifiers. More...
Static Public Member Functions inherited from FGJSBBase
static const std::string &	GetVersion (void)
	Returns the version number of JSBSim.
static constexpr double	KelvinToFahrenheit (double kelvin)
	Converts from degrees Kelvin to degrees Fahrenheit.
static constexpr double	CelsiusToRankine (double celsius)
	Converts from degrees Celsius to degrees Rankine.
static constexpr double	RankineToCelsius (double rankine)
	Converts from degrees Rankine to degrees Celsius.
static constexpr double	KelvinToRankine (double kelvin)
	Converts from degrees Kelvin to degrees Rankine.
static constexpr double	RankineToKelvin (double rankine)
	Converts from degrees Rankine to degrees Kelvin.
static constexpr double	FahrenheitToCelsius (double fahrenheit)
	Converts from degrees Fahrenheit to degrees Celsius.
static constexpr double	CelsiusToFahrenheit (double celsius)
	Converts from degrees Celsius to degrees Fahrenheit.
static constexpr double	CelsiusToKelvin (double celsius)
	Converts from degrees Celsius to degrees Kelvin.
static constexpr double	KelvinToCelsius (double kelvin)
	Converts from degrees Kelvin to degrees Celsius.
static constexpr double	FeetToMeters (double measure)
	Converts from feet to meters.
static bool	EqualToRoundoff (double a, double b)
	Finite precision comparison.
static bool	EqualToRoundoff (float a, float b)
	Finite precision comparison.
static bool	EqualToRoundoff (float a, double b)
	Finite precision comparison.
static bool	EqualToRoundoff (double a, float b)
	Finite precision comparison.
static constexpr double	Constrain (double min, double value, double max)
	Constrain a value between a minimum and a maximum value.
static constexpr double	sign (double num)
Static Public Attributes inherited from FGJSBBase
static char	highint [5] = {27, '[', '1', 'm', '\0' }
	highlights text
static char	halfint [5] = {27, '[', '2', 'm', '\0' }
	low intensity text
static char	normint [6] = {27, '[', '2', '2', 'm', '\0' }
	normal intensity text
static char	reset [5] = {27, '[', '0', 'm', '\0' }
	resets text properties
static char	underon [5] = {27, '[', '4', 'm', '\0' }
	underlines text
static char	underoff [6] = {27, '[', '2', '4', 'm', '\0' }
	underline off
static char	fgblue [6] = {27, '[', '3', '4', 'm', '\0' }
	blue text
static char	fgcyan [6] = {27, '[', '3', '6', 'm', '\0' }
	cyan text
static char	fgred [6] = {27, '[', '3', '1', 'm', '\0' }
	red text
static char	fggreen [6] = {27, '[', '3', '2', 'm', '\0' }
	green text
static char	fgdef [6] = {27, '[', '3', '9', 'm', '\0' }
	default text
static short	debug_lvl = 1
Static Protected Member Functions inherited from FGJSBBase
static std::string	CreateIndexedPropertyName (const std::string &Property, int index)
Static Protected Attributes inherited from FGJSBBase
static constexpr double	radtodeg = 180. / M_PI
static constexpr double	degtorad = M_PI / 180.
static constexpr double	hptoftlbssec = 550.0
static constexpr double	psftoinhg = 0.014138
static constexpr double	psftopa = 47.88
static constexpr double	fttom = 0.3048
static constexpr double	ktstofps = 1852./(3600*fttom)
static constexpr double	fpstokts = 1.0 / ktstofps
static constexpr double	inchtoft = 1.0/12.0
static constexpr double	m3toft3 = 1.0/(fttom*fttom*fttom)
static constexpr double	in3tom3 = inchtoft*inchtoft*inchtoft/m3toft3
static constexpr double	inhgtopa = 3386.38
static constexpr double	slugtolb = 32.174049
	Note that definition of lbtoslug by the inverse of slugtolb and not to a different constant you can also get from some tables will make lbtoslug*slugtolb == 1 up to the magnitude of roundoff.
static constexpr double	lbtoslug = 1.0/slugtolb
static constexpr double	kgtolb = 2.20462
static constexpr double	kgtoslug = 0.06852168
static const std::string	needed_cfg_version = "2.0"
static const std::string	JSBSim_version = JSBSIM_VERSION " " __DATE__ " " __TIME__

Constructor & Destructor Documentation

FGScript()

FGScript

(

FGFDMExec *

exec

)

Default constructor.

Definition at line 65 of file FGScript.cpp.

                                  : FDMExec(fgex)
{
  PropertyManager=FDMExec->GetPropertyManager();
 
  Debug(0);
}

Here is the call graph for this function:

~FGScript()

~FGScript

(

)

Default destructor.

Definition at line 74 of file FGScript.cpp.

{
  unsigned int i, j;
 
  for (i=0; i<Events.size(); i++) {
    delete Events[i].Condition;
    for (j=0; j<Events[i].Functions.size(); j++)
      delete Events[i].Functions[j];
    for (j=0; j<Events[i].NotifyProperties.size(); j++)
      delete Events[i].NotifyProperties[j];
  }
  Events.clear();
 
  Debug(1);
}

Member Function Documentation

LoadScript()

bool LoadScript	(	const SGPath &	script,
		double	default_dT,
		const SGPath &	initfile
	)

Loads a script to drive JSBSim (usually in standalone mode).

The language is the Script Directives for JSBSim. If a simulation step size has been supplied on the command line, it will override the script specified simulation step size.

Parameters

script	the filename (including path name, if any) for the script.
default_dT	the default simulation step size if no value is specified in the script
initfile	An optional initialization file name passed in, empty by default. If a file name is passed in, it will override the one present in the script.

Returns

true if successful

Definition at line 92 of file FGScript.cpp.

{
  SGPath initialize;
  string aircraft="", prop_name="";
  string notifyPropertyName="";
  Element *element=0, *run_element=0, *event_element=0;
  Element *set_element=0;
  Element *notify_element = 0L, *notify_property_element = 0L;
  double dt = 0.0, value = 0.0;
  FGCondition *newCondition;
 
  FGXMLFileRead XMLFileRead;
  Element* document = XMLFileRead.LoadXMLDocument(script);
 
  if (!document) {
    FGLogging log(LogLevel::ERROR);
    log << "File: " << script << " could not be loaded.\n";
    return false;
  }
 
  if (document->GetName() != string("runscript")) {
    FGXMLLogging log(document, LogLevel::ERROR);
    log << "File: " << script << " is not a script file\n";
    return false;
  }
 
  ScriptName = document->GetAttributeValue("name");
 
 // First, find "run" element and set delta T
 
  run_element = document->FindElement("run");
 
  if (!run_element) {
    FGXMLLogging log(document, LogLevel::ERROR);
    log << "No \"run\" element found in script.\n";
    return false;
  }
 
  // Set sim timing
 
  if (run_element->HasAttribute("start"))
    StartTime = run_element->GetAttributeValueAsNumber("start");
  else
    StartTime = 0.0;
  FDMExec->Setsim_time(StartTime);
  if (run_element->HasAttribute("end")) {
    EndTime   = run_element->GetAttributeValueAsNumber("end");
  } else {
    FGXMLLogging log(run_element, LogLevel::ERROR);
    log << "An end time (duration) for the script must be specified in the script <run> element.\n";
    return false;
  }
 
  if (default_dT == 0.0)
    dt = run_element->GetAttributeValueAsNumber("dt");
  else {
    dt = default_dT;
    FGLogging log(LogLevel::INFO);
    log << "\nOverriding simulation step size from the command line. New step size is: "
        << default_dT << " seconds (" << 1/default_dT << " Hz)\n\n";
  }
 
  FDMExec->Setdt(dt);
 
  // Make sure that the desired time is reached and executed.
  EndTime += 0.99*FDMExec->GetDeltaT();
 
  // read aircraft and initialization files
 
  element = document->FindElement("use");
  if (element) {
    aircraft = element->GetAttributeValue("aircraft");
    if (!aircraft.empty()) {
      if (!FDMExec->LoadModel(aircraft))
        return false;
    } else {
      FGXMLLogging log(element, LogLevel::ERROR);
      log << "Aircraft must be specified in use element.\n";
      return false;
    }
 
    initialize = SGPath::fromLocal8Bit(element->GetAttributeValue("initialize").c_str());
    if (initfile.isNull()) {
      if (initialize.isNull()) {
        FGXMLLogging log(element, LogLevel::ERROR);
        log << "Initialization file must be specified in use element.\n";
        return false;
      }
    } else {
      FGLogging log(LogLevel::INFO);
      log << "\nThe initialization file specified in the script file ("
           << initialize << ") has been overridden with a specified file ("
           << initfile << ").\n";
      initialize = initfile;
    }
 
  } else {
    FGXMLLogging log(document, LogLevel::ERROR);
    log << "No \"use\" directives in the script file.\n";
    return false;
  }
 
  auto IC = FDMExec->GetIC();
  if ( ! IC->Load( initialize )) {
    FGLogging log(LogLevel::ERROR);
    log << "Initialization unsuccessful\n";
    return false;
  }
 
  // Now, read input spec if given.
  element = document->FindElement("input");
  while (element) {
    if (!FDMExec->GetInput()->Load(element))
      return false;
 
    element = document->FindNextElement("input");
  }
 
  // Now, read output spec if given.
  element = document->FindElement("output");
  SGPath scriptDir = SGPath(script.dir());
  if (scriptDir.isNull())
    scriptDir = SGPath(".");
 
  while (element) {
    if (!FDMExec->GetOutput()->Load(element, scriptDir))
      return false;
 
    element = document->FindNextElement("output");
  }
 
  // Read local property/value declarations
  int saved_debug_lvl = debug_lvl;
  debug_lvl = 0; // Disable messages
  LocalProperties.Load(run_element, PropertyManager.get(), true);
  debug_lvl = saved_debug_lvl;
 
  // Read "events" from script
 
  event_element = run_element->FindElement("event");
  while (event_element) { // event processing
 
    // Create the event structure
    struct event *newEvent = new struct event();
 
    // Retrieve the event name if given
    newEvent->Name = event_element->GetAttributeValue("name");
 
    // Is this event persistent? That is, does it execute every time the
    // condition triggers to true, or does it execute as a one-shot event, only?
    if (event_element->GetAttributeValue("persistent") == string("true")) {
      newEvent->Persistent = true;
    }
 
    // Does this event execute continuously when triggered to true?
    if (event_element->GetAttributeValue("continuous") == string("true")) {
      newEvent->Continuous = true;
    }
 
    // Process the conditions
    Element* condition_element = event_element->FindElement("condition");
    if (condition_element) {
      try {
        newCondition = new FGCondition(condition_element, PropertyManager);
      } catch(BaseException& e) {
        FGXMLLogging log(condition_element, LogLevel::ERROR);
        log << LogFormat::RED << e.what() << LogFormat::RESET << "\n\n";
        delete newEvent;
        return false;
      }
      newEvent->Condition = newCondition;
    } else {
      FGXMLLogging log(event_element, LogLevel::ERROR);
      log << "No condition specified in script event " << newEvent->Name << "\n";
      delete newEvent;
      return false;
    }
 
    // Is there a delay between the time this event is triggered, and when the
    // event actions are executed?
 
    Element* delay_element = event_element->FindElement("delay");
    if (delay_element)
      newEvent->Delay = event_element->FindElementValueAsNumber("delay");
    else
      newEvent->Delay = 0.0;
 
    // Notify about when this event is triggered?
    if ((notify_element = event_element->FindElement("notify")) != 0) {
      if (notify_element->HasAttribute("format")) {
        if (notify_element->GetAttributeValue("format") == "kml") newEvent->NotifyKML = true;
      }
      newEvent->Notify = true;
      // Check here for new <description> tag that gets echoed
      string notify_description = notify_element->FindElementValue("description");
      if (!notify_description.empty()) {
        newEvent->Description = notify_description;
      }
      notify_property_element = notify_element->FindElement("property");
      while (notify_property_element) {
        notifyPropertyName = notify_property_element->GetDataLine();
 
        if (notify_property_element->HasAttribute("apply")) {
          string function_str = notify_property_element->GetAttributeValue("apply");
          auto f = FDMExec->GetTemplateFunc(function_str);
          if (f)
            newEvent->NotifyProperties.push_back(new FGFunctionValue(notifyPropertyName, PropertyManager, f,
                                                                     notify_property_element));
          else {
            FGXMLLogging log(notify_property_element, LogLevel::WARN);
            log << LogFormat::RED << LogFormat::BOLD << "  No function by the name "
                << function_str << " has been defined. This property will "
                << "not be logged. You should check your configuration file.\n"
                << LogFormat::RESET;
          }
        }
        else
          newEvent->NotifyProperties.push_back(new FGPropertyValue(notifyPropertyName, PropertyManager,
                                                                   notify_property_element));
 
        string caption_attribute = notify_property_element->GetAttributeValue("caption");
        if (caption_attribute.empty()) {
          newEvent->DisplayString.push_back(notifyPropertyName);
        } else {
          newEvent->DisplayString.push_back(caption_attribute);
        }
 
        notify_property_element = notify_element->FindNextElement("property");
      }
    }
 
    // Read set definitions (these define the actions to be taken when the event
    // is triggered).
    set_element = event_element->FindElement("set");
    while (set_element) {
      prop_name = set_element->GetAttributeValue("name");
      if (PropertyManager->HasNode(prop_name)) {
        newEvent->SetParam.push_back( PropertyManager->GetNode(prop_name) );
      } else {
        newEvent->SetParam.push_back( 0L );
      }
      newEvent->SetParamName.push_back( prop_name );
 
      // Todo - should probably do some safety checking here to make sure one or
      // the other of value or function is specified.
      if (!set_element->GetAttributeValue("value").empty()) {
        value = set_element->GetAttributeValueAsNumber("value");
        newEvent->Functions.push_back(nullptr);
      } else if (set_element->FindElement("function")) {
        value = 0.0;
        newEvent->Functions.push_back(new FGFunction(FDMExec, set_element->FindElement("function")));
      }
      newEvent->SetValue.push_back(value);
      newEvent->OriginalValue.push_back(0.0);
      newEvent->newValue.push_back(0.0);
      newEvent->ValueSpan.push_back(0.0);
      string tempCompare = set_element->GetAttributeValue("type");
      if      (to_lower(tempCompare).find("delta") != string::npos) newEvent->Type.push_back(FG_DELTA);
      else if (to_lower(tempCompare).find("bool") != string::npos)  newEvent->Type.push_back(FG_BOOL);
      else if (to_lower(tempCompare).find("value") != string::npos) newEvent->Type.push_back(FG_VALUE);
      else                                newEvent->Type.push_back(FG_VALUE); // DEFAULT
      tempCompare = set_element->GetAttributeValue("action");
      if      (to_lower(tempCompare).find("ramp") != string::npos) newEvent->Action.push_back(FG_RAMP);
      else if (to_lower(tempCompare).find("step") != string::npos) newEvent->Action.push_back(FG_STEP);
      else if (to_lower(tempCompare).find("exp") != string::npos) newEvent->Action.push_back(FG_EXP);
      else                               newEvent->Action.push_back(FG_STEP); // DEFAULT
 
      if (!set_element->GetAttributeValue("tc").empty())
        newEvent->TC.push_back(set_element->GetAttributeValueAsNumber("tc"));
      else
        newEvent->TC.push_back(1.0); // DEFAULT
 
      newEvent->Transiting.push_back(false);
 
      set_element = event_element->FindNextElement("set");
    }
    Events.push_back(*newEvent);
    delete newEvent;
 
    event_element = run_element->FindNextElement("event");
  }
 
  Debug(4);
 
  return true;
}

Here is the call graph for this function:

ResetEvents()

void ResetEvents

(

void

)

Definition at line 382 of file FGScript.cpp.

{
  LocalProperties.ResetToIC();
  FDMExec->Setsim_time(StartTime);
 
  for (unsigned int i=0; i<Events.size(); i++)
    Events[i].reset();
}

RunScript()

bool RunScript

(

void

)

This function is called each pass through the executive Run() method IF scripting is enabled.

Returns

false if script should exit (i.e. if time limits are violated

Definition at line 393 of file FGScript.cpp.

{
  unsigned i, j;
  unsigned event_ctr = 0;
 
  double currentTime = FDMExec->GetSimTime();
  double newSetValue = 0;
 
  if (currentTime > EndTime) return false;
 
  // Iterate over all events.
  for (unsigned int ev_ctr=0; ev_ctr < Events.size(); ev_ctr++) {
 
    struct event &thisEvent = Events[ev_ctr];
 
    // Determine whether the set of conditional tests for this condition equate
    // to true and should cause the event to execute. If the conditions evaluate
    // to true, then the event is triggered. If the event is not persistent,
    // then this trigger will remain set true. If the event is persistent, the
    // trigger will reset to false when the condition evaluates to false.
    if (thisEvent.Condition->Evaluate()) {
      if (!thisEvent.Triggered) {
 
        // The conditions are true, do the setting of the desired Event
        // parameters
        for (i=0; i<thisEvent.SetValue.size(); i++) {
          if (thisEvent.SetParam[i] == 0L) { // Late bind property if necessary
            if (PropertyManager->HasNode(thisEvent.SetParamName[i])) {
              thisEvent.SetParam[i] = PropertyManager->GetNode(thisEvent.SetParamName[i]);
            } else {
              LogException err;
              err << "No property, \"" << thisEvent.SetParamName[i] << "\" is defined.\n";
              throw err;
            }
          }
          thisEvent.OriginalValue[i] = thisEvent.SetParam[i]->getDoubleValue();
          if (thisEvent.Functions[i] != 0) { // Parameter should be set to a function value
            try {
              thisEvent.SetValue[i] = thisEvent.Functions[i]->GetValue();
            } catch (BaseException& e) {
              LogException err;
              err << "\nA problem occurred in the execution of the script. "
                  << e.what() << "\n";
              throw err;
            }
          }
          switch (thisEvent.Type[i]) {
          case FG_VALUE:
          case FG_BOOL:
            thisEvent.newValue[i] = thisEvent.SetValue[i];
            break;
          case FG_DELTA:
            thisEvent.newValue[i] = thisEvent.OriginalValue[i] + thisEvent.SetValue[i];
            break;
          default:
            FGLogging log(LogLevel::WARN);
            log << "Invalid Type specified\n";
            break;
          }
          thisEvent.StartTime = currentTime + thisEvent.Delay;
          thisEvent.ValueSpan[i] = thisEvent.newValue[i] - thisEvent.OriginalValue[i];
          thisEvent.Transiting[i] = true;
        }
      }
      thisEvent.Triggered = true;
 
    } else if (thisEvent.Persistent) { // If the event is persistent, reset the trigger.
      thisEvent.Triggered = false; // Reset the trigger for persistent events
      thisEvent.Notified = false;  // Also reset the notification flag
    } else if (thisEvent.Continuous) { // If the event is continuous, reset the trigger.
      thisEvent.Triggered = false; // Reset the trigger for persistent events
      thisEvent.Notified = false;  // Also reset the notification flag
    }
 
    if ((currentTime >= thisEvent.StartTime) && thisEvent.Triggered) {
 
      for (i=0; i<thisEvent.SetValue.size(); i++) {
        if (thisEvent.Transiting[i]) {
          thisEvent.TimeSpan = currentTime - thisEvent.StartTime;
          switch (thisEvent.Action[i]) {
          case FG_RAMP:
            if (thisEvent.TimeSpan <= thisEvent.TC[i]) {
              newSetValue = thisEvent.TimeSpan/thisEvent.TC[i] * thisEvent.ValueSpan[i] + thisEvent.OriginalValue[i];
            } else {
              newSetValue = thisEvent.newValue[i];
              if (thisEvent.Continuous != true) thisEvent.Transiting[i] = false;
            }
            break;
          case FG_STEP:
            newSetValue = thisEvent.newValue[i];
 
            // If this is not a continuous event, reset the transiting flag.
            // Otherwise, it is known that the event is a continuous event.
            // Furthermore, if the event is to be determined by a function,
            // then the function will be continuously calculated.
            if (thisEvent.Continuous != true)
              thisEvent.Transiting[i] = false;
            else if (thisEvent.Functions[i] != 0)
              newSetValue = thisEvent.Functions[i]->GetValue();
 
            break;
          case FG_EXP:
            newSetValue = (1 - exp( -thisEvent.TimeSpan/thisEvent.TC[i] )) * thisEvent.ValueSpan[i] + thisEvent.OriginalValue[i];
            break;
          default:
            FGLogging log(LogLevel::WARN);
            log << "Invalid Action specified\n";
            break;
          }
          thisEvent.SetParam[i]->setDoubleValue(newSetValue);
        }
      }
 
      // Print notification values after setting them
      if (thisEvent.Notify && !thisEvent.Notified) {
        LogLevel level = thisEvent.NotifyKML ? LogLevel::STDOUT : LogLevel::INFO;
        FGLogging out(level);
        if (thisEvent.NotifyKML) {
          out << "\n<Placemark>\n";
          out << "  <name> " << currentTime << " seconds" << " </name>\n";
          out << "  <description>\n";
          out << "  <![CDATA[\n";
          out << "  <b>" << thisEvent.Name << " (Event " << event_ctr << ")"
               << " executed at time: " << currentTime << "</b><br/>\n";
        } else  {
          out << "\n" << LogFormat::UNDERLINE_ON << LogFormat::BOLD
              << thisEvent.Name << LogFormat::NORMAL << LogFormat::UNDERLINE_OFF
              << " (Event " << event_ctr << ")"
              << " executed at time: " << LogFormat::BOLD << currentTime << LogFormat::NORMAL
              << "\n";
        }
        if (!thisEvent.Description.empty()) {
          out << "    " << thisEvent.Description << "\n";
        }
        for (j=0; j<thisEvent.NotifyProperties.size();j++) {
          out << "    " << thisEvent.DisplayString[j] << " = "
               << thisEvent.NotifyProperties[j]->getDoubleValue();
          if (thisEvent.NotifyKML) out << " <br/>";
          out << "\n";
        }
        if (thisEvent.NotifyKML) {
          out << "  ]]>\n";
          out << "  </description>\n";
          out << "  <Point>\n";
          out << "    <altitudeMode> absolute </altitudeMode>\n";
          out << "    <extrude> 1 </extrude>\n";
          out << "    <coordinates>"
               << FDMExec->GetPropagate()->GetLongitudeDeg() << ","
               << FDMExec->GetPropagate()->GetGeodLatitudeDeg() << ","
               << FDMExec->GetPropagate()->GetAltitudeASLmeters()
               << "</coordinates>\n";
          out << "  </Point>\n";
          out << "</Placemark>\n";
        }
        out << "\n";
        thisEvent.Notified = true;
      }
 
    }
 
    event_ctr++;
  }
  return true;
}

Here is the call graph for this function:

---

The documentation for this class was generated from the following files:

• FGScript.h
• FGScript.cpp