FGUDPInputSocket Class Reference

Implements a UDP input socket. More...

#include <FGUDPInputSocket.h>

Inheritance diagram for FGUDPInputSocket:

Collaboration diagram for FGUDPInputSocket:

Public Member Functions
	FGUDPInputSocket (FGFDMExec *fdmex)
	Constructor. More...
	~FGUDPInputSocket ()
	Destructor. More...
bool	InitModel (void)
	Initializes the instance. More...
bool	Load (Element *el)
	Reads the property names from an XML file. More...
void	Read (bool Holding)
	Reads the socket and updates properties accordingly.
Public Member Functions inherited from FGInputType
	FGInputType (FGFDMExec *fdmex)
	Constructor (implement the FGModel interface). More...
virtual	~FGInputType ()
	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. More...
bool	Run (bool Holding)
	Executes the input directives (implement the FGModel interface). More...
void	SetIdx (unsigned int idx)
	Set the idx for this input instance. More...
virtual void	SetInputName (const std::string &name)
	Overwrites the name identifier under which the input will be read. More...
bool	Toggle (void)
	Toggles the input generation. More...
Public Member Functions inherited from FGModel
	FGModel (FGFDMExec *)
	Constructor.
virtual	~FGModel ()
	Destructor.
virtual SGPath	FindFullPathName (const SGPath &path) const
FGFDMExec *	GetExec (void)
unsigned int	GetRate (void)
	Get the output rate for the model in frames.
