This guide will help you to start your first NAVlib application. The guide will walk you through all the stages necessary to run the Example applications. It is broken down into the following sections:
Installing
A stand-alone installer is available for the NAVsdk and can be obtained by clicking Request installer. The installer installs all files under the NAVsdk folder:
The documentation folder contains all of the documentation available for NAVlib, see the Further Documentation section of this document for information about these documents. The examples contain a Visual Studio 2017 solution with many example projects showing the main uses of NAVlib. This folder is self-contained and can be used outside this folder. The NAVlib folder contains the NAVlib dlls and xml documentation files.
A link to the examples and documentation are available from the Start Menu.
Adding References
NAVlib is a .NET library and uses .NET Framework 4.6.1. It can be used from any language which supports the .NET platform
To use NAVlib from within Microsoft Visual Studio simply add a reference to the 2 NAVlib Dlls within your project:
The NAVlib functionality is enclosed in the OxTS.NavLib namespace.
Getting Started
Background information
The main classes of NAVlib are contained in the DataStoreManager dll:
- OxTS.NavLib.DataStoreManager.RealTimeDataStoreManager
Class to controls all aspects of the realtime data store. - OxTS. NavLib.DataStoreManager.FileDataStoreManager
Class controls all aspects of the file datastore.
These two classes both inherit the IDataStoreManager and work very similarly for adding measurements to a stream and querying information from the data store. Where they differ is in how the streams are added and how the data is read from the streams.
In RealtimeDataStore the streams are coming from live devices (or file replays acting as a live device).
In FileDataStore the streams come from files added to the data store.
Examples
Included in the installer is an examples folder containing a Visual Studio 2017 solution with many example applications showing the functionality available in NAVlib.
There are also example plugins, to see these plugins in action you must enter your licence into the GetNAVlibLicense function and copy the created dll into the NAVdisplay plugins folder (C:\Program Files (x86)\OxTS\NAVdisplay\plugins). The plugin should then be available from the Utilities menu inside NAVdisplay. If the license is invalid the plugin will not appear in this list.
NAVsuite 2.2 is required to run the plugins.
The other projects contain a license file (NAVlib.lic) as an embedded resource. This is used to verify the user. Please open this file and edit the details to those provided to you. If this license is invalid an exception will be thrown at runtime and the datastore will not be created.
Further Documentation
- See the NAVlib Manual for more information on using NAVlib.
- Included in the installer is a full reference document containing documentation for all classes and functions in NAVlib. If using Microsoft Visual Studio this documentation is also available through the Intellisense.
- Example applications are included, showing both the functionality of the realtime data store manager and file data store manager.
- Documentation containing information for every measurement for available in NAVlib has also been included. A separate document is available for BCOM, Nav and RCOM streams.
Comments
0 comments
Please sign in to leave a comment.