net.sf.marineapi.nmea.parser.XDRParser Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.everit.osgi.bundles.net.sf.marineapi Show documentation
Java Marine API is an NMEA 0183 library for Java (http://ktuukkan.github.io/marine-api/).
The newest version!
/*
 * XDRParser.java
 * Copyright (C) 2013 Robert Huitema, Kimmo Tuukkanen
 * 
 * This file is part of Java Marine API.
 * 
 * 
 * Java Marine API is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 * 
 * Java Marine API is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
 * for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with Java Marine API. If not, see .
 */
package net.sf.marineapi.nmea.parser;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import net.sf.marineapi.nmea.sentence.SentenceId;
import net.sf.marineapi.nmea.sentence.TalkerId;
import net.sf.marineapi.nmea.sentence.XDRSentence;
import net.sf.marineapi.nmea.util.Measurement;

/**
 * 
 * Transducer measurements.
 * 
 *         1 2   3 4            n
 *         | |   | |            |
 *  $--XDR,a,x.x,a,c--c, ..... *hh
 * 
 * 
 * Where: 
 * 

 * Transducer Type
 * 
Measurement Data
 * 
Units of measurement
 * 
Name of transducer
 * 
 * 
 * There may be any number of quadruplets like this, each describing a
 * sensor. The last field will be a checksum as usual.
 * 
 * @author Robert Huitema, Kimmo Tuukkanen
 */
class XDRParser extends SentenceParser implements XDRSentence {

	// length of each data set is 4 fields
	private static int DATA_SET_LENGTH = 4;
	
	// data set field indices, relative to first field of each set
	private static int TYPE_INDEX = 0;
	private static int VALUE_INDEX = 1;
	private static int UNITS_INDEX = 2;
	private static int NAME_INDEX = 3;
	
	/**
	 * Creates new instance of XDRParser.
	 * 
	 * @param nmea XDR sentence string
	 */
	public XDRParser(String nmea) {
		super(nmea, SentenceId.XDR);
	}

	/**
	 * Creates XDR parser with empty sentence.
	 * 
	 * @param talker TalkerId to set
	 */
	public XDRParser(TalkerId talker) {
		super(talker, SentenceId.XDR, DATA_SET_LENGTH);
	}



	/* (non-Javadoc)
	 * @see net.sf.marineapi.nmea.sentence.XDRSentence#addMeasurement(net.sf.marineapi.nmea.util.Measurement[])
	 */
	public void addMeasurement(Measurement... m) {
		List ms = getMeasurements();
		ms.addAll(Arrays.asList(m));
		setMeasurements(ms);		
	}

	/* (non-Javadoc)
	 * @see net.sf.marineapi.nmea.sentence.XDRSentence#getMeasurements()
	 */
	public List getMeasurements() {
		ArrayList result = new ArrayList();
		for (int i = 0; i < getFieldCount(); i += DATA_SET_LENGTH) {
			Measurement value = fetchValues(i);
			if(!value.isEmpty()) {
				result.add(value);
			}
		}
		return result;
	}

	/* (non-Javadoc)
	 * @see net.sf.marineapi.nmea.sentence.XDRSentence#setMeasurement(net.sf.marineapi.nmea.util.Measurement)
	 */
	public void setMeasurement(Measurement m) {
		setFieldCount(DATA_SET_LENGTH);
		insertValues(TYPE_INDEX, m);
	}
	
	/* (non-Javadoc)
	 * @see net.sf.marineapi.nmea.sentence.XDRSentence#setMeasurements(java.util.List)
	 */
	public void setMeasurements(List measurements) {
				
		setFieldCount(measurements.size() * DATA_SET_LENGTH);

		int i = 0;
		for(Measurement m : measurements) {
			insertValues(i, m);
			i += DATA_SET_LENGTH;
		}
	}

	/**
	 * Fetch data set starting at given index.
	 *  
	 * @param i Start position of data set, i.e. index of first data field.
	 * @return XDRValue object
	 */
	private Measurement fetchValues(int i) {
		
		Measurement m = new Measurement();
		
		if(hasValue(i)) {
			m.setType(getStringValue(i));
		}
		
		if(hasValue(i + VALUE_INDEX)) {
			m.setValue(getDoubleValue(i + VALUE_INDEX));
		}
		
		if(hasValue(i + UNITS_INDEX)) {
			m.setUnits(getStringValue(i + UNITS_INDEX));
		}
		
		if(hasValue(i + NAME_INDEX)) {
			m.setName(getStringValue(i + NAME_INDEX));
		}

		return m;
	}

	/**
	 * Inserts the given data set beginning at given index. Before inserting,
	 * make sure the sentence has enough fields for it.
	 * 
	 * @param i Start position of data set, i.e. index of first data field.
	 * @param m XDR data set to insert
	 */
	private void insertValues(int i, Measurement m) {
		
		if(m != null) {
			setStringValue((i), m.getType());
			setDoubleValue((i + VALUE_INDEX), m.getValue());
			setStringValue((i + UNITS_INDEX), m.getUnits());
			setStringValue((i + NAME_INDEX), m.getName());
		}
	}
}