/*******************************************************************************
 * Copyright (C) 2013  Stefan Schroeder
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either 
 * version 3.0 of the License, or (at your option) any later version.
 * 
 * This library 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 General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public 
 * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
 ******************************************************************************/
package jsprit.core.problem.vehicle;

import jsprit.core.problem.Capacity;
import jsprit.core.problem.vehicle.VehicleTypeImpl.VehicleCostParams;

/**
 * Basic interface for vehicle-type-data.
 * 
 * @author schroeder
 *
 */
public interface VehicleType {

	/**
	 * Returns typeId.
	 * 
	 * @return typeId
	 */
	public String getTypeId();

	/**
	 * Returns capacity.
	 * 
	 * <p>In future versions there will be a capacity-object with an arbitrary number of capacity dimensions. (stefan,11.01.14)
	 * 
	 * 
	 * @deprecated use <code>.getCapacityDimensions()</code> - if you still use it, but set CapacityDimensions rather
	 * than setCapacity(...) it will return the capacity.dimension with index=0
	 * @return cap
	 */
	@Deprecated
	public int getCapacity();
	
	/**
	 * Returns capacity dimensions.
	 * 
	 * @return {@link Capacity}
	 */
	public Capacity getCapacityDimensions();
	
	/**
	 * Returns maximum velocity of this vehicle-type.
	 * 
	 * @return max velocity
	 */
	public double getMaxVelocity();

	/**
	 * Return the cost-parameter of this vehicle-type.
	 * 
	 * @return parameter
	 */
	public VehicleCostParams getVehicleCostParams();

}
