FGInputSocket Class Reference

Detailed Description

Implements the input from a socket.

This class inputs data from a telnet session. This is a leaf class.

Definition at line 62 of file FGInputSocket.h.

#include <FGInputSocket.h>

Inheritance diagram for FGInputSocket:

Collaboration diagram for FGInputSocket:

Public Member Functions
	FGInputSocket (FGFDMExec *fdmex)
	Constructor.
	~FGInputSocket () override
	Destructor.
bool	InitModel (void) override
	Initializes the instance.
bool	Load (Element *el) override
	Init the input directives from an XML file.
void	Read (bool Holding) override
	Generates the input.
Public Member Functions inherited from FGInputType
	FGInputType (FGFDMExec *fdmex)
	Constructor (implement the FGModel interface).
	~FGInputType () override
	Destructor.
void	Disable (void)
	Disables the input generation.
void	Enable (void)
	Enables the input generation.
virtual const std::string &	GetInputName (void) const
	Get the name identifier to which the input will be directed.
bool	InitModel (void) override
	Init the input model according to its configitation.
bool	Load (Element *el) override
	Init the input directives from an XML file (implement the FGModel interface).
bool	Run (bool Holding) override
	Executes the input directives (implement the FGModel interface).
void	SetIdx (unsigned int idx)
	Set the idx for this input instance.
virtual void	SetInputName (const std::string &name)
	Overwrites the name identifier under which the input will be read.
bool	Toggle (void)
	Toggles the input generation.
Public Member Functions inherited from FGModel
	FGModel (FGFDMExec *)
	Constructor.
	~FGModel () override
	Destructor.
virtual SGPath	FindFullPathName (const SGPath &path) const
FGFDMExec *	GetExec (void)
const std::string &	GetName (void)
unsigned int	GetRate (void)
	Get the output rate for the model in frames.
bool	InitModel (void) override
void	SetPropertyManager (std::shared_ptr< FGPropertyManager > fgpm)
void	SetRate (unsigned int tt)
	Set the ouput rate for the model in frames.
Public Member Functions inherited from FGModelFunctions
std::string	GetFunctionStrings (const std::string &delimeter) const
	Gets the strings for the current set of functions.
std::string	GetFunctionValues (const std::string &delimeter) const
	Gets the function values.
std::shared_ptr< FGFunction >	GetPreFunction (const std::string &name)
	Get one of the "pre" function.
bool	Load (Element *el, FGFDMExec *fdmex, std::string prefix="")
void	PostLoad (Element *el, FGFDMExec *fdmex, std::string prefix="")
void	PreLoad (Element *el, FGFDMExec *fdmex, std::string prefix="")
void	RunPostFunctions (void)
void	RunPreFunctions (void)
Public Member Functions inherited from FGJSBBase
	FGJSBBase ()
	Constructor for FGJSBBase.
virtual	~FGJSBBase ()
	Destructor for FGJSBBase.
void	disableHighLighting (void)
	Disables highlighting in the console output.

Protected Attributes
bool	BlockingInput
std::string	data
FGfdmSocket *	socket
unsigned int	SockPort
FGfdmSocket::ProtocolType	SockProtocol
Protected Attributes inherited from FGInputType
bool	enabled
unsigned int	InputIdx
Protected Attributes inherited from FGModel
unsigned int	exe_ctr
FGFDMExec *	FDMExec
std::string	Name
std::shared_ptr< FGPropertyManager >	PropertyManager
unsigned int	rate
Protected Attributes inherited from FGModelFunctions
FGPropertyReader	LocalProperties
std::vector< std::shared_ptr< FGFunction > >	PostFunctions
std::vector< std::shared_ptr< FGFunction > >	PreFunctions

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
Protected Member Functions inherited from FGInputType
void	Debug (int from) override
Protected Member Functions inherited from FGModel
bool	Upload (Element *el, bool preLoad)
	Uploads this model in memory.
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

FGInputSocket()

FGInputSocket

(

FGFDMExec *

fdmex

)

Constructor.

Definition at line 60 of file FGInputSocket.cpp.

                                             :
  FGInputType(fdmex), socket(0), SockProtocol(FGfdmSocket::ptTCP),
  BlockingInput(false)
{
}

~FGInputSocket()

~FGInputSocket ( )

override

Destructor.

Definition at line 68 of file FGInputSocket.cpp.

{
  delete socket;
}

Member Function Documentation

InitModel()

bool InitModel ( void  )

overridevirtual

Initializes the instance.

This method basically opens the socket to which inputs will be directed.

Returns

true if the execution succeeded.

Reimplemented from FGModelFunctions.

Definition at line 96 of file FGInputSocket.cpp.

{
  if (FGInputType::InitModel()) {
    delete socket;
    socket = new FGfdmSocket(SockPort, SockProtocol);
 
    if (socket == 0) return false;
    if (!socket->GetConnectStatus()) return false;
 
    return true;
  }
 
  return false;
}

Here is the call graph for this function:

Load()

bool Load ( Element *  el )

overridevirtual

Init the input directives from an XML file.

Parameters

element

XML Element that is pointing to the input directives

Reimplemented from FGModel.

Reimplemented in FGUDPInputSocket.

Definition at line 75 of file FGInputSocket.cpp.

