CameraData.java :  » JPA » vars-redux » vars » annotation » Java Open Source

/*
 * @(#)CameraData.java   2010.01.20 at 04:13:04 PST
 *
 * Copyright 2009 MBARI
 *
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */



package vars.annotation;

import java.util.Date;

/**
 *
 * @author brian
 */
public interface CameraData extends AnnotationObject {

    String PROP_DIRECTION = "direction";
    String PROP_FIELD_WIDTH = "fieldWidth";
    String PROP_FOCUS = "focus";
    String PROP_HEADING = "heading";
    String PROP_IMAGE_REFERENCE = "imageReference";
    String PROP_IRIS = "iris";
    String PROP_NAME = "name";
    String PROP_PITCH = "pitch";
    String PROP_ROLL = "roll";
    String PROP_VIDEO_FRAME = "videoFrame";
    String PROP_VIEW_HEIGHT = "viewHeight";
    String PROP_VIEW_UNITS = "viewUnits";
    String PROP_VIEW_WIDTH = "viewWidth";
    String PROP_X = "x";
    String PROP_X_Y_UNITS = "xyUnits";
    String PROP_Y = "y";
    String PROP_Z = "z";
    String PROP_ZOOM = "zoom";
    String PROP_Z_UNITS = "zUnits";

    /**
     * Check to verfiy that a cameradata object contains data.
     * @return <strong>false</strong> if the data values (name, direction, zoom,
     * iris, fieldWidth, and stillImage) are all null. <strong>true</strong> if
     * any of these values are not null
     */
    boolean containsData();

    /**
     * Get the <code>CameraData</code> direction.
     * @return  The String value of <code>CameraData</code> direction.
     */
    String getDirection();

    /**
     * Get the <code>CameraData</code> field width.
     * @return  The double value of <code>CameraData</code> field width.
     */
    Double getFieldWidth();

    /**
     * Get the <code>CameraData</code> focus.
     * @return  The integer value of <code>CameraData</code> focus.
     */
    Integer getFocus();

    Float getHeading();

    /**
     * Get the <code>String</code> of the Still Image captured by this <code>CameraData</code>.
     * @return  The <code>String</code> of the Still Image URL captured by  this <code>CameraData</code>.
     */
    String getImageReference();

    /**
     * Get the <code>CameraData</code> iris.
     * @return  The integer value of <code>CameraData</code> iris.
     */
    Integer getIris();

    /**
     *
     * @return The date that the cameradata was recorded
     */
    Date getLogDate();

    /**
     * Get the String name for this <code>CameraData</code> object.
     * @return  The String name for this <code>CameraData</code> object.
     */
    String getName();

    Float getPitch();

    Float getRoll();

    /**
     * @return
     */
    VideoFrame getVideoFrame();

    Float getViewHeight();

    String getViewUnits();

    Float getViewWidth();

    Float getX();

    String getXYUnits();

    Float getY();

    Float getZ();

    String getZUnits();

    /**
     * Get the <code>CameraData</code> zoom.
     * @return  The integer value of <code>CameraData</code> zoom.
     */
    Integer getZoom();

    /**
     * <p>Set <code>CameraData</code> direction. This is typically a string such as 'ascending', 'descending', 'or cruise'. <font color="FFCCCC"> WARNING: Names longer than 50 characters will be truncated</font></p>
     * @param  direction
     */
    void setDirection(String direction);

    /**
     * Set <code>CameraData</code> field width.
     * @param fieldWidth  The double value of camera field width.
     */
    void setFieldWidth(Double fieldWidth);

    /**
     * Set <code>CameraData</code> focus.
     * @param focus  The integer value of camera focus.
     */
    void setFocus(Integer focus);

    /**
     *
     * @param tilt in Radians
     */
    void setHeading(Float tilt);

    /**
     * Set <code>String</code> of the Still Image URL captured by this <code>CameraData</code>.
     * @param  stillImage
     */
    void setImageReference(String stillImage);

    /**
     * Set <code>CameraData</code> iris.
     * @param iris  The integer value of camera iris.
     */
    void setIris(Integer iris);

    /**
     * @param  logDate
     */
    void setLogDate(Date logDate);

    /**
     * <p>Set the name of the camera used to capture the related video tape. <font color="FFCCCC">WARNING: Names longer than 50 characters will be truncated</font></p>
     * @param name  The String name of the camera used to capture the related  video tape.
     */
    void setName(String name);

    /**
     *
     * @param pitch in Radians
     */
    void setPitch(Float pitch);

    /**
     *
     * @param roll in Radians
     */
    void setRoll(Float roll);

    void setViewHeight(Float height);

    void setViewUnits(String units);

    void setViewWidth(Float width);

    void setX(Float x);

    void setXYUnits(String units);

    void setY(Float y);

    void setZ(Float z);

    void setZUnits(String units);

    /**
     * Set <code>CameraData</code> zoom.
     * @param zoom  The integer value of camera zoom.
     */
    void setZoom(Integer zoom);
}