ucar.units.Base Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of udunits Show documentation

The ucar.units Java package is for decoding and encoding formatted unit specifications (e.g. "m/s"), converting numeric values between compatible units (e.g. between "m/s" and "knot"), and for performing arithmetic operations on units (e.g. dividing one unit by another, or raising a unit to a power).

The newest version!

/*
 * Copyright (c) 1998-2018 University Corporation for Atmospheric Research/Unidata
 * See LICENSE for license information.
 */
package ucar.units;

/**
 * Interface for "base" entities like base units or base quantities.
 * 
 * @author Steven R. Emmerson
 */
public interface Base {
    /**
     * Indicates if this base entity is dimensionless.
     * 
     * @return true if and only if the base entity is dimensionless
     *         (e.g. (BaseQuantity.SOLID_ANGLE).
     */
    public boolean isDimensionless();

    /**
     * Returns the identifier for the base entity.
     * 
     * @return The base entity's identifier (i.e. symbol or name).
     */
    public String getID();

    /**
     * Indicates if this base entity is semantically the same as another object.
     * 
     * @param object
     *            The other object.
     * @return true if and only if this base entity is semantically
     *         the same as object.
     */
    public boolean equals(Object object);
}