Read Me

This documentation describes the architecture and design of the LibNav library.

INTRODUCTION:

LibNav is a library of support routines designed for use by programmers
developing applications in the navigation area. It is characterized by the 
following:

 - Modern, ANSI C++; highly object oriented.
 - Uses templates, the Standard Template Library (STL) and iostreams classes.
 - Portable and platform independent.


NAMESPACES:

All LibNav code is placed within the libnav namespace. Within the libnav
namespace, other namespaces are defined for certain specialized
functionality. For instance: libnav::StringUtils in the String utilities
module.

Namespace std is also used throughout the LibNav.


LIBRARY CONTENT:

The library consists of several modules, which are more or less dependent upon
each other. These include:

 - Exceptions for use throughout the library.
 - STL "helpers".
 - String utilities.
 - Command line options.
 - Time management classes.
 - Astronomical utilities.
 - Statistical utilities and distributions.
 - Vector and Matrix algorithms.
 - Mathematical algorithms.
 - Basic application frameworks.
 - Kinematic simulation of vehicles.
 - Simulation of navigation aids (VOR/DME).


GPSTK ACKNOWLEDGEMENT:

The base code of the LibNav is taken from the "GPS Toolkit" Project (GPSTk).
We thanks the GPSTk developers for their great work.

More information about the GPSTk may be found at:

http://www.gpstk.org


DOCUMENTATION:

A complete documentation for LibNav may be generated using the "Doxygen" tool.

In order to achieve this, change to the "doc" directory and issue "doxygen".

More information about Doxygen may be found at:

http://www.doxygen.org/