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, bool isEnabled)
	Constructor.

void	Disable () override
	Disables the input generation.

void	Enable () override
	Methods to enable, disable and toggle the input.

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.

bool	Toggle () override
	Toggles the input generation.

Public Member Functions inherited from FGInputType
	FGInputType (FGFDMExec *fdmex, bool isEnabled=true)
	Constructor (implement the FGModel interface).

	~FGInputType () override
	Destructor.

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.

Public Member Functions inherited from FGModel
	FGModel (FGFDMExec *, const std::string &name)
	Constructor.

	~FGModel () override
	Destructor.

virtual SGPath	FindFullPathName (const SGPath &path) const

FGFDMExec *	GetExec (void) const

const std::string &	GetName (void) const

unsigned int	GetRate (void) const
	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.

Protected Member Functions
bool	CreateSocket ()

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.

Protected Attributes
bool	BlockingInput

std::string	data

std::unique_ptr< FGfdmSocket >	socket

unsigned int	SockPort

FGfdmSocket::ProtocolType	SockProtocol

Protected Attributes inherited from FGInputType
unsigned int	InputIdx

Protected Attributes inherited from FGModel
bool	enabled = true

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 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	CelsiusToRankine (double celsius)
	Converts from degrees Celsius to degrees Rankine.

static constexpr double	Constrain (double min, double value, double max)
	Constrain a value between a minimum and a maximum value.

static bool	EqualToRoundoff (double a, double b)
	Finite precision comparison.

static bool	EqualToRoundoff (double a, float b)
	Finite precision comparison.

static bool	EqualToRoundoff (float a, double b)
	Finite precision comparison.

static bool	EqualToRoundoff (float a, float b)
	Finite precision comparison.

static constexpr double	FahrenheitToCelsius (double fahrenheit)
	Converts from degrees Fahrenheit to degrees Celsius.

static constexpr double	FeetToMeters (double measure)
	Converts from feet to meters.

static const std::string &	GetVersion (void)
	Returns the version number of JSBSim.

static constexpr double	KelvinToCelsius (double kelvin)
	Converts from degrees Kelvin to degrees Celsius.

static constexpr double	KelvinToFahrenheit (double kelvin)
	Converts from degrees Kelvin to degrees Fahrenheit.

static constexpr double	KelvinToRankine (double kelvin)
	Converts from degrees Kelvin to degrees Rankine.

static constexpr double	RankineToCelsius (double rankine)
	Converts from degrees Rankine to degrees Celsius.

static constexpr double	RankineToKelvin (double rankine)
	Converts from degrees Rankine to degrees Kelvin.

static constexpr double	sign (double num)

Static Public Attributes inherited from FGJSBBase
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	degtorad = M_PI / 180.

static constexpr double	fpstokts = 1.0 / ktstofps

static constexpr double	fttom = 0.3048

static constexpr double	hptoftlbssec = 550.0

static constexpr double	in3tom3 = inchtoftinchtoftinchtoft/m3toft3

static constexpr double	inchtoft = 1.0/12.0

static constexpr double	inhgtopa = 3386.38

static const std::string	JSBSim_version = JSBSIM_VERSION " " __DATE__ " " __TIME__

static constexpr double	kgtolb = 2.20462

static constexpr double	kgtoslug = 0.06852168

static constexpr double	ktstofps = 1852./(3600*fttom)

static constexpr double	lbtoslug = 1.0/slugtolb

static constexpr double	m3toft3 = 1.0/(fttomfttomfttom)

static const std::string	needed_cfg_version = "2.0"

static constexpr double	psftoinhg = 0.014138

static constexpr double	psftopa = 47.88

static constexpr double	radtodeg = 180. / M_PI

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.

Constructor & Destructor Documentation

◆ FGInputSocket()

FGInputSocket	(	FGFDMExec *	fdmex,
		bool	isEnabled
	)

Constructor.

Definition at line 56 of file FGInputSocket.cpp.

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

Member Function Documentation

◆ CreateSocket()

bool CreateSocket ( )

protected

Definition at line 99 of file FGInputSocket.cpp.

{
  socket = std::make_unique<FGfdmSocket>(SockPort, SockProtocol);
 
  if (!socket) return false;
  if (!socket->GetConnectStatus()) return false;
 
  return true;
}

◆ Disable()

void Disable ( void )

overridevirtual

Disables the input generation.

Reimplemented from FGInputType.

Definition at line 120 of file FGInputSocket.cpp.

{
  FGInputType::Disable();
  socket.reset();
}

Here is the call graph for this function:

◆ Enable()

void Enable ( void )

overridevirtual

Methods to enable, disable and toggle the input.

Reimplemented from FGInputType.

Definition at line 111 of file FGInputSocket.cpp.

{
  if (enabled) return; // already enabled
  FGInputType::Enable();
  CreateSocket();
}

Here is the call graph for this function:

◆ 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 86 of file FGInputSocket.cpp.

{
  if (!FGInputType::InitModel())
    return false;
 
  if (enabled)
    return CreateSocket();
 
  return true;
}

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 64 of file FGInputSocket.cpp.

{
  if (!FGInputType::Load(el))
    return false;
 
  SockPort = atoi(el->GetAttributeValue("port").c_str());
 
  if (SockPort == 0) {
    FGXMLLogging log(el, LogLevel::ERROR);
    log << "No port assigned in input element\n";
    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 141 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()) {
          // Not a leaf: return the matching entries from the (static) property
          // catalog. This is a read-only lookup, so it no longer requires the
          // client to place the sim in HOLD first.
          socket->Reply(FDMExec->QueryPropertyCatalog(argument, "\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:

◆ Toggle()

bool Toggle ( void )

overridevirtual

Toggles the input generation.

Returns: the input generation status i.e. true if the input has been enabled, false if the input has been disabled.

Reimplemented from FGInputType.

Definition at line 128 of file FGInputSocket.cpp.

{
  bool enabled_status = FGInputType::Toggle();
  if (enabled_status)
    CreateSocket();
  else
    socket.reset();
 
  return enabled_status;
}

Here is the call graph for this function:

Member Data Documentation

◆ BlockingInput

bool BlockingInput

protected

Definition at line 95 of file FGInputSocket.h.

◆ data

std::string data

protected

Definition at line 94 of file FGInputSocket.h.

◆ socket

std::unique_ptr<FGfdmSocket> socket

protected

Definition at line 92 of file FGInputSocket.h.

◆ SockPort

unsigned int SockPort

protected

Definition at line 91 of file FGInputSocket.h.

◆ SockProtocol

FGfdmSocket::ProtocolType SockProtocol

protected

Definition at line 93 of file FGInputSocket.h.

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

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ FGInputSocket()

Member Function Documentation

◆ CreateSocket()

◆ Disable()

◆ Enable()

◆ InitModel()

◆ Load()

◆ Read()

◆ Toggle()

Member Data Documentation

◆ BlockingInput

◆ data

◆ socket

◆ SockPort

◆ SockProtocol