Scale.java

/*
 * RomRaider Open-Source Tuning, Logging and Reflashing
 * Copyright (C) 2006-2017 RomRaider.com
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

//This object defines the scaling factor and offset for calculating real values

package com.romraider.maps;

import java.io.Serializable;

public class Scale implements Serializable {

    private static final long serialVersionUID = 5836610685159474795L;

    private String name = "Raw Value";
    private String unit = "raw value";
    private String expression = "x";
    private String byteExpression = "x";
    private String format = "#.##";
    private double coarseIncrement = 2;
    private double fineIncrement = 1;
    private double min = 0.0;
    private double max = 0.0;

    public Scale() {
    }

    @Override
    public String toString() {
        return  "\n      ---- Scale ----" +
                "\n      Name: " + getName() +
                "\n      Expression: " + getExpression() +
                "\n      Byte Expression: " + getByteExpression() +
                "\n      Unit: " + getUnit() +
                "\n      Format: " + getFormat() +
                "\n      Coarse Increment: " + getCoarseIncrement() +
                "\n      Fine Increment: " + getFineIncrement() +
                "\n      Min: " + getMin() +
                "\n      Max: " + getMax() +
                "\n      ---- End Scale ----\n";
    }

    public String getUnit() {
        return unit;
    }

    public void setUnit(String unit) {
        this.unit = unit;
    }

    public String getFormat() {
        return format;
    }

    public void setFormat(String format) {
        this.format = format;
    }

    public String getExpression() {
        return expression;
    }

    public void setExpression(String expression) {
        this.expression = expression;
    }

    public double getCoarseIncrement() {
        return coarseIncrement;
    }

    public void setCoarseIncrement(double increment) {
        this.coarseIncrement = increment;
    }

    public boolean isReady() {
        if (unit == null) {
            return false;
        } else if (expression == null) {
            return false;
        } else if (format == null) {
            return false;
        } else if (coarseIncrement < 1) {
            return false;
        }

        return true;
    }

    public String getByteExpression() {
        return byteExpression;
    }

    public void setByteExpression(String byteExpression) {
        this.byteExpression = byteExpression;
    }

    public double getFineIncrement() {
        return fineIncrement;
    }

    public void setFineIncrement(double fineIncrement) {
        this.fineIncrement = fineIncrement;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public double getMin() {
        return min;
    }

    public void setMin(double min) {
        this.min = min;
    }

    public double getMax() {
        return max;
    }

    public void setMax(double max) {
        this.max = max;
    }

    @Override
    public boolean equals(Object other) {
        try {
            if(null == other) {
                return false;
            }

            if(other == this) {
                return true;
            }

            if(!(other instanceof Scale)) {
                return false;
            }

            Scale otherScale = (Scale)other;

            if( (null == this.getName() && null == otherScale.getName())
                    || (this.getName().isEmpty() && otherScale.getName().isEmpty()) ) {
                ;// Skip name compare if name is null or empty.
            } else {
                if(!this.getName().equalsIgnoreCase(otherScale.getName())) {
                    return false;
                }
            }

            if(!this.getUnit().equals(otherScale.getUnit()))
            {
                return false;
            }

            if(!this.getExpression().equals(otherScale.getExpression()))
            {
                return false;
            }

            if(!this.getByteExpression().equals(otherScale.getByteExpression()))
            {
                return false;
            }

            if(!this.getFormat().equals(otherScale.getFormat()))
            {
                return false;
            }

            if(this.getCoarseIncrement() != otherScale.getCoarseIncrement())
            {
                return false;
            }

            if(this.getFineIncrement() != otherScale.getFineIncrement())
            {
                return false;
            }

            if(this.getMin() != otherScale.getMin())
            {
                return false;
            }

            if(this.getMax() != otherScale.getMax())
            {
                return false;
            }

            return true;
        } catch(Exception ex) {
            return false;
        }
    }
}