module-flightgear.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	FGNetFDMWordSet
struct	FGNetCtrlsWordSet
struct	FieldInfo
struct	FlightGearStreamOutputReader
struct	FlightGearFileDriveReader
struct	FlightGearFileDriveCallerTypeReader
class	FGNetFDMStreamDriveCopyCast
class	FGNetCtrlsStreamDriveCopyCast

Typedefs
typedef struct FieldInfo	FieldInfo
typedef std::map< std::string, FieldInfo >	FieldsDescriptionFG
typedef std::map< std::string, ScalarValue * >	FlightGearUserChannels

Functions
int	module_init (const char *module_name, void *pdm, void *php)
	This function registers our user defined element for the math parser. More...
void	buildFieldsDescriptionFG (void)
void	readFGStructuresFromFile (const char *filePath, std::string currentVersionLabel, FieldsDescriptionFG &fieldsDescriptionFG, int &currentVersion)
void	printOptionsOnTextFile (const char *fileName, FieldsDescriptionFG &fieldsDescriptionFG)
void	buildFGBufCast (std::vector< BufCast * > &data, FieldsDescriptionFG &fieldsDescriptionFGInUse)
BufCast *	buildOneFGBufCast (size_t &offset, TypeMap_t &swapmap, const std::type_info &fieldType)

Variables
FGNetFDMWordSet	fGNetFDMWordSet
FGNetCtrlsWordSet	fGNetCtrlsWordSet
FieldsDescriptionFG	fieldsDescriptionFGNetFDM
FieldsDescriptionFG	fieldsDescriptionFGNetCtrls
int	FGNetFDMCurVersion
int	FGNetCtrlsCurVersion
HighParser::WordSet *	sendToFGWordSetInUse

Typedef Documentation

typedef struct FieldInfo FieldInfo

Definition at line 19 of file module-flightgear.h.

typedef std::map<std::string, FieldInfo> FieldsDescriptionFG

Definition at line 21 of file module-flightgear.h.

typedef std::map<std::string, ScalarValue *> FlightGearUserChannels

Definition at line 40 of file module-flightgear.h.

Function Documentation

void buildFGBufCast	(	std::vector< BufCast * > &	data,
		FieldsDescriptionFG &	fieldsDescriptionFGInUse
	)

Definition at line 312 of file module-flightgear.cc.

References bIsLittleEndian(), buildOneFGBufCast(), and SwapMapInit().

Referenced by FlightGearStreamOutputReader::buildFGStreamContentModifier(), and FlightGearFileDriveReader::buildFGStreamDriveModifier().

                                                                                              {
                TypeMap_t swapmap;
                SwapMapInit(swapmap);

                //every type must be reversed for FG communication! (FG expects big-endian format data)
                if(bIsLittleEndian()){
                  for(TypeMap_t::iterator i = swapmap.begin() ; i != swapmap.end() ; i++){
                                i->second = true;
                        }
                }

                for (FieldsDescriptionFG::iterator it = fieldsDescriptionFGInUse.begin() ; it != fieldsDescriptionFGInUse.end() ; it++){
                        data[it->second.position-1] = buildOneFGBufCast(it->second.offset, swapmap, it->second.type);
                }
        }

Here is the call graph for this function:

void buildFieldsDescriptionFG

(

void

)

Definition at line 91 of file module-flightgear.cc.

References fieldsDescriptionFGNetCtrls, fieldsDescriptionFGNetFDM, and readFGStructuresFromFile().

Referenced by module_init().

                                   {
        //FGStructuresLoaded = true;
        readFGStructuresFromFile("FG_structures/FGNetFDM_structure.txt", "FG_NET_FDM_VERSION", fieldsDescriptionFGNetFDM, FGNetFDMCurVersion);
        readFGStructuresFromFile("FG_structures/FGNetCtrls_structure.txt", "FG_NET_CTRLS_VERSION", fieldsDescriptionFGNetCtrls, FGNetCtrlsCurVersion);
}

Here is the call graph for this function:

BufCast* buildOneFGBufCast	(	size_t &	offset,
		TypeMap_t &	swapmap,
		const std::type_info &	fieldType
	)

Definition at line 328 of file module-flightgear.cc.

