/* -*- tab-width: 4 -*-
 *
 * Electric(tm) VLSI Design System
 *
 * File: SweepSignal.java
 *
 * Copyright (c) 2004 Sun Microsystems and Static Free Software
 *
 * Electric(tm) 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 3 of the License, or
 * (at your option) any later version.
 *
 * Electric(tm) 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 Electric(tm); see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, Mass 02111-1307, USA.
 */
package com.sun.electric.tool.user.waveform;
import com.sun.electric.database.text.TextUtils;
import com.sun.electric.tool.simulation.Analysis;

import java.util.Iterator;

/**
 * Class to define a swept signal.
 */
public class SweepSignal
{
	private Object obj;
	private WaveformWindow ww;
	private Analysis an;
	private boolean included;
	private int sweepIndex;

	public SweepSignal(Object obj, WaveformWindow ww, Analysis an)
	{
		this.obj = obj;
		this.ww = ww;
		this.an = an;
		included = true;
        sweepIndex = ww.addSweep(this);
	}

	public String toString()
	{
		String name = null;
		if (obj instanceof Double) name = TextUtils.formatDouble(((Double)obj).doubleValue()); else
			name = obj.toString();
		if (included)
		{
			name += " >>>>> INCLUDED";
			if (ww.getHighlightedSweep() == sweepIndex)
				name += " !!!!";
		} else
		{
			name += " ----- EXCLUDED";
		}
		return name;
	}

	public void setIncluded(boolean included, boolean update)
	{
		if (this.included == included) return;
		this.included = included;
		if (update)
		{
			for(Iterator<Panel> it = ww.getPanels(); it.hasNext(); )
			{
				Panel wp = it.next();
				wp.repaintWithRulers();
			}
		}
	}

    public Object getObject() { return obj; }

	public boolean isIncluded() { return included; }

	public void highlight()
	{
		ww.setHighlightedSweep(sweepIndex);
		for(Iterator<Panel> it = ww.getPanels(); it.hasNext(); )
		{
			Panel wp = it.next();
			wp.repaintWithRulers();
		}
	}

	public Analysis getAnalysis() { return an; }
}