kmall-csharp

An unfinished C# class library for reading and writing Kongsberg .kmall files.

DISCLAIMER: This library is largely untested. It has been used to read and write a handful of .kmall files, but with some errors. As of now there are a few identified issues.

Example Usages

The following namespaces are used.

using System.Collections.Generic;
using System.IO;
using Freidrich.Kmall;

Reading all datagrams from a file

string filePath = @"C:\myKmallFiles\myKmallFile.kmall";

List<EMdgm> datagrams;
using (KmallReader r = new KmallReader(filePath))
{
  datagrams = r.ReadAllDatagrams();
}
// All datagrams found on file are now available in the datagrams-List.

Reading datagrams of a specific type in a loop

string filePath = @"C:\myKmallFiles\myKmallFile.kmall";

using (FileStream fs = new FileStream(filePath))
using (KmallReader r = new KmallReader(fs))
{
  while (true)
  {
    EMdgmMRZ dgm = r.ReadDatagram(KmallConstants.EM_DGM_M_RANGE_AND_DEPTH) as EMdgmMRZ;
    if (dgm is null) break; //End of file reached.
    
    /* do stuff here */
  }
}

Writing a single datagram to a new file

EMdgm myDatagram;

/* generate datagram */

string filePath = @"C:\myKmallFiles\myKmallFile.kmall";

using (KmallWriter w = new KmallWriter(filePath, FileMode.Create))
{
  w.WriteDatagram(myDatagram);
}

Making a copy, modifying datagrams of a specific type

string readPath = @"C:\myKmallFiles\myKmallFile1.kmall";
string writePath = @"C:\myKmallFiles\myKmallFile2.kmall";

File.Copy(readPath, writePath);

using (KmallReader r = new KmallReader(readPath))
using (KmallWriter w = new KmallWriter(writePath, FileMode.Open))
{
  while (true)
  {
    EMdgmSPO dgm = r.ReadDatagram(KmallConstants.EM_DGM_S_POSITION) as EMdgmSPO;
    if (dgm is null) break; //End of file reached.
    
    /* modify datagram here */
    
    //Writes the datagram at the same position as it was read.
    //This functionality is achieved by storing the datagram's file position in the EMdgm.DatagramPosition field
    w.WriteDatagramAtDatagramPosition(dgm);
  }
}

Modifying specific datagrams in place

Note that for this to work properly the datagrams may not grow in size during modification. Shrinking is fine.

string filePath = @"C:\myKmallFiles\myKmallFile.kmall";

using (FileStream fs = new FileStream(filePath, FileAccess.ReadWrite))
using (KmallReader r = new KmallReader(fs))
using (KmallWriter w = new KmallWriter(fs))
{
  while (true)
  {
    EMdgmSCL dgm = r.ReadDatagram(KmallConstants.EM_DGM_S_CLOCK) as EMdgmSCL;
    if (dgm is null) break; //End of file reached.
    
    /* modify datagram here */
    
    //Writes the datagram at the same position as it was read.
    //This functionality is achieved by storing the datagram's file position in the EMdgm.DatagramPosition field.
    w.WriteDatagramAtDatagramPosition(dgm);
  }
}