JSBSim Flight Dynamics Model  1.1.11 (13 Feb 2022)
An Open Source Flight Dynamics and Control Software Library in C++
FGOutputSocket.h
1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2 
3  Header: FGOutputSocket.h
4  Author: Bertrand Coconnier
5  Date started: 09/10/11
6 
7  ------------- Copyright (C) 2011 Bertrand Coconnier -------------
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 09/10/11 BC Created
29 
30 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
31 SENTRY
32 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
33 
34 #ifndef FGOUTPUTSOCKET_H
35 #define FGOUTPUTSOCKET_H
36 
37 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
38 INCLUDES
39 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
40 
41 #include "FGOutputType.h"
42 #include "input_output/net_fdm.hxx"
43 #include "input_output/FGfdmSocket.h"
44 
45 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
46 FORWARD DECLARATIONS
47 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
48 
49 namespace JSBSim {
50 
51 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
52 CLASS DOCUMENTATION
53 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
54 
62 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
63 CLASS DECLARATION
64 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
65 
67 {
68 public:
70  FGOutputSocket(FGFDMExec* fdmex);
71 
73  ~FGOutputSocket() override;
74 
83  void SetOutputName(const std::string& name) override;
84 
88  bool Load(Element* el) override;
89 
94  bool InitModel(void) override;
96  void Print(void) override;
97 
102  void SocketStatusOutput(const std::string& out_str);
103 
104 protected:
105  virtual void PrintHeaders(void);
106 
107  std::string SockName;
108  unsigned int SockPort;
109  FGfdmSocket::ProtocolType SockProtocol;
110  FGfdmSocket* socket;
111  int precision;
112 };
113 }
114 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
115 #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::FGOutputType
Abstract class to provide functions generic to all the output directives.
Definition: FGOutputType.h:90
JSBSim::FGOutputSocket::InitModel
bool InitModel(void) override
Initializes the instance.
Definition: FGOutputSocket.cpp:135
JSBSim::FGOutputSocket::Print
void Print(void) override
Generates the output.
Definition: FGOutputSocket.cpp:279
JSBSim::FGOutputSocket::Load
bool Load(Element *el) override
Init the output directives from an XML file.
Definition: FGOutputSocket.cpp:115
JSBSim::FGOutputSocket::SetOutputName
void SetOutputName(const std::string &name) override
Overwrites the name identifier under which the output will be logged.
Definition: FGOutputSocket.cpp:83
JSBSim::FGOutputSocket::FGOutputSocket
FGOutputSocket(FGFDMExec *fdmex)
Constructor.
Definition: FGOutputSocket.cpp:68
JSBSim::FGOutputSocket::SocketStatusOutput
void SocketStatusOutput(const std::string &out_str)
Outputs a status thru the socket.
Definition: FGOutputSocket.cpp:392
JSBSim::FGOutputSocket::~FGOutputSocket
~FGOutputSocket() override
Destructor.
Definition: FGOutputSocket.cpp:76
JSBSim::Element
Definition: FGXMLElement.h:143
JSBSim::FGOutputSocket
Implements the output to a socket.
Definition: FGOutputSocket.h:66