JSBSim Flight Dynamics Model  1.1.11 (13 Feb 2022)
An Open Source Flight Dynamics and Control Software Library in C++
FGInputSocket.h
1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2 
3  Header: FGInputSocket.h
4  Author: Paul Chavent
5  Date started: 01/20/15
6 
7  ------------- Copyright (C) 2015 Paul Chavent -------------
8 
9  This program is free software; you can redistribute it and/or modify it under
10  the terms of the GNU Lesser 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 Lesser General Public License for more
17  details.
18 
19  You should have received a copy of the GNU Lesser 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 Lesser General Public License can also be found on
24  the world wide web at http://www.gnu.org.
25 
26 HISTORY
27 --------------------------------------------------------------------------------
28 20/01/15 PC Created
29 
30 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
31 SENTRY
32 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
33 
34 #ifndef FGINPUTSOCKET_H
35 #define FGINPUTSOCKET_H
36 
37 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
38 INCLUDES
39 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
40 
41 #include "FGInputType.h"
42 #include "input_output/FGfdmSocket.h"
43 
44 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
45 FORWARD DECLARATIONS
46 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
47 
48 namespace JSBSim {
49 
50 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
51 CLASS DOCUMENTATION
52 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
53 
58 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
59 CLASS DECLARATION
60 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
61 
62 class FGInputSocket : public FGInputType
63 {
64 public:
66  FGInputSocket(FGFDMExec* fdmex);
67 
69  ~FGInputSocket() override;
70 
74  bool Load(Element* el) override;
75 
80  bool InitModel(void) override;
81 
83  void Read(bool Holding) override;
84 
85 protected:
86 
87  unsigned int SockPort;
88  FGfdmSocket* socket;
89  FGfdmSocket::ProtocolType SockProtocol;
90  std::string data;
91  bool BlockingInput;
92 };
93 }
94 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
95 #endif
JSBSim::FGFDMExec
Encapsulates the JSBSim simulation executive.
Definition: FGFDMExec.h:185
JSBSim::FGfdmSocket
Encapsulates an object that enables JSBSim to communicate via socket (input and/or output).
Definition: FGfdmSocket.h:70
JSBSim::FGInputSocket::Read
void Read(bool Holding) override
Generates the input.
Definition: FGInputSocket.cpp:112
JSBSim::FGInputType
Abstract class to provide functions generic to all the input directives.
Definition: FGInputType.h:73
JSBSim::FGInputSocket::InitModel
bool InitModel(void) override
Initializes the instance.
Definition: FGInputSocket.cpp:95
JSBSim::FGInputSocket
Implements the input from a socket.
Definition: FGInputSocket.h:62
JSBSim::FGInputSocket::~FGInputSocket
~FGInputSocket() override
Destructor.
Definition: FGInputSocket.cpp:67
JSBSim::Element
Definition: FGXMLElement.h:143
JSBSim::FGInputSocket::FGInputSocket
FGInputSocket(FGFDMExec *fdmex)
Constructor.
Definition: FGInputSocket.cpp:59
JSBSim::FGInputSocket::Load
bool Load(Element *el) override
Init the input directives from an XML file.
Definition: FGInputSocket.cpp:74