Referenced by buildFGBufCast().

                                                                                             {
                BufCast *pBC(0);

                if (fieldType == typeid(int8_t)) {
                        TypeMap_t::const_iterator i = swapmap.find(typeid(int8_t).name());
                        if (i->second) {
                                pBC = new TBufCastHToN<int8_t>(offset);
                        } else {
                                pBC = new TBufCast<int8_t>(offset);
                        }

                } else if (fieldType == typeid(uint8_t)) {
                        TypeMap_t::const_iterator i = swapmap.find(typeid(uint8_t).name());
                        if (i->second) {
                                pBC = new TBufCastHToN<uint8_t>(offset);
                        } else {
                                pBC = new TBufCast<uint8_t>(offset);
                        }

                } else if (fieldType == typeid(int16_t)) {
                        TypeMap_t::const_iterator i = swapmap.find(typeid(int16_t).name());
                        if (i->second) {
                                pBC = new TBufCastHToN<int16_t>(offset);
                        } else {
                                pBC = new TBufCast<int16_t>(offset);
                        }

                } else if (fieldType == typeid(uint16_t)) {
                        TypeMap_t::const_iterator i = swapmap.find(typeid(uint16_t).name());
                        if (i->second) {
                                pBC = new TBufCastHToN<uint16_t>(offset);
                        } else {
                                pBC = new TBufCast<uint16_t>(offset);
                        }

                } else if (fieldType == typeid(int32_t)) {
                        TypeMap_t::const_iterator i = swapmap.find(typeid(int32_t).name());
                        if (i->second) {
                                pBC = new TBufCastHToN<int32_t>(offset);
                        } else {
                                pBC = new TBufCast<int32_t>(offset);
                        }

                } else if (fieldType == typeid(uint32_t)) {
                        TypeMap_t::const_iterator i = swapmap.find(typeid(uint32_t).name());
                        if (i->second) {
                                pBC = new TBufCastHToN<uint32_t>(offset);
                        } else {
                                pBC = new TBufCast<uint32_t>(offset);
                        }

                } else if (fieldType == typeid(float)) {
                        TypeMap_t::const_iterator i = swapmap.find(typeid(float).name());
                        if (i->second) {
                                pBC = new TBufCastHToN<float>(offset);
                        } else {
                                pBC = new TBufCast<float>(offset);
                        }

                } else if (fieldType == typeid(double)) {
                        TypeMap_t::const_iterator i = swapmap.find(typeid(double).name());
                        if (i->second) {
                                pBC = new TBufCastHToN<double>(offset);
                        } else {
                                pBC = new TBufCast<double>(offset);
                        }

                }

                return pBC;
        }

int module_init	(	const char *	module_name,
		void *	pdm,
		void *	php
	)

This function registers our user defined element for the math parser.

It is called when the "module load" statement appears in the input file.

Definition at line 1219 of file module-aerodyn.cc.

References asynchronous_machine_set(), autodiff_test_set(), ballbearing_contact_set(), MathParser::bNameValidate(), buildFieldsDescriptionFG(), IncludeParser::GetFileName(), IncludeParser::GetLineData(), HighParser::GetMathParser(), HighParser::GetString(), hydrodynamic_plain_bearing_set(), inline_friction_set(), HighParser::IsArg(), journal_bearing_set(), MBDYN_EXCEPT_ARGS, mbdyn_octave_set(), minmaxdrive_set(), nodedistdrive_set(), path, pHP, MathParser::RegisterNameSpace(), MathParser::RegisterPlugIn(), SetCL1D(), SetCL3D(), SetCL6D(), SetDC3D(), SetDescData(), SetDriveCallerData(), SetDriveData(), setFileDriveCallerType(), SetFileDriveContentType(), SetSF(), SetStreamOutputContentType(), SetUDE(), switch_drive_set(), tcl_plugin(), and wheel2_set().

{
        UserDefinedElemRead *rf = new UDERead<AeroDynModule>;

        if (!SetUDE("aerodyn", rf)) {
                delete rf;

                silent_cerr("module-aerodyn: "
                        "module_init(" << module_name << ") "
                        "failed" << std::endl);

                return -1;
        }

        return 0;
}

Here is the call graph for this function:

void printOptionsOnTextFile	(	const char *	fileName,
		FieldsDescriptionFG &	fieldsDescriptionFG
	)

Definition at line 292 of file module-flightgear.cc.

References MBDYN_EXCEPT_ARGS.

