Package ome.model.units

Class ElectricPotential

  • All Implemented Interfaces:
    java.io.Serializable, Primitive, Unit, Filterable
    @Embeddable
public class ElectricPotential
extends java.lang.Object
implements java.io.Serializable, Filterable, Unit
    class storing both a ElectricPotential and a unit for that ElectricPotential (e.g. m, in, ly, etc.) encapsulated in a UnitsElectricPotential instance. As also described in the remoting definition (.ice) for ElectricPotential, this is an embedded class meaning that the columns here do not appear in their own table but exist directly on the containing object. Like Details and Permissions, instances do not contain long identifiers and cannot be persisted on their own.
    See Also:
    Serialized Form

    • Constructor Detail

      • ElectricPotential

        @Deprecated
public ElectricPotential()
        Deprecated.
        no-arg constructor to keep Hibernate happy.

      • ElectricPotential

        public ElectricPotential​(double d,
                         java.lang.String u)

      • ElectricPotential

        public ElectricPotential​(double d,
                         ome.units.unit.Unit<ome.units.quantity.ElectricPotential> unit)

      • ElectricPotential

        public ElectricPotential​(ome.units.quantity.ElectricPotential value)

    • Method Detail

      • makeElectricPotentialUnitXML

        public static ome.xml.model.enums.UnitsElectricPotential makeElectricPotentialUnitXML​(java.lang.String unit)

      • makeElectricPotentialXML

        public static ome.units.quantity.ElectricPotential makeElectricPotentialXML​(double d,
                                                                            java.lang.String unit)

      • convertElectricPotential

        public static ome.units.quantity.ElectricPotential convertElectricPotential​(ElectricPotential t)
        FIXME: this should likely take a default so that locations which don't want an exception can have log.warn("Using new PositiveFloat(1.0)!", e); return new PositiveFloat(1.0); or similar.

      • convertElectricPotential

        public static ElectricPotential convertElectricPotential​(ElectricPotential value,
                                                         ome.units.unit.Unit<ome.units.quantity.ElectricPotential> ul)

      • getValue

        public double getValue()
        value of this unit-field. It will be persisted to a column with the same name as the containing field. For example, detectorSettings.getVolatage() which is of type ElectricPotential will be stored in a column "detectorSettingsvolatage".
        Specified by:
        getValue in interface Unit

      • getUnit

        public UnitsElectricPotential getUnit()
        Many-to-one field ome.model.units.ElectricPotential.unit (ome.model.enums.UnitsElectricPotential). These values are stored in a column suffixed by "Unit". Whereas value for physicalSizeX will be stored as "detectorSettings.volatage", the unit enum will be stored as "detectorSettings.volatageUnit".
        Specified by:
        getUnit in interface Unit

      • setValue

        public void setValue​(double value)
        Specified by:
        setValue in interface Unit

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object