RelatedDoc8643.h File Reference

Reading of supporting text files: More...

Go to the source code of this file.

Classes
struct	XPMP2::Doc8643
	Represents a line in the Doc8643.txt file, of which we use only classification and WTC. More...
struct	XPMP2::Obj8DataRefs
	A pair of strings, first one to search for, second one to replace it with. More...

Namespaces
	XPMP2

Typedefs
typedef std::map< std::string, int >	XPMP2::mapRelatedTy
	Map of group membership: ICAO a/c type maps to line in related.txt. More...
typedef std::map< std::string, Doc8643 >	XPMP2::mapDoc8643Ty
	Map of Doc8643 information, key is the (icao) type code. More...
typedef std::list< Obj8DataRefs >	XPMP2::listObj8DataRefsTy
	a list of Obj8DataRefs definitions More...

Enumerations
enum	XPMP2::RelTxtTy : size_t { XPMP2::REL_TXT_DESIGNATOR = 0 , XPMP2::REL_TXT_OP , XPMP2::REL_TXT_NUM }

Functions
const char *	XPMP2::RelatedLoad (RelTxtTy relType, const std::string &_path)
	Read the related.txt file, full path passed in. More...
const char *	XPMP2::RelatedLoad (const std::string _paths[], size_t _num)
	Load all related files. More...
int	XPMP2::RelatedGet (RelTxtTy relType, const std::string &_key)
	Find the related group for a given key, 0 if none. More...
const char *	XPMP2::Doc8643Load (const std::string &_path)
	Load the content of the provided Doc8643.txt file. More...
const Doc8643 &	XPMP2::Doc8643Get (const std::string &_type)
	Return a reference to the matching Doc8643 object. More...
bool	XPMP2::Doc8643IsTypeValid (const std::string &_type)
	Is the given aircraft type a valid ICAO type as per Doc8643? More...
const char *	XPMP2::Obj8DataRefsLoad (const std::string &_path)
	Load the content of the provided Obj8DataRefs.txt file. More...

Detailed Description

Reading of supporting text files:

• related.txt for creating groups of similar looking aircraft types;
• relOp.txt for creating groups of similar looking operator (liveries)
• Doc8643.txt, the official list of ICAO aircraft type codes;

• Obj8DataRefs.txt, a mapping list for replacing dataRefs in .obj files.

  A related group is declared simply by a line of ICAO a/c type codes read from the file. Internally, the group is just identified by its line number in related.txt. So the group "44" might be "A306 A30B A310", the Airbus A300 series. Similarly, a group of operators is typically a group of mother/subsidiary companies using the same or very similar liveries.

  Doc8643 is a list of information maintained by the ICAO to list all registered aircraft types. Each type designator can appear multiple times in the dataset for slightly differing models, but the classification und the WTC will be the same in all those listing.
  XPMP2 is only interested in type designator, classification, and WTC.

  Author

  Birger Hoppe

  Copyright

  (c) 2020-2024 Birger Hoppe

  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.