{
  if (!FGInputType::Load(el))
    return false;
 
  SockPort = atoi(el->GetAttributeValue("port").c_str());
 
  if (SockPort == 0) {
    cerr << endl << "No port assigned in input element" << endl;
    return false;
  }
 
  string action = el->GetAttributeValue("action");
  if (to_upper(action) == "BLOCKING_INPUT")
    BlockingInput = true;
 
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Read()

void Read ( bool  Holding )

overridevirtual

Generates the input.

Implements FGInputType.

Reimplemented in FGUDPInputSocket.

Definition at line 113 of file FGInputSocket.cpp.

{
  if (!socket) return;
  if (!socket->GetConnectStatus()) return;
 
  if (BlockingInput)
    socket->WaitUntilReadable(); // block until a transmission is received
 
  string raw_data = socket->Receive(); // read data
 
  if (!raw_data.empty()) {
    size_t start = 0;
 
    data += raw_data;
 
    // parse lines
    while (1) {
      size_t string_start = data.find_first_not_of("\r\n", start);
      if (string_start == string::npos) break;
      size_t string_end = data.find_first_of("\r\n", string_start);
      if (string_end == string::npos) break;
      string line = data.substr(string_start, string_end-string_start);
      if (line.empty()) break;
 
      // now parse individual line
      vector <string> tokens = split(line,' ');
 
      string command, argument, str_value;
      if (!tokens.empty()) {
        command = to_lower(tokens[0]);
        if (tokens.size() > 1) {
          argument = trim(tokens[1]);
          if (tokens.size() > 2) {
            str_value = trim(tokens[2]);
          }
        }
      }
 
      if (command == "set") {                       // SET PROPERTY
        SGPropertyNode* node = nullptr;
 
        if (argument.empty()) {
          socket->Reply("No property argument supplied.\r\n");
          break;
        }
        try {
          node = PropertyManager->GetNode(argument);
        } catch(...) {
          socket->Reply("Badly formed property query\r\n");
          break;
        }
 
        if (!node) {
          socket->Reply("Unknown property\r\n");
          break;
        } else if (!node->hasValue()) {
          socket->Reply("Not a leaf property\r\n");
          break;
        } else {
          try {
            double value = atof_locale_c(str_value);
            node->setDoubleValue(value);
          } catch(InvalidNumber& e) {
            string msg(e.what());
            msg += "\r\n";
            socket->Reply(msg);
            break;
          }
        }
        socket->Reply("set successful\r\n");
 
      } else if (command == "get") {             // GET PROPERTY
        SGPropertyNode* node = nullptr;
 
        if (argument.empty()) {
          socket->Reply("No property argument supplied.\r\n");
          break;
        }
        try {
          node = PropertyManager->GetNode(argument);
        } catch(...) {
          socket->Reply("Badly formed property query\r\n");
          break;
        }
 
        if (!node) {
          socket->Reply("Unknown property\r\n");
          break;
        } else if (!node->hasValue()) {
          if (Holding) { // if holding can query property list
            string query = FDMExec->QueryPropertyCatalog(argument, "\r\n");
            socket->Reply(query);
          } else {
            socket->Reply("Must be in HOLD to search properties\r\n");
          }
        } else {
          ostringstream buf;
          buf << argument << " = " << setw(12) << setprecision(6) << node->getDoubleValue() << '\r' << endl;
          socket->Reply(buf.str());
        }
 
      } else if (command == "hold") {               // PAUSE
 
        FDMExec->Hold();
        socket->Reply("Holding\r\n");
 
      } else if (command == "resume") {             // RESUME
 
        FDMExec->Resume();
        socket->Reply("Resuming\r\n");
 
      } else if (command == "iterate") {            // ITERATE
 
        int argumentInt;
        istringstream (argument) >> argumentInt;
        if (argument.empty()) {
          socket->Reply("No argument supplied for number of iterations.\r\n");
          break;
        }
        if ( !(argumentInt > 0) ){
          socket->Reply("Required argument must be a positive Integer.\r\n");
          break;
        }
        FDMExec->EnableIncrementThenHold( argumentInt );
        FDMExec->Resume();
        socket->Reply("Iterations performed\r\n");
 
      } else if (command == "quit") {               // QUIT
 
        // close the socket connection
        socket->Send("Closing connection\r\n");
        socket->Close();
 
      } else if (command == "info") {               // INFO
 
        // get info about the sim run and/or aircraft, etc.
        ostringstream info;
        info << "JSBSim version: " << JSBSim_version << "\r\n";
        info << "Config File version: " << needed_cfg_version << "\r\n";
        info << "Aircraft simulated: " << FDMExec->GetAircraft()->GetAircraftName() << "\r\n";
        info << "Simulation time: " << setw(8) << setprecision(3) << FDMExec->GetSimTime() << '\r' << endl;
        socket->Reply(info.str());
 
      } else if (command == "help") {               // HELP
 
        socket->Reply(
        " JSBSim Server commands:\r\n\r\n"
        "   get {property name}\r\n"
        "   set {property name} {value}\r\n"
        "   hold\r\n"
        "   resume\r\n"
        "   iterate {value}\r\n"
        "   help\r\n"
        "   quit\r\n"
        "   info\r\n\r\n");
 
      } else {
        socket->Reply(string("Unknown command: ") + command + "\r\n");
      }
 
      start = string_end;
    }
 
    // Remove processed commands.
    size_t last_crlf = data.find_last_of("\r\n");
    if (last_crlf != string::npos) {
      if (last_crlf < data.length()-1)
        data = data.substr(last_crlf+1);
      else
        data.clear();
    }
  }
 
}

Here is the call graph for this function:

Member Data Documentation

BlockingInput

bool BlockingInput

protected

Definition at line 91 of file FGInputSocket.h.

data

std::string data

protected

Definition at line 90 of file FGInputSocket.h.

socket

FGfdmSocket* socket

protected

Definition at line 88 of file FGInputSocket.h.

SockPort

unsigned int SockPort

protected

Definition at line 87 of file FGInputSocket.h.

SockProtocol

FGfdmSocket::ProtocolType SockProtocol

protected

Definition at line 89 of file FGInputSocket.h.

---

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

• FGInputSocket.h
• FGInputSocket.cpp