Referenced by FlightGearStreamOutputReader::Read(), and FlightGearFileDriveReader::Read().

                                                                                            {
        std::ofstream outFile;
        outFile.open(fileName);

        if(!outFile.is_open()){
                silent_cerr("Error while writing on file: " << fileName << ", impossible to open it" << std::endl);
                throw ErrGeneric(MBDYN_EXCEPT_ARGS);
        }

        for(int i = 0 ; i < (int)fieldsDescriptionFG.size() ; i++){
                for(FieldsDescriptionFG::iterator it = fieldsDescriptionFG.begin() ; it != fieldsDescriptionFG.end() ; it++){
                        if(it->second.position == i+1){
                          outFile << it->first << std::endl;
                        }
                }
        }

  outFile.close();
        }

void readFGStructuresFromFile	(	const char *	filePath,
		std::string	currentVersionLabel,
		FieldsDescriptionFG &	fieldsDescriptionFG,
		int &	currentVersion
	)

Definition at line 97 of file module-flightgear.cc.

References MBDYN_EXCEPT_ARGS.

Referenced by buildFieldsDescriptionFG().

                                                                                                                                                 {

        std::string fieldNameDelimiter = ":";//after name field this character must occur
        std::string fieldInfoDelimiter = "= ";//before field info (type, size, offset) this character must occur
        std::string fieldInfoSeparator = ",";//field info (type, size, offset) are comma separated
        std::string openSquareBracket = "[";//used to identify fields with multiple entities (array)

        std::ifstream infile(filePath);

        /*checks if file is correctly opened*/
        if(!infile.is_open()){
          silent_cerr("Error while loading of " << filePath << ": file not found" << std::endl);
          throw ErrGeneric(MBDYN_EXCEPT_ARGS);
        }

        std::string line; /*the file is read by lines: every line is temporary stored inside of this object*/
        std::getline(infile, line);/*gets first line of the file, where field 'version' should be stored*/

        /*checks if file is empty*/
        if(infile.eof()){
          silent_cerr("Error while reading " << filePath << ": file is empty"<< std::endl);
          throw ErrGeneric(MBDYN_EXCEPT_ARGS);
        }

        /*reads current version*/

        if(line.find(currentVersionLabel) == std::string::npos){/*checks if version is present and it is the first field*/
          silent_cerr("Error while reading " << filePath << ": " << currentVersionLabel << " not found at line '" << line.substr(0, line.size()-1) << "'" << std::endl);
          throw ErrGeneric(MBDYN_EXCEPT_ARGS);
        }
        std::size_t found = line.find(fieldInfoDelimiter);/*finds delimiter before version value*/
        if(found == std::string::npos){/*checks if delimiter is present before version value*/
          silent_cerr("Error while reading " << filePath << ": " << "delimiter '" << fieldInfoDelimiter << "' not found after " << currentVersionLabel << std::endl);
          throw ErrGeneric(MBDYN_EXCEPT_ARGS);
        }
        /*acquisition of the version value*/

        std::string value = std::string();
        for(int i = 0 ; isdigit(line.at(found + fieldInfoDelimiter.size() + i)) ; i++){
          char digit = line.at(found + fieldInfoDelimiter.size() + i);
          std::stringstream ss;
          ss << digit;
          std::string tmp;
          ss >> tmp;
          value.append(tmp);
        }

        if(value.size() == 0){/*checks if version value is present in the file*/
          silent_cerr("Error while reading " << filePath << ": " << " missing value of " << currentVersionLabel << " at line '" << line.substr(0, line.size()-1) << "'" << std::endl);
          throw ErrGeneric(MBDYN_EXCEPT_ARGS);
        }

        std::stringstream tmpss1;
        tmpss1 << value;
        tmpss1 >> currentVersion; //stores the acquired value inside of FGNetFDMCurVersion/FGNetCtrlsCurVersion

        /*reads all of the other fields*/

        int fieldPosition = 1; /*used to register every field with its proper position*/
        do{
          std::getline(infile, line);
          if(!infile.eof()){

                                /*reads field name*/

              std::string fieldName; /*stores the name of field read from the file*/
              found = line.find(fieldNameDelimiter); /*searches for name delimiter in order to acquire field name*/
              if(found == std::string::npos){/*checks if delimiter is missing*/
                silent_cerr("Error while reading " << filePath << ": " << "delimiter '" << fieldNameDelimiter << "' not found at line '" << line.substr(0,line.size()-1) << "'" << std::endl);
                throw ErrGeneric(MBDYN_EXCEPT_ARGS);
              }
              fieldName = line.substr(0, found); /*collects only the part of the current line containing the field name*/
              found = line.find(fieldInfoDelimiter);/*ex: eng_state: type, size, offset = unsigned int [4], 16, 124 finds where '= ' is located*/
              if(found == std::string::npos){
                silent_cerr("Error while reading " << filePath << ": " << "delimiter '" << fieldInfoDelimiter << "' not found for field '" << fieldName << "'" << std::endl);
                throw ErrGeneric(MBDYN_EXCEPT_ARGS);
              }
              std::string fieldInfoRawString = line.substr(line.find(fieldInfoDelimiter) + fieldInfoDelimiter.size(), line.size()); //ex: "unsigned int [4], 16, 124"

                                /*reads field type*/

              found = fieldInfoRawString.find(openSquareBracket);
              int fieldNumOfElem; //store how many elements that field has (ex array fields will have fieldNumOfElem > 1)
                                std::string typeFullName;
              if(found != std::string::npos){/*field is an array: '[' found inside of the current line*/
                /*reads the number inside of []*/
                value = std::string();
                for(int i = 0 ; isdigit(fieldInfoRawString.at(found + openSquareBracket.size() + i)) ; i++){
                  char digit = fieldInfoRawString.at(found + openSquareBracket.size() + i);
                  std::stringstream ss;
                  ss << digit;
                  std::string tmp;
                  ss >> tmp;
                  value.append(tmp);
                }
                if(value.size() == 0){/*checks if [] are empty*/
                  silent_cerr("Error while reading " << filePath << ": " << " empty brackets for field '" << fieldName << "' at line '" << line.substr(0, line.size()-1) << "'" << std::endl);
                  throw ErrGeneric(MBDYN_EXCEPT_ARGS);
                }
                std::stringstream tmpss2;
                tmpss2 << value;
                tmpss2 >> fieldNumOfElem;

                typeFullName = fieldInfoRawString.substr(0, found-1); //ex: gets "unsigned int" from current line*/
                found = fieldInfoRawString.find(fieldInfoSeparator); //finds the first comma
              }else{
                fieldNumOfElem = 1; /*the current field is a single-variable field*/
                found = fieldInfoRawString.find(fieldInfoSeparator); //finds the first comma
                                        if(found != std::string::npos){
                        typeFullName = fieldInfoRawString.substr(0, found);
                                        }
              }

                                /*checks if both info separators ',' are missing*/
                                if(found == std::string::npos){
                                        silent_cerr("Error while reading " << filePath << ": " << "both info separators '" <<fieldInfoSeparator << "' missing for field '" << fieldName << "' at line '" << line.substr(0, line.size()-1) << "'" << std::endl);
                                        throw ErrGeneric(MBDYN_EXCEPT_ARGS);
                                }

                                /*checks if one info separator ',' are missing*/
                                std::string tmp = fieldInfoRawString.substr(found+1, fieldInfoRawString.size());
                                if(tmp.find(fieldInfoSeparator) == std::string::npos){
                                        silent_cerr("Error while reading " << filePath << ": " << "missing info separator '" <<fieldInfoSeparator << "' for field '" << fieldName << "' at line '" << line.substr(0, line.size()-1) << "'" << std::endl);
                                        throw ErrGeneric(MBDYN_EXCEPT_ARGS);
                                }

              std::string sizeAndOffsetRawString = fieldInfoRawString.substr(found+1, fieldInfoRawString.size()); /*ex: got " 16, 124" */
              found = sizeAndOffsetRawString.find(fieldInfoSeparator); /*gets second comma in the current line (between size and offset)*/

              /*reads offset*/
              int offset;
              value = std::string();
             for(int i = 0 ; isdigit(sizeAndOffsetRawString.at(found+2+i)) && found+2+i < sizeAndOffsetRawString.size() ; i++){
                char digit = sizeAndOffsetRawString.at(found+2+i);
                std::stringstream ss;
                ss << digit;
                std::string tmp;
                ss >> tmp;
                value.append(tmp);
              }

              if(value.size() == 0){/*checks if offset is missing*/
                silent_cerr("Error while reading " << filePath << ": " << " missing offset for field '" << fieldName << "' at line '" << line.substr(0, line.size()-1) << "'" << std::endl);
                throw ErrGeneric(MBDYN_EXCEPT_ARGS);
              }

              std::stringstream tmpss3;
              tmpss3 << value;
              tmpss3 >> offset;

              /*once all information has been acquired, field is registered inside of fieldsDescriptionFG*/

              for(int i = 0 ; i < fieldNumOfElem ; i++){//creates 'fieldNumOfElem' entries for the current field
                std::string label = std::string();
                std::string finalFieldName = std::string(fieldName);

                if(fieldNumOfElem > 1){
                  label = std::string("_");
                  std::string num;
                  std::stringstream convert;
                  convert << i+1;
                  num = convert.str();

                  if(fieldNumOfElem < 10){
                    label.append("0");
                                                }

                  label.append(num);
                }
                finalFieldName.append(label);

                if(typeFullName.compare("unsigned int") == 0){
                  fieldsDescriptionFG.insert(FieldsDescriptionFG::value_type(finalFieldName,{typeid(uint32_t),sizeof(uint32_t),fieldPosition,offset+sizeof(uint32_t)*i}));
                                        }else if(typeFullName.compare("int") == 0){
                    fieldsDescriptionFG.insert(FieldsDescriptionFG::value_type(finalFieldName,{typeid(int32_t),sizeof(int32_t),fieldPosition,offset+sizeof(int32_t)*i}));
                }else if(typeFullName.compare("float") == 0){
                  fieldsDescriptionFG.insert(FieldsDescriptionFG::value_type(finalFieldName,{typeid(float),sizeof(float),fieldPosition,offset+sizeof(float)*i}));
                }else if(typeFullName.compare("double") == 0){
                  fieldsDescriptionFG.insert(FieldsDescriptionFG::value_type(finalFieldName,{typeid(double),sizeof(double),fieldPosition,offset+sizeof(double)*i}));
                                        }else{
                                                silent_cerr("Error while reading " << filePath << ": " << " unknown type for field '" << fieldName << "' at line '" << line.substr(0, line.size()-1) << "'" << std::endl);
                                                throw ErrGeneric(MBDYN_EXCEPT_ARGS);
                                        }

                                        fieldPosition++;
              }
          }else if(fieldPosition == 1){
                        silent_cerr("Error while reading " << filePath << ": " << " file does not contain any field description" << std::endl);
                        throw ErrGeneric(MBDYN_EXCEPT_ARGS);
                }
        }while(!infile.eof());

        infile.close();
}