void	SetPropertyManager (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. More...
std::string	GetFunctionValues (const std::string &delimeter) const
	Gets the function values. More...
FGFunction *	GetPreFunction (const std::string &name)
	Get one of the "pre" function. More...
bool	Load (Element *el, FGPropertyManager *PropertyManager, std::string prefix="")
void	PostLoad (Element *el, FGPropertyManager *PropertyManager, std::string prefix="")
void	PreLoad (Element *el, FGPropertyManager *PropertyManager, 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.
std::string	GetVersion (void)
	Returns the version number of JSBSim. More...
void	PutMessage (const Message &msg)
	Places a Message structure on the Message queue. More...
void	PutMessage (const std::string &text)
	Creates a message with the given text and places it on the queue. More...
void	PutMessage (const std::string &text, bool bVal)
	Creates a message with the given text and boolean value and places it on the queue. More...
void	PutMessage (const std::string &text, int iVal)
	Creates a message with the given text and integer value and places it on the queue. More...
void	PutMessage (const std::string &text, double dVal)
	Creates a message with the given text and double value and places it on the queue. More...
int	SomeMessages (void)
	Reads the message on the queue (but does not delete it). More...
void	ProcessMessage (void)
	Reads the message on the queue and removes it from the queue. More...
Message *	ProcessNextMessage (void)
	Reads the next message on the queue and removes it from the queue. More...

Protected Attributes
std::string	data
std::vector< FGPropertyNode_ptr >	InputProperties
double	oldTimeStamp
int	rate
FGfdmSocket *	socket
unsigned int	SockPort
Protected Attributes inherited from FGInputType
bool	enabled
unsigned int	InputIdx
Protected Attributes inherited from FGModel
unsigned int	exe_ctr
FGFDMExec *	FDMExec
FGPropertyManager *	PropertyManager
unsigned int	rate
Protected Attributes inherited from FGModelFunctions
FGPropertyReader	LocalProperties
std::vector< FGFunction * >	PostFunctions
std::vector< FGFunction * >	PreFunctions

Additional Inherited Members
Public Types inherited from FGJSBBase
enum	{ eL = 1, eM, eN }
	Moments L, M, N.
enum	{ eP = 1, eQ, eR }
	Rates P, Q, R.
enum	{ eU = 1, eV, eW }
	Velocities U, V, W.
enum	{ eX = 1, eY, eZ }
	Positions X, Y, Z.
enum	{ ePhi = 1, eTht, ePsi }
	Euler angles Phi, Theta, Psi.
enum	{ eDrag = 1, eSide, eLift }
	Stability axis forces, Drag, Side force, Lift.
enum	{ eRoll = 1, ePitch, eYaw }
	Local frame orientation Roll, Pitch, Yaw.
enum	{ eNorth = 1, eEast, eDown }
	Local frame position North, East, Down.
enum	{ eLat = 1, eLong, eRad }
	Locations Radius, Latitude, Longitude.
enum	{   inNone = 0, inDegrees, inRadians, inMeters,   inFeet }
	Conversion specifiers.
Static Public Member Functions inherited from FGJSBBase
static double	CelsiusToFahrenheit (double celsius)
	Converts from degrees Celsius to degrees Fahrenheit. More...
static double	CelsiusToKelvin (double celsius)
	Converts from degrees Celsius to degrees Kelvin. More...
static double	CelsiusToRankine (double celsius)
	Converts from degrees Celsius to degrees Rankine. More...
static 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. More...
static bool	EqualToRoundoff (float a, float b)
	Finite precision comparison. More...
static bool	EqualToRoundoff (float a, double b)
	Finite precision comparison. More...
static bool	EqualToRoundoff (double a, float b)
	Finite precision comparison. More...
static double	FahrenheitToCelsius (double fahrenheit)
	Converts from degrees Fahrenheit to degrees Celsius. More...
static double	FeetToMeters (double measure)
	Converts from feet to meters. More...
static double	GaussianRandomNumber (void)
static double	KelvinToCelsius (double kelvin)
	Converts from degrees Kelvin to degrees Celsius. More...
static double	KelvinToFahrenheit (double kelvin)
	Converts from degrees Kelvin to degrees Fahrenheit. More...
static double	KelvinToRankine (double kelvin)
	Converts from degrees Kelvin to degrees Rankine. More...
static double	MachFromVcalibrated (double vcas, double p, double psl, double rhosl)
	Calculate the Mach number from the calibrated airspeed. More...
static double	PitotTotalPressure (double mach, double p)
	Compute the total pressure in front of the Pitot tube. More...
static double	RankineToCelsius (double rankine)
	Converts from degrees Rankine to degrees Celsius. More...
static double	RankineToKelvin (double rankine)
	Converts from degrees Rankine to degrees Kelvin. More...
static double	sign (double num)
static double	VcalibratedFromMach (double mach, double p, double psl, double rhosl)
	Calculate the calibrated airspeed from the Mach number. More...
Public Attributes inherited from FGModel
std::string	Name
Static Public Attributes inherited from FGJSBBase
static short	debug_lvl = 1
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
Protected Member Functions inherited from FGInputType
void	Debug (int from)
Protected Member Functions inherited from FGJSBBase
void	Debug (int)
Static Protected Member Functions inherited from FGJSBBase
static std::string	CreateIndexedPropertyName (const std::string &Property, int index)
Static Protected Attributes inherited from FGJSBBase
static const double	degtorad = 0.017453292519943295769236907684886
static const double	fpstokts = 1.0/ktstofps
static const double	fttom = 0.3048
static int	gaussian_random_number_phase = 0
static const double	hptoftlbssec = 550.0
static const double	in3tom3 = 1.638706E-5
static const double	inchtoft = 0.08333333
static const double	inhgtopa = 3386.38
static const std::string	JSBSim_version = "1.0 " __DATE__ " " __TIME__
static const double	kgtolb = 2.20462
static const double	kgtoslug = 0.06852168
static const double	ktstofps = 1.68781
static const double	lbtoslug = 1.0/slugtolb
static Message	localMsg
static const double	m3toft3 = 1.0/(fttom*fttom*fttom)
static double	Mair = 28.9645
static unsigned int	messageId = 0
static std::queue< Message >	Messages
static const std::string	needed_cfg_version = "2.0"
static const double	psftoinhg = 0.014138
static const double	psftopa = 47.88
static const double	radtodeg = 57.295779513082320876798154814105
static double	Reng = 1716.56
static double	Rstar = 1545.348
static const double	SHRatio = 1.40
static const double	slugtolb = 32.174049

Detailed Description

Implements a UDP input socket.

Definition at line 67 of file FGUDPInputSocket.h.

Constructor & Destructor Documentation

FGUDPInputSocket()

FGUDPInputSocket

(

FGFDMExec *

fdmex

)

Constructor.

Definition at line 59 of file FGUDPInputSocket.cpp.

                                                   :
  FGInputType(fdmex),
  socket(0)
{
  rate = 20;
  SockPort = 5139;
  oldTimeStamp = 0.0;
}

~FGUDPInputSocket()

~FGUDPInputSocket

(

)

Destructor.

Definition at line 70 of file FGUDPInputSocket.cpp.

{
  delete socket;
}

Member Function Documentation

InitModel()

bool InitModel ( void  )

virtual

Initializes the instance.

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

Returns

true if the execution succeeded.

Reimplemented from FGInputType.

Definition at line 110 of file FGUDPInputSocket.cpp.

{
  if (FGInputType::InitModel()) {
    delete socket;
    socket = new FGfdmSocket(SockPort, FGfdmSocket::ptUDP, FGfdmSocket::dIN);

    if (socket == 0) return false;
    cout << "UDP input socket established on port " << SockPort << endl;
    return true;
  }

  return false;
}

Here is the call graph for this function:

Load()

bool Load ( Element *  el )

virtual

Reads the property names from an XML file.

Parameters

element

The root XML Element of the input file.

Reimplemented from FGInputType.

Definition at line 77 of file FGUDPInputSocket.cpp.

{
  if (!FGInputType::Load(el))
    return false;
   
  rate = atoi(el->GetAttributeValue("rate").c_str());
  SetRate(0.5 + 1.0/(FDMExec->GetDeltaT()*rate));
   
  SockPort = atoi(el->GetAttributeValue("port").c_str());
  if (SockPort == 0) {
    cerr << endl << "No port assigned in input element" << endl;
    return false;
  }
  
  Element *property_element = el->FindElement("property");

  while (property_element) {
    string property_str = property_element->GetDataLine();
    FGPropertyNode* node = PropertyManager->GetNode(property_str);
    if (!node) {
      cerr << fgred << highint << endl << "  No property by the name "
           << property_str << " can be found." << reset << endl;
    } else {
      InputProperties.push_back(node);
    }
    property_element = el->FindNextElement("property");
  }

  return true;
}

Here is the call graph for this function:

---

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

• FGUDPInputSocket.h
• FGUDPInputSocket.cpp