LYBIN 5.0 : interface description

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 onboard 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 purpose of this report is to describe the software interfaces needed for the integration of the current version of LYBIN in other software applications. Different from earlier, third parties can now integrate LYBIN in their software without needing access to the source code. LYBIN is now implemented as a softwaremodule (COM) for the Microsoft Windows platform. In addition there already exists a graphical user interface which can be used together with the COM module to build a stand alone executive application. An implementation as a COM module makes LYBIN suitable for integration with other applications, and enables LYBIN to interact with other applications such as other mathematical models, web services, geographical information systems and more. The COM module 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 LYBIN. The XML interface is not as fast, but is more robust because the format of the input files is not so strict. The XML interface discards any parts of the input file it does not recognize. All parameters and data sets that can be passed to and from LYBIN are described in this report. Examples of programming code for integration of LYBIN are also included. What goes on inside the interfaces and how the acoustic modeling is performed will not be discussed.

Den akustiske strålegangsmodellen LYBIN er en etablert og mye brukt sonar ytelsesmodell 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, taktiske beslutningsstøtte og taktiske trenere. Hensikten med denne rapporten er å beskrive de programmeringsgrensesnittene som trengs for å kunne integrere dagens versjon av LYBIN i andre programvareapplikasjoner. I motsetning til tidligere er det nå mulig for andre å integrere LYBIN i deres programvare uten å ha tilgang til LYBINs kildekode. LYBIN er nå implementert som en software modul (COM modul) for Microsoft Windows plattformen. I tillegg eksisterer det allerede et grafisk brukergrensesnitt som sammen med COM modulen kan brukes for å bygge en frittstående eksekverbar applikasjon. Å lage LYBIN som en COM modul gjør LYBIN egnet for integrasjon med andre applikasjoner, og muliggjør at LYBIN kan samhandle med andre applikasjoner som matematiske modeller, web-tjenester, geografiske informasjonssystemer med mer. COM modulen 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 LYBIN. 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. Alle parametere og datasett som kan sendes til og fra LYBIN er beskrevet i denne rapporten. Noen eksempler på programkode for integrasjon av LYBIN er også inkludert. Det som skjer innenfor grensesnittene og hvordan den akustiske modelleringen er gjort vil ikke bli omtalt.