EcuDataPv.java

/*
 * (C) Copyright 2015 by fr3ts0n <erwin.scheuch-heilig@gmx.at>
 *
 * 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., 59 Temple Place, Suite 330, Boston,
 * MA 02111-1307 USA
 */

package com.fr3ts0n.ecu;

import com.fr3ts0n.pvs.IndexedProcessVar;

/**
 * Process variable which contains a single OBD data item
 *
 * @author erwin
 */
public class EcuDataPv extends IndexedProcessVar
{
	/** UID for serialisation */
	private static final long serialVersionUID = -7787217159439147214L;

	// Field IDs
	public static final int FID_PID = 0;
	public static final int FID_OFS = 1;
	public static final int FID_DESCRIPT = 2;
	public static final int FID_VALUE = 3;
	public static final int FID_UNITS = 4;
	// optional Field IDs which will be invisible for table display
	public static final String FID_FORMAT = "FMT";
	public static final String FID_CNVID = "CNV_ID";
	public static final String FID_MIN = "MIN";
	public static final String FID_MAX = "MAX";
	public static final String FID_BIT_OFS = "BIT_OFS";

	public static final String[] FIELDS =
		{
			"PID",
			"OFS",
			"DESCRIPTION",
			"VALUE",
			"UNITS",
		};

	private transient Object renderingComponent;

	/**
	 * Creates a new instance of EcuDataPv
	 */
	public EcuDataPv()
	{
		super();
		this.setKeyAttribute(FIELDS[0]);
	}

	public String[] getFields()
	{
		return (FIELDS);
	}

	/**
	 * get units of a data PV
	 * Units may change because of the conversion system changed (metric/imperial)
	 * @return
	 */
	public String getUnits()
	{
		String result = "";
		Conversion[] cnv = (Conversion[]) get(FID_CNVID);
		if(cnv != null && cnv[EcuDataItem.cnvSystem] != null)
		{
			result = cnv[EcuDataItem.cnvSystem].getUnits();
		}
		return result;
	}

	public Object getRenderingComponent()
	{
		return renderingComponent;
	}

	public void setRenderingComponent(Object renderingComponent)
	{
		this.renderingComponent = renderingComponent;
	}

	public String toString()
	{
		return (String.format("%02X.%d.%d", get(FID_PID), get(FID_OFS), get(FID_BIT_OFS)));
	}
}