public interface

PhysicalData

implements AnnotationObject
vars.annotation.PhysicalData
Known Indirect Subclasses

Summary

Constants
String PROP_DEPTH
String PROP_LATITUDE
String PROP_LIGHT
String PROP_LONGITUDE
String PROP_OXYGEN
String PROP_SALINITY
String PROP_TEMPERATURE
Public Methods
abstract boolean containsData()
Indicates if the physical data object contains any data values.
abstract Float getAltitude()
abstract Float getDepth()
Get Depth
abstract Double getLatitude()
Get Decimal latitude
abstract Float getLight()
Get Light Beam Transmission PerCentage
abstract Date getLogDate()
abstract Double getLongitude()
Get Decimal longitude
abstract Float getOxygen()
Get Oxygen
abstract Float getSalinity()
Get Salinity
abstract Float getTemperature()
Get Temperature
abstract VideoFrame getVideoFrame()
abstract void setAltitude(Float altitude)
abstract void setDepth(Float depth)
Set Depth from a Float
abstract void setLatitude(Double latitude)
Set Light Beam Transmission PerCentage from a float
abstract void setLight(Float light)
Set Oxygen from a float
abstract void setLogDate(Date logDate)
Set the date that the physical data was logged.
abstract void setLongitude(Double longitude)
Set Decimal Latitude from a Float
abstract void setOxygen(Float oxygen)
Set Salinity from a float
abstract void setSalinity(Float salinity)
Set Temperature from a float
abstract void setTemperature(Float temperature)
Set Depth from a float
[Expand]
Inherited Methods
From interface vars.VARSObject

Constants

public static final String PROP_DEPTH

Constant Value: "depth"

public static final String PROP_LATITUDE

Constant Value: "latitude"

public static final String PROP_LIGHT

Constant Value: "light"

public static final String PROP_LONGITUDE

Constant Value: "longitude"

public static final String PROP_OXYGEN

Constant Value: "oxygen"

public static final String PROP_SALINITY

Constant Value: "salinity"

public static final String PROP_TEMPERATURE

Constant Value: "temperature"

Public Methods

public abstract boolean containsData ()

Indicates if the physical data object contains any data values.

Returns
  • false if all data values (depth, salinity, temperature, oxygen, light, latitude, and longitude) are null. true if any of these values are not null.

public abstract Float getAltitude ()

public abstract Float getDepth ()

Get Depth

Returns
  • Depth in meters

public abstract Double getLatitude ()

Get Decimal latitude

Returns
  • Decimal latitude

public abstract Float getLight ()

Get Light Beam Transmission PerCentage

Returns
  • Light Beam Transmission PerCentage

public abstract Date getLogDate ()

public abstract Double getLongitude ()

Get Decimal longitude

Returns
  • Decimal longitude

public abstract Float getOxygen ()

Get Oxygen

Returns
  • Oxygen in ml/l

public abstract Float getSalinity ()

Get Salinity

Returns
  • Salinity in Practical Salinity Units (PSU)

public abstract Float getTemperature ()

Get Temperature

Returns
  • Temperature in degrees Celsius

public abstract VideoFrame getVideoFrame ()

Returns
  • The association videoFrame

public abstract void setAltitude (Float altitude)

public abstract void setDepth (Float depth)

Set Depth from a Float

Parameters
depth Depth in meters

public abstract void setLatitude (Double latitude)

Set Light Beam Transmission PerCentage from a float

public abstract void setLight (Float light)

Set Oxygen from a float

public abstract void setLogDate (Date logDate)

Set the date that the physical data was logged.

public abstract void setLongitude (Double longitude)

Set Decimal Latitude from a Float

public abstract void setOxygen (Float oxygen)

Set Salinity from a float

public abstract void setSalinity (Float salinity)

Set Temperature from a float

public abstract void setTemperature (Float temperature)

Set Depth from a float