/*******************************************************************************
 *     SDR Trunk 
 *     Copyright (C) 2014 Dennis Sheirer
 * 
 *     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 3 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, see <http://www.gnu.org/licenses/>
 ******************************************************************************/
package controller.channel;

import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;

@XmlRootElement
@XmlType( name = "range" )
public class ChannelRange
{
	private int mFirst = 1;
	private int mLast = 1023;
	private int mBase = 450000000;
	private int mSize = 12500;

	/* JAXB requirement - do not remove */
	public ChannelRange() {}
	
	public ChannelRange( int first, int last, int base, int size )
	{
		mFirst = first;
		mLast = last;
		mBase = base;
		mSize = size;
	}

	public ChannelRange copyOf()
	{
		return new ChannelRange( mFirst, mLast, mBase, mSize );
	}
	
	public boolean isValid()
	{
		return mFirst < mLast;
	}
	
	public boolean hasChannel( int channel )
	{
		return mFirst <= channel && channel <= mLast;
	}
	
	public long getFrequency( int channel )
	{
		if( hasChannel( channel ) )
		{
			return mBase + ( ( channel - mFirst ) * mSize );
		}
		else
		{
			return 0;
		}
	}
	
	@XmlAttribute( name = "first" )
	public int getFirstChannelNumber()
	{
		return mFirst;
	}
	
	public void setFirstChannelNumber( int first )
	{
		mFirst = first;
	}

	@XmlAttribute( name = "last" )
	public void setLastChannelNumber( int last )
	{
		mLast = last;
	}
	
	public int getLastChannelNumber()
	{
		return mLast;
	}

	/**
	 * Sets the base frequency
	 * @param base frequency in hertz
	 */
	@XmlAttribute( name = "base" )
	public void setBase( int base )
	{
		mBase = base;
	}
	
	public int getBase()
	{
		return mBase;
	}

	/**
	 * Sets the channel size 
	 * @param size in hertz
	 */
	@XmlAttribute( name = "size" )
	public void setSize( int size )
	{
		mSize = size;
	}
	
	public int getSize()
	{
		return mSize;
	}
}