/* -*- c -*- 
// ----------------------------------------------------------------------------
// CERTI - HLA RunTime Infrastructure
// Copyright (C) 2002, 2003, 2004  ONERA
//
// This file is part of CERTI
//
// CERTI-libCERTI is free software ; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public License
// as published by the Free Software Foundation ; either version 2 of
// the License, or (at your option) any later version.
//
// CERTI-libCERTI is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY ; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this program ; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// ----------------------------------------------------------------------------
*/
 
/**
 * \page index
 *
 * <h1>Installation Documentation</h1>
 *
 * \verbatim
   XPlane Federation
   4 Federates \endverbatim
 * <ol>
 * <li> command with phydget (see www.phidgets.com) for command</li>
 * <li> command / XPlane (plugin for sending command to XPlane)</li>
 * <li> information from XPlane (plugin for getting values from XPlane)</li>
 * <li> simple viewer (displaying values) </li>
 * </ol>
 *
 * This federation can be broken in 2 sets
 * <ol>
 * <li> "in" for control a airplane (federates 1 + 2) </li>
 * <li> "out" for getting information about airplane status (federates 3 + 4) </li>
 * </ol>
 *
 * Have a look to the next figure
 *
 * \image html "SimulXPlane.png"
 *
 * \verbatim
   You have to get the install directory of XPlane to setup the system
   You must include the libraries XPLM and Widgets from XPlane web site
   Take a look at http://www.xsquawkbox.net/xpsdk/phpwiki/index.php?Documentation\endverbatim
 *
 * Files initPhyDget.txt and initXPlane.txt allow to match FOM values and Federate values
 *
 * Here is a short part of Xplane.fed file (Class Aircraft + 3 first attributes)
 * \verbatim
   (class Aircraft
      (attribute aircraftType reliable timestamp)
      (attribute latitude reliable timestamp)
      (attribute longitude reliable timestamp)\endverbatim
 *
 *
 * Short part from initXPlane.txt (association HLA parameters and XPlane parameters)
 * \verbatim
   Aircraft
   B040!aircraftType=sim/aircraft/view/acf_ICAO
   D001!latitude=sim/flightmodel/position/latitude
   D001!longitude=sim/flightmodel/position/longitude\endverbatim
 *
 * \verbatim
   B040 : means array of 40 bytes
   aircraftType : HLA attribute from FOM
   sim/aircraft/view/acf_ICAO : XPlane name\endverbatim
 *
 * Each federate uses a text file for defining
 * <ol>
 * <li> Federation name
 * <li> FOM file (here XPlane.fed)
 * <li> Dictionary file (initPhyDget.txt or initXPlane.txt)
 * <li> IP address pointing to server (NOT USED!!!)
 * </ol>
 */