Variable Documentation

int FGNetCtrlsCurVersion

Definition at line 56 of file module-flightgear.cc.

Referenced by FlightGearStreamOutputReader::setDefaultValues().

FGNetCtrlsWordSet fGNetCtrlsWordSet

Definition at line 51 of file module-flightgear.cc.

Referenced by FlightGearStreamOutputReader::Read(), FlightGearFileDriveCallerTypeReader::Read(), and FlightGearStreamOutputReader::setDefaultValues().

int FGNetFDMCurVersion

Definition at line 55 of file module-flightgear.cc.

Referenced by FlightGearStreamOutputReader::setDefaultValues().

FGNetFDMWordSet fGNetFDMWordSet

Definition at line 50 of file module-flightgear.cc.

Referenced by FlightGearStreamOutputReader::Read(), FlightGearFileDriveCallerTypeReader::Read(), and FlightGearStreamOutputReader::setDefaultValues().

FieldsDescriptionFG fieldsDescriptionFGNetCtrls

Definition at line 54 of file module-flightgear.cc.

Referenced by FlightGearFileDriveReader::buildFGStreamDriveModifier(), buildFieldsDescriptionFG(), FGNetCtrlsWordSet::IsWord(), FlightGearStreamOutputReader::Read(), FlightGearFileDriveReader::Read(), and FlightGearFileDriveCallerTypeReader::Read().

FieldsDescriptionFG fieldsDescriptionFGNetFDM

Definition at line 53 of file module-flightgear.cc.

Referenced by FlightGearFileDriveReader::buildFGStreamDriveModifier(), buildFieldsDescriptionFG(), FGNetFDMWordSet::IsWord(), FlightGearStreamOutputReader::Read(), FlightGearFileDriveReader::Read(), and FlightGearFileDriveCallerTypeReader::Read().

HighParser::WordSet* sendToFGWordSetInUse

Definition at line 51 of file sendToFlightgear.cc.