Expose Input enable/disable and implement for additional cases (#1459)

Co-authored-by: Sean McLeod <sean@seanmcleod.com>

Author: seanmcleod70

python/jsbsim.pxd

@@ -249,6 +249,8 @@ cdef extern from "FGFDMExec.h" namespace "JSBSim":
         void DoTrim(int mode) except +convertJSBSimToPyExc
         void DisableOutput()
         void EnableOutput()
+        void DisableInput()
+        void EnableInput()
         void Hold()
         void EnableIncrementThenHold(int time_steps)
         void CheckIncrementalHold()

python/jsbsim.pyx.in

@@ -1018,6 +1018,14 @@ cdef class FGFDMExec(FGJSBBase):
         """@Dox(JSBSim::FGFDMExec::EnableOutput)"""
         self.thisptr.EnableOutput()
 
+    def disable_input(self) -> None:
+        """@Dox(JSBSim::FGFDMExec::DisableInput)"""
+        self.thisptr.DisableInput()
+
+    def enable_input(self) -> None:
+        """@Dox(JSBSim::FGFDMExec::EnableInput)"""
+        self.thisptr.EnableInput()
+
     def hold(self) -> None:
         """@Dox(JSBSim::FGFDMExec::Hold)"""
         self.thisptr.Hold()

src/FGFDMExec.h

@@ -45,6 +45,7 @@ INCLUDES
 
 #include "models/FGPropagate.h"
 #include "models/FGOutput.h"
+#include "models/FGInput.h"
 #include "math/FGTemplateFunc.h"
 
 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -66,7 +67,6 @@ class FGExternalReactions;
 class FGGroundReactions;
 class FGFCS;
 class FGInertial;
-class FGInput;
 class FGPropulsion;
 class FGMassBalance;
 class FGLogger;
@@ -485,6 +485,10 @@ class JSBSIM_API FGFDMExec : public FGJSBBase
   void DisableOutput(void) { Output->Disable(); }
   /// Enables data logging to all outputs.
   void EnableOutput(void) { Output->Enable(); }
+  /// Disables input from all inputs.
+  void DisableInput(void) { Input->Disable(); }
+  /// Enables input from all inputs.
+  void EnableInput(void) { Input->Enable(); }
   /// Pauses execution by preventing time from incrementing.
   void Hold(void) {holding = true;}
   /// Turn on hold after increment

src/input_output/FGInputSocket.cpp

@@ -53,21 +53,14 @@ namespace JSBSim {
 CLASS IMPLEMENTATION
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
-FGInputSocket::FGInputSocket(FGFDMExec* fdmex) :
-  FGInputType(fdmex), socket(0), SockProtocol(FGfdmSocket::ptTCP),
+FGInputSocket::FGInputSocket(FGFDMExec* fdmex, bool isEnabled) :
+  FGInputType(fdmex, isEnabled), SockProtocol(FGfdmSocket::ptTCP),
   BlockingInput(false)
 {
 }
 
 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
-FGInputSocket::~FGInputSocket()
-{
-  delete socket;
-}
-
-//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
 bool FGInputSocket::Load(Element* el)
 {
   if (!FGInputType::Load(el))
@@ -92,17 +85,55 @@ bool FGInputSocket::Load(Element* el)
 
 bool FGInputSocket::InitModel(void)
 {
-  if (FGInputType::InitModel()) {
-    delete socket;
-    socket = new FGfdmSocket(SockPort, SockProtocol);
+  if (!FGInputType::InitModel())
+    return false;
 
-    if (socket == 0) return false;
-    if (!socket->GetConnectStatus()) return false;
+  if (enabled)
+    return CreateSocket();
 
-    return true;
-  }
+  return true;
+}
+
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+bool FGInputSocket::CreateSocket()
+{
+  socket = std::make_unique<FGfdmSocket>(SockPort, SockProtocol);
+
+  if (!socket) return false;
+  if (!socket->GetConnectStatus()) return false;
+
+  return true;
+}
+
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+void FGInputSocket::Enable()
+{
+  if (enabled) return; // already enabled
+  FGInputType::Enable();
+  CreateSocket();
+}
+
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+void FGInputSocket::Disable()
+{
+  FGInputType::Disable();
+  socket.reset();
+}
+
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+bool FGInputSocket::Toggle()
+{
+  bool enabled_status = FGInputType::Toggle();
+  if (enabled_status)
+    CreateSocket();
+  else
+    socket.reset();
 
-  return false;
+  return enabled_status;
 }
 
 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

src/input_output/FGInputSocket.h

@@ -63,10 +63,7 @@ class FGInputSocket : public FGInputType
 {
 public:
   /** Constructor. */
-  FGInputSocket(FGFDMExec* fdmex);
-
-  /** Destructor. */
-  ~FGInputSocket() override;
+  FGInputSocket(FGFDMExec* fdmex, bool isEnabled);
 
   /** Init the input directives from an XML file.
       @param element XML Element that is pointing to the input directives
@@ -82,10 +79,17 @@ class FGInputSocket : public FGInputType
   /// Generates the input.
   void Read(bool Holding) override;
 
+  /// Methods to enable, disable and toggle the input
+  void Enable() override;
+  void Disable() override;
+  bool Toggle() override;
+
 protected:
 
+  bool CreateSocket();
+
   unsigned int SockPort;
-  FGfdmSocket* socket;
+  std::unique_ptr<FGfdmSocket> socket;
   FGfdmSocket::ProtocolType SockProtocol;
   std::string data;
   bool BlockingInput;

src/input_output/FGInputType.cpp

@@ -49,8 +49,8 @@ namespace JSBSim {
 CLASS IMPLEMENTATION
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
-FGInputType::FGInputType(FGFDMExec* fdmex) :
-  FGModel(fdmex), enabled(true)
+FGInputType::FGInputType(FGFDMExec* fdmex, bool isEnabled) :
+  FGModel(fdmex), enabled(isEnabled)
 {
   Debug(0);
 }

src/input_output/FGInputType.h

@@ -76,7 +76,7 @@ class FGInputType : public FGModel
   /** Constructor (implement the FGModel interface).
       @param fdmex a pointer to the parent executive object
    */
-  FGInputType(FGFDMExec* fdmex);
+  FGInputType(FGFDMExec* fdmex, bool isEnabled=true);
 
   /// Destructor
   ~FGInputType() override;
@@ -109,13 +109,13 @@ class FGInputType : public FGModel
   virtual void Read(bool Holding) = 0;
 
   /// Enables the input generation.
-  void Enable(void) { enabled = true; }
+  virtual void Enable(void) { enabled = true; }
   /// Disables the input generation.
-  void Disable(void) { enabled = false; }
+  virtual void Disable(void) { enabled = false; }
   /** Toggles the input generation.
       @result the input generation status i.e. true if the input has been
               enabled, false if the input has been disabled. */
-  bool Toggle(void) {enabled = !enabled; return enabled;}
+  virtual bool Toggle(void) {enabled = !enabled; return enabled;}
 
   /** Overwrites the name identifier under which the input will be read.
       This method is taken into account if it is called before

src/input_output/FGUDPInputSocket.cpp

@@ -51,8 +51,8 @@ namespace JSBSim {
 CLASS IMPLEMENTATION
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
-FGUDPInputSocket::FGUDPInputSocket(FGFDMExec* fdmex) :
-  FGInputSocket(fdmex), rate(20), oldTimeStamp(0.0)
+FGUDPInputSocket::FGUDPInputSocket(FGFDMExec* fdmex, bool isEnabled) :
+  FGInputSocket(fdmex, isEnabled), rate(20), oldTimeStamp(0.0)
 {
   SockPort = 5139;
   SockProtocol = FGfdmSocket::ptUDP;
@@ -90,7 +90,7 @@ bool FGUDPInputSocket::Load(Element* el)
 
 void FGUDPInputSocket::Read(bool Holding)
 {
-  if (socket == 0) return;
+  if (!socket) return;
 
   data = socket->Receive();
 

src/input_output/FGUDPInputSocket.h

@@ -61,7 +61,7 @@ class FGUDPInputSocket : public FGInputSocket
 {
 public:
   /** Constructor. */
-  FGUDPInputSocket(FGFDMExec* fdmex);
+  FGUDPInputSocket(FGFDMExec* fdmex, bool isEnabled=true);
 
   /** Reads the property names from an XML file.
       @param element The root XML Element of the input file.

src/models/FGInput.cpp

@@ -101,9 +101,9 @@ bool FGInput::Load(Element* el)
   type = to_upper(type);
 
   if (type.empty() || type == "SOCKET") {
-    Input = new FGInputSocket(FDMExec);
+    Input = new FGInputSocket(FDMExec, enabled);
   } else if (type == "QTJSBSIM") {
-    Input = new FGUDPInputSocket(FDMExec);
+    Input = new FGUDPInputSocket(FDMExec, enabled);
   } else if (type != string("NONE")) {
     FGXMLLogging log(element, LogLevel::ERROR);
     log << "Unknown type of input specified in config file" << endl;
@@ -203,6 +203,23 @@ string FGInput::GetInputName(unsigned int idx) const
   return name;
 }
 
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+/// Enables the input generation for all input instances.
+void FGInput::Enable(void)
+{
+  enabled = true;
+  for (auto input : InputTypes)
+    input->Enable();
+}
+
+/// Disables the input generation for all input instances.
+void FGInput::Disable(void)
+{
+  enabled = false;
+  for (auto input : InputTypes)
+    input->Disable();
+}
 
 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 //    The bitmasked value choices are as follows: