LybinCom 6.0 : description of the binary interface

Abstract

The acoustic ray trace model LYBIN is a well established and frequently used sonar prediction model owned by the Norwegian Defence Logistic Organisation. The model is used aboard navy vessels as well as in training situations on shore. LYBIN has become an important tool in both planning and evaluation of maritime operations, and earlier versions are already integrated in combat system software, tactical decision aids and tactical trainers. The calculation kernel of LYBIN is now implemented as a software module called LybinCom. In addition there exists a graphical user interface which can be used together with LybinCom to build a stand-alone executive application. We call this stand-alone executive application LYBIN. An implementation as a software module makes LybinCom suitable for integration with other applications, and enables LybinCom to interact with other applications such as other mathematical models, web services, geographical information systems and more. Different from earlier versions, third parties can now integrate LybinCom in their software without needing access to the source code. LybinCom has two different interfaces for data exchange with other software. The two interfaces are the binary interface and the eXtensible Markup Language (XML) interface. The binary interface enables fast transportation of large amounts of data to and from LybinCom. The XML interface is not as fast, but is more robust because the format of the input files is not as strict. The XML interface discards any parts of the input file it does not recognize. This report describes the binary software interface of LybinCom 6.0 needed for the integration of LybinCom with other software applications. All parameters and data sets that can be passed to and from LybinCom are described. Examples of programming code for integration of LybinCom are also included. The interface’s inner structure and how the acoustic modelling is performed are not described in this report.

Den akustiske strålegangsmodellen LYBIN er en etablert og mye brukt sonarytelsesmodell som eies av Forsvarets Logistikkorganisasjon. Modellen brukes både ombord på marinefartøy og i treningssituasjoner på land. LYBIN er blitt et viktig verktøy både i planlegging og evaluering av maritime operasjoner, og tidligere versjoner er allerede integrert i programvare for kampsystemer, taktisk beslutningsstøtte og taktiske trenere. LYBINs beregningskjerne er nå implementert som en software modul kalt LybinCom. I tillegg eksisterer det et grafisk brukergrensesnitt som sammen med LybinCom kan brukes for å bygge en frittstående, eksekverbar applikasjon. Vi kaller denne frittstående applikasjonen for LYBIN. Implementasjonen som en software modul gjør LybinCom egnet for integrasjon med andre applikasjoner, og muliggjør at LybinCom kan samhandle med andre applikasjoner, som matematiske modeller, web-tjenester, geografiske informasjonssystemer med mer. I motsetning til tidligere er det nå mulig for andre å integrere LybinCom i deres programvare uten å ha tilgang til kildekoden. LybinCom har to ulike grensesnitt for datautveksling med annen programvare. De to grensesnittene er det binære grensesnittet og eXtensible Markup Language (XML) grensesnittet. Det binære grensesnittet muliggjør rask transport av store mengder data til og fra LybinCom. XML grensesnittet er ikke like raskt, men er mer robust fordi formatet til inputfilene ikke er så rigid. XML grensesnittet forkaster de delene av inputfila det ikke gjenkjenner. Denne rapporten beskriver det binære grensesnittet til LybinCom 6.0 som trengs for å kunne integrere LybinCom med andre programvareapplikasjoner. Alle parametere og datasett som kan sendes til og fra LybinCom er beskrevet i denne rapporten. Noen eksempler på programkode for integrasjon av LybinCom er også inkludert. Det som skjer innenfor grensesnittene og hvordan den akustiske modelleringen er gjort vil ikke bli omtalt i denne rapporten.