ucar.units.SupplementaryBaseQuantity Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of netcdf Show documentation
The NetCDF-Java Library is a Java interface to NetCDF files, as well as to many other types of scientific data formats.
There is a newer version: 4.3.22
// $Id: SupplementaryBaseQuantity.java 64 2006-07-12 22:30:50Z edavis $
/*
 * Copyright 1998-2009 University Corporation for Atmospheric Research/Unidata
 *
 * Portions of this software were developed by the Unidata Program at the
 * University Corporation for Atmospheric Research.
 *
 * Access and use of this software shall impose the following obligations
 * and understandings on the user. The user is granted the right, without
 * any fee or cost, to use, copy, modify, alter, enhance and distribute
 * this software, and any derivative works thereof, and its supporting
 * documentation for any purpose whatsoever, provided that this entire
 * notice appears in all copies of the software, derivative works and
 * supporting documentation.  Further, UCAR requests that the user credit
 * UCAR/Unidata in any publications that result from the use of this
 * software or in any product that includes this software. The names UCAR
 * and/or Unidata, however, may not be used in any advertising or publicity
 * to endorse or promote any products or commercial entity unless specific
 * written permission is obtained from UCAR/Unidata. The user also
 * understands that UCAR/Unidata is not obligated to provide the user with
 * any support, consulting, training or assistance of any kind with regard
 * to the use, operation and performance of this software nor to provide
 * the user with any updates, revisions, new versions or "bug fixes."
 *
 * THIS SOFTWARE IS PROVIDED BY UCAR/UNIDATA "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL UCAR/UNIDATA BE LIABLE FOR ANY SPECIAL,
 * INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
 * FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
 * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
 * WITH THE ACCESS, USE OR PERFORMANCE OF THIS SOFTWARE.
 */
package ucar.units;

/**
 * Provides support for supplementary base quantities. A supplementary base
 * quantity is one that is dimensionless (e.g. solid angle).
 * 
 * Instances of this class are immutable.
 * 
 * @author Steven R. Emmerson
 * @version $Id: SupplementaryBaseQuantity.java 64 2006-07-12 22:30:50Z edavis $
 */
public final class SupplementaryBaseQuantity extends BaseQuantity {
	private static final long	serialVersionUID	= 1L;

	/**
	 * Constructs from a name and symbol.
	 * 
	 * @param name
	 *            The name of the quantity.
	 * @param symbol
	 *            The symbol for the quantity.
	 * @throws NameException
	 *             Bad quantity name.
	 */
	public SupplementaryBaseQuantity(final String name, final String symbol)
			throws NameException {
		super(name, symbol);
	}

	/**
	 * Constructs from a name and symbol. This is a trusted constructor for use
	 * by the superclass only.
	 * 
	 * @param name
	 *            The name of the quantity.
	 * @param symbol
	 *            The symbol for the quantity.
	 */
	protected SupplementaryBaseQuantity(final String name, final String symbol,
			final boolean trusted) {
		super(name, symbol, trusted);
	}

	/**
	 * Indicates whether or not this quantity is dimensionless. Supplementary
	 * base quantities are dimensionless by definition.
	 * 
	 * @return true.
	 */
	@Override
	public boolean isDimensionless() {
		/*
		 * These quantities are dimensionless by definition.
		 */
		return true;
	}
}