/*
 * This file is part of McIDAS-V
 *
 * Copyright 2007-2024
 * Space Science and Engineering Center (SSEC)
 * University of Wisconsin - Madison
 * 1225 W. Dayton Street, Madison, WI 53706, USA
 * https://www.ssec.wisc.edu/mcidas/
 * 
 * All Rights Reserved
 * 
 * McIDAS-V is built on Unidata's IDV and SSEC's VisAD libraries, and
 * some McIDAS-V source code is based on IDV and VisAD source code.  
 * 
 * McIDAS-V is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 * 
 * McIDAS-V is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser Public License
 * along with this program.  If not, see https://www.gnu.org/licenses/.
 */

package edu.wisc.ssec.mcidasv.control;


/**
 * Class FrameComponentInfo Holds the state of
 * the frame components from McIDAS-X
 */
public class FrameComponentInfo {

    /** Should we include image data? */
    private boolean isImage = true;

    /** Should we include graphics data? */
    private boolean isGraphics = true;

    /** Should we include color tables data? */
    private boolean isColorTable = true;
    
    /** Should we include the annotation line? */
    private boolean isAnnotation = true;
    
    /** Should we reset the projection when the data is refreshed? */
    private boolean resetProjection = true;
    
    /** Should we fake the date to preserve frame order? */
    private boolean fakeDateTime = false;

    public FrameComponentInfo() {
    }

    /**
     * Copy constructor
     *
     * @param that The FrameComponentInfo to copy
     *
     */
    public FrameComponentInfo(FrameComponentInfo that) {
        this.isImage         = that.isImage;
        this.isGraphics      = that.isGraphics;
        this.isColorTable    = that.isColorTable;
        this.isAnnotation    = that.isAnnotation;
        this.resetProjection = that.resetProjection;
        this.fakeDateTime    = that.fakeDateTime;
    }

    /**
     * Constructor
     *
     * @param isImage The isImage parameter
     * @param isGraphics The isGraphics parameter
     * @param isColorTable The isColorTable parameter
     * @param isAnnotation
     * @param resetProjection
     * @param fakeDateTime
     */
    public FrameComponentInfo(boolean isImage,
                              boolean isGraphics,
                              boolean isColorTable,
                              boolean isAnnotation,
                              boolean resetProjection,
                              boolean fakeDateTime) {
        this.isImage = isImage;
        this.isGraphics = isGraphics;
        this.isColorTable = isColorTable;
        this.isAnnotation = isAnnotation;
        this.resetProjection = resetProjection;
        this.fakeDateTime = fakeDateTime;
    }

    /**
     * Get the isImage property.
     *
     * @return The isImage property.
     */
    public boolean getIsImage() {
        return this.isImage;
    }

    /**
     * Get the isGraphics property.
     *
     * @return The isGraphics property.
     */
    public boolean getIsGraphics() {
        return this.isGraphics;
    }

    /**
     * Get the isColorTable property.
     *
     * @return The isColorTable property.
     */
    public boolean getIsColorTable() {
        return this.isColorTable;
    }
    
    /**
     * Get the isAnnotation property.
     *
     * @return The isAnnotation property.
     */
    public boolean getIsAnnotation() {
        return this.isAnnotation;
    }
    
    /**
     * Get the resetProjection property.
     *
     * @return The resetProjection property.
     */
    public boolean getResetProjection() {
        return this.resetProjection;
    }

    /**
     * Get the fakeDateTime property.
     *
     * @return The fakeDateTime property.
     */
    public boolean getFakeDateTime() {
        return this.fakeDateTime;
    }

    /**
     * Set the isImage property.
     *
     * @param newValue The new vaue for the isImage property.
     */
    public void setIsImage(boolean newValue) {
        this.isImage = newValue;
    }

    /**
     * Set the isGraphics property.
     *
     * @param newValue The new vaue for the isGraphics property.
     */
    public void setIsGraphics(boolean newValue) {
        this.isGraphics = newValue;
    }

    /**
     * Set the isColorTable property.
     *
     * @param newValue The new vaue for the isColorTable property.
     */
    public void setIsColorTable(boolean newValue) {
        this.isColorTable = newValue;
    }

    /**
     * Set the isAnnotation property.
     *
     * @param newValue The new vaue for the isAnnotation property.
     */
    public void setIsAnnotation(boolean newValue) {
        this.isAnnotation = newValue;
    }
    
    /**
     * Set the resetProjection property.
     *
     * @param newValue The new vaue for the resetProjection property.
     */
    public void setResetProjection(boolean newValue) {
        this.resetProjection = newValue;
    }
    
    /**
     * Set the fakeDateTime property.
     *
     * @param newValue The new vaue for the fakeDateTime property.
     */
    public void setFakeDateTime(boolean newValue) {
        this.fakeDateTime = newValue;
    }
    
    /**
     * Get a String representation of this object
     * @return a string representation
     */
    public String toString() {
        // max possible length should be 120
        return new StringBuilder(128)
            .append("isImage: ")
            .append(this.isImage)
            .append(", isGraphics: ")
            .append(this.isGraphics)
            .append(", isColorTable: ")
            .append(this.isColorTable)
            .append(", isAnnotation: ")
            .append(this.isAnnotation)
            .append(", resetProjection: ")
            .append(this.resetProjection)
            .append(", fakeDateTime: ")
            .append(this.fakeDateTime)
            .toString();
    }

}