public interface

CameraData

implements AnnotationObject
vars.annotation.CameraData
Known Indirect Subclasses

Summary

Constants
String PROP_DIRECTION
String PROP_FIELD_WIDTH
String PROP_FOCUS
String PROP_HEADING
String PROP_IMAGE_REFERENCE
String PROP_IRIS
String PROP_NAME
String PROP_PITCH
String PROP_ROLL
String PROP_VIDEO_FRAME
String PROP_VIEW_HEIGHT
String PROP_VIEW_UNITS
String PROP_VIEW_WIDTH
String PROP_X
String PROP_X_Y_UNITS
String PROP_Y
String PROP_Z
String PROP_ZOOM
String PROP_Z_UNITS
Public Methods
abstract boolean containsData()
Check to verfiy that a cameradata object contains data.
abstract String getDirection()
Get the CameraData direction.
abstract Double getFieldWidth()
Get the CameraData field width.
abstract Integer getFocus()
Get the CameraData focus.
abstract Float getHeading()
abstract String getImageReference()
Get the String of the Still Image captured by this CameraData.
abstract Integer getIris()
Get the CameraData iris.
abstract Date getLogDate()
abstract String getName()
Get the String name for this CameraData object.
abstract Float getPitch()
abstract Float getRoll()
abstract VideoFrame getVideoFrame()
abstract Float getViewHeight()
abstract String getViewUnits()
abstract Float getViewWidth()
abstract Float getX()
abstract String getXYUnits()
abstract Float getY()
abstract Float getZ()
abstract String getZUnits()
abstract Integer getZoom()
Get the CameraData zoom.
abstract void setDirection(String direction)

Set CameraData direction.

abstract void setFieldWidth(Double fieldWidth)
Set CameraData field width.
abstract void setFocus(Integer focus)
Set CameraData focus.
abstract void setHeading(Float tilt)
abstract void setImageReference(String stillImage)
Set String of the Still Image URL captured by this CameraData.
abstract void setIris(Integer iris)
Set CameraData iris.
abstract void setLogDate(Date logDate)
abstract void setName(String name)

Set the name of the camera used to capture the related video tape.

abstract void setPitch(Float pitch)
abstract void setRoll(Float roll)
abstract void setViewHeight(Float height)
abstract void setViewUnits(String units)
abstract void setViewWidth(Float width)
abstract void setX(Float x)
abstract void setXYUnits(String units)
abstract void setY(Float y)
abstract void setZ(Float z)
abstract void setZUnits(String units)
abstract void setZoom(Integer zoom)
Set CameraData zoom.
[Expand]
Inherited Methods
From interface vars.VARSObject

Constants

public static final String PROP_DIRECTION

Constant Value: "direction"

public static final String PROP_FIELD_WIDTH

Constant Value: "fieldWidth"

public static final String PROP_FOCUS

Constant Value: "focus"

public static final String PROP_HEADING

Constant Value: "heading"

public static final String PROP_IMAGE_REFERENCE

Constant Value: "imageReference"

public static final String PROP_IRIS

Constant Value: "iris"

public static final String PROP_NAME

Constant Value: "name"

public static final String PROP_PITCH

Constant Value: "pitch"

public static final String PROP_ROLL

Constant Value: "roll"

public static final String PROP_VIDEO_FRAME

Constant Value: "videoFrame"

public static final String PROP_VIEW_HEIGHT

Constant Value: "viewHeight"

public static final String PROP_VIEW_UNITS

Constant Value: "viewUnits"

public static final String PROP_VIEW_WIDTH

Constant Value: "viewWidth"

public static final String PROP_X

Constant Value: "x"

public static final String PROP_X_Y_UNITS

Constant Value: "xyUnits"

public static final String PROP_Y

Constant Value: "y"

public static final String PROP_Z

Constant Value: "z"

public static final String PROP_ZOOM

Constant Value: "zoom"

public static final String PROP_Z_UNITS

Constant Value: "zUnits"

Public Methods

public abstract boolean containsData ()

Check to verfiy that a cameradata object contains data.

Returns
  • false if the data values (name, direction, zoom, iris, fieldWidth, and stillImage) are all null. true if any of these values are not null

public abstract String getDirection ()

Get the CameraData direction.

Returns
  • The String value of CameraData direction.

public abstract Double getFieldWidth ()

Get the CameraData field width.

Returns
  • The double value of CameraData field width.

public abstract Integer getFocus ()

Get the CameraData focus.

Returns
  • The integer value of CameraData focus.

public abstract Float getHeading ()

public abstract String getImageReference ()

Get the String of the Still Image captured by this CameraData.

Returns
  • The String of the Still Image URL captured by this CameraData.

public abstract Integer getIris ()

Get the CameraData iris.

Returns
  • The integer value of CameraData iris.

public abstract Date getLogDate ()

Returns
  • The date that the cameradata was recorded

public abstract String getName ()

Get the String name for this CameraData object.

Returns
  • The String name for this CameraData object.

public abstract Float getPitch ()

public abstract Float getRoll ()

public abstract VideoFrame getVideoFrame ()

public abstract Float getViewHeight ()

public abstract String getViewUnits ()

public abstract Float getViewWidth ()

public abstract Float getX ()

public abstract String getXYUnits ()

public abstract Float getY ()

public abstract Float getZ ()

public abstract String getZUnits ()

public abstract Integer getZoom ()

Get the CameraData zoom.

Returns
  • The integer value of CameraData zoom.

public abstract void setDirection (String direction)

Set CameraData direction. This is typically a string such as 'ascending', 'descending', 'or cruise'. WARNING: Names longer than 50 characters will be truncated

public abstract void setFieldWidth (Double fieldWidth)

Set CameraData field width.

Parameters
fieldWidth The double value of camera field width.

public abstract void setFocus (Integer focus)

Set CameraData focus.

Parameters
focus The integer value of camera focus.

public abstract void setHeading (Float tilt)

Parameters
tilt in Radians

public abstract void setImageReference (String stillImage)

Set String of the Still Image URL captured by this CameraData.

public abstract void setIris (Integer iris)

Set CameraData iris.

Parameters
iris The integer value of camera iris.

public abstract void setLogDate (Date logDate)

public abstract void setName (String name)

Set the name of the camera used to capture the related video tape. WARNING: Names longer than 50 characters will be truncated

Parameters
name The String name of the camera used to capture the related video tape.

public abstract void setPitch (Float pitch)

Parameters
pitch in Radians

public abstract void setRoll (Float roll)

Parameters
roll in Radians

public abstract void setViewHeight (Float height)

public abstract void setViewUnits (String units)

public abstract void setViewWidth (Float width)

public abstract void setX (Float x)

public abstract void setXYUnits (String units)

public abstract void setY (Float y)

public abstract void setZ (Float z)

public abstract void setZUnits (String units)

public abstract void setZoom (Integer zoom)

Set CameraData zoom.

Parameters
zoom The integer value of camera zoom.