net.sf.marineapi.nmea.util.Measurement 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!

/*
 * Measurement.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.util;

/**
 * Sensor measurement data delivered by
 * {@link net.sf.marineapi.nmea.sentence.XDRSentence}. Notice that any of the
 * fields may be empty (null), depending on sentence and sensor
 * that produced it.
 * 
 * @author Robert Huitema, Kimmo Tuukkanen
 */
public class Measurement {

	private String name;
	private String type;
	private String units;
	private Double value;

	/**
	 * Creates a new empty instance of Measurement.
	 */
	public Measurement() {
	}

	/**
	 * Creates a new instance of Measurement with given values.
	 */
	public Measurement(String type, double value, String units, String name) {
		this.type = type;
		this.value = value;
		this.units = units;
		this.name = name;
	}

	/**
	 * Returns the name of transducer.
	 * 
	 * @return Sensor name String
	 */
	public String getName() {
		return name;
	}

	/**
	 * Returns the type of transducer.
	 * 
	 * @return Type String
	 */
	public String getType() {
		return type;
	}

	/**
	 * Returns the units of measurement.
	 * 
	 * @return Units String
	 */
	public String getUnits() {
		return units;
	}

	/**
	 * Returns the measurement value.
	 * 
	 * @return Double value
	 */
	public double getValue() {
		return value;
	}

	/**
	 * Sets the name of transducer.
	 * 
	 * @param name Transducer name to set
	 */
	public void setName(String name) {
		this.name = name;
	}

	/**
	 * Sets the type of measurement.
	 * 
	 * @param type Type to set
	 */
	public void setType(String type) {
		this.type = type;
	}

	/**
	 * Sets the units of measurement.
	 * 
	 * @param units Units to set.
	 */
	public void setUnits(String units) {
		this.units = units;
	}

	/**
	 * Sets the measurement value.
	 * 
	 * @param value Value to set
	 */
	public void setValue(double value) {
		this.value = value;
	}

	/**
	 * Tells if all fields in this measurement are empty (null).
	 * 
	 * @return true if empty, otherwise false.
	 */
	public boolean isEmpty() {
		return name == null && type == null && value == null && units == null;
	}

}