decodes.datasource.IridiumPMParser Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opendcs Show documentation
A collection of software for aggregatting and processing environmental data such as from NOAA GOES satellites.
The newest version!
/*
*  $Id$
*/
package decodes.datasource;

import java.util.HashMap;
import java.util.Date;
import java.util.Calendar;
import java.text.ParsePosition;
import java.text.ParseException;
import java.text.SimpleDateFormat;

import lrgs.common.DcpMsg;
import lrgs.common.DcpAddress;

import ilex.util.ArrayUtil;
import ilex.util.ByteUtil;
import ilex.util.Logger;
import ilex.var.Variable;

import decodes.db.Constants;

/**
  Concrete subclass of PMParser for parsing performance measurements
  out of IRIDIUM SBD messages.
*/
public class IridiumPMParser extends PMParser
{
	// Performance Measurement tags:
	public static final String LATITUDE = "latitude";
	public static final String LONGITUDE = "longitude";
	public static final String CEP_RADIUS = "radius";

	private SimpleDateFormat goesDateFormat = null;

	/** default constructor */
	public IridiumPMParser()
	{
		goesDateFormat = new SimpleDateFormat("yyDDDHHmmss");
		goesDateFormat.setTimeZone(java.util.TimeZone.getTimeZone("UTC"));
	}

	/**
	  Parses the DOMSAT header.
	  Sets the mediumID to the DCP's IMEI.
	  @param msg the message to parse.
	*/
	public void parsePerformanceMeasurements(RawMessage msg)
		throws HeaderParseException
	{
		DcpMsg origMsg = msg.getOrigDcpMsg();
		byte data[] = msg.getData();
		if (data == null || data.length < 75)
			throw new HeaderParseException(
				"Header too short, 75 bytes is required");
		msg.setPM(GoesPMParser.MESSAGE_LENGTH, new Variable(data.length));
		String hdr = new String(data);

		if (origMsg != null)
		{
			String emei = origMsg.getDcpAddress().toString();
			msg.setMediumId(emei);
			msg.setPM(GoesPMParser.DCP_ADDRESS, new Variable(emei));
			Date d = origMsg.getXmitTime();
			msg.setPM(GoesPMParser.MESSAGE_TIME, new Variable(d));
			msg.setTimeStamp(d);
			int sessionStat = origMsg.getSessionStatus();
			if (sessionStat == 0 || sessionStat == 1 || sessionStat == 2)
				msg.setPM(GoesPMParser.FAILURE_CODE, new Variable('G'));
			else
				msg.setPM(GoesPMParser.FAILURE_CODE, new Variable('?'));
			msg.setPM(GoesPMParser.SPACECRAFT, new Variable('I'));
			msg.setPM(GoesPMParser.UPLINK_CARRIER, new Variable("IR"));
			msg.setPM(GoesPMParser.DCP_MSG_FLAGS,
				new Variable(origMsg.flagbits));
		}
		else
		{
			// Parse information out of the ASCII-ized msg header. Example:
			// ID=300034012724030,TIME=08229165743,STAT=00,MO=00551,MT=00000,CDR=01D3997C 
			int idx = hdr.indexOf("ID=");
			if (idx == -1)
				throw new HeaderParseException(
					"No ID (EMEI) in Iridium header");
			String s = hdr.substring(idx+3, idx+3+15);
			msg.setMediumId(s);
			msg.setPM(GoesPMParser.DCP_ADDRESS, new Variable(s));

			// The TIME in the header is the time the message was sent from the
			// SBD gateway (over the internet). It is not the DCP's original
			// transmission time. The difference between the two times can vary
			// from a few seconds to several minutes. Users decoding these
			// messages and, in particular, use F(MOFF) must be aware of this.
			// DECODES F(MHD) and F(MHT) operations can be used to change this
			// time in the decoded message (the raw value doesn't change).
			idx = hdr.indexOf("TIME=");
			if (idx == -1)
				throw new HeaderParseException(
					"No TIME in Iridium header");
			s = hdr.substring(idx+5, idx+5+11);
			try
			{
				Date d = goesDateFormat.parse(s);
				msg.setPM(GoesPMParser.MESSAGE_TIME, new Variable(d));
			}
			catch(Exception ex)
			{
				throw new HeaderParseException(
					"Cannot parse time from Iridium header '" + s + "'");
			}
			
			idx = hdr.indexOf("STAT=");
			if (idx != -1)
			{
				int comma = hdr.indexOf(',', idx);
				try
				{
					int sessionStat = Integer.parseInt(hdr.substring(idx+5, comma));
					if (sessionStat == 0 || sessionStat == 1 || sessionStat == 2)
						msg.setPM(GoesPMParser.FAILURE_CODE, new Variable('G'));
				}
				catch(Exception ex)
				{
					Logger.instance().warning("Bad STAT field in Iridium header '"
						+ hdr + "'");
				}
			}
		}
		
		// Process Location info if it is present.
		int idx = hdr.indexOf("LAT=");
		if (idx != -1)
		{
			int comma = hdr.indexOf(',', idx);
			try
			{
				msg.setPM(LATITUDE, 
					new Variable(
						Double.parseDouble(hdr.substring(idx+4, comma))));
			}
			catch(Exception ex)
			{
				Logger.instance().warning("Bad LAT field in Iridium header '"
					+ hdr + "'");
			}
		}
		idx = hdr.indexOf("LON=");
		if (idx != -1)
		{
			int comma = hdr.indexOf(',', idx);
			try
			{
				msg.setPM(LONGITUDE, 
					new Variable(
						Double.parseDouble(hdr.substring(idx+4, comma))));
			}
			catch(Exception ex)
			{
				Logger.instance().warning("Bad LON field in Iridium header '"
					+ hdr + "'");
			}
		}
		idx = hdr.indexOf("RAD=");
		if (idx != -1)
		{
			int comma = hdr.indexOf("IE:02", idx);
			try
			{
				msg.setPM(CEP_RADIUS, 
					new Variable(
						Double.parseDouble(hdr.substring(idx+4, comma-1))));
			}
			catch(Exception ex)
			{
				Logger.instance().warning("Bad RAD field in Iridium header '"
					+ hdr + "'");
			}
		}
		
		idx = hdr.indexOf(" ");
		if (idx < 75) idx = 75;
		msg.setHeaderLength(idx);
	}

	public boolean containsExplicitLength()
	{
		return false;
	}

	/** @return 75, the length of a ASCII-ized Iridium header. */
	public int getHeaderLength()
	{
		return -1;
	}

	/** @return "iridium" */
	public String getHeaderType()
	{
		return "iridium";
	}

	/** @return the medium type constant for GOES DCP messages. */
	public String getMediumType()
	{
		return Constants.medium_IRIDIUM;
	}

	public SimpleDateFormat getGoesDateFormat()
	{
		return goesDateFormat;
	}
}