#region Copyright
/*
* Copyright (c) 2005,2006,2007, OpenMI Association
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*     * Redistributions of source code must retain the above copyright
*       notice, this list of conditions and the following disclaimer.
*     * Redistributions in binary form must reproduce the above copyright
*       notice, this list of conditions and the following disclaimer in the
*       documentation and/or other materials provided with the distribution.
*     * Neither the name of the OpenMI Association nor the
*       names of its contributors may be used to endorse or promote products
*       derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY "OpenMI Association" ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL "OpenMI Association" BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#endregion 

using System;
using OpenMI.Standard;

namespace RTCTools.OpenMI.Sdk.Backbone
{

	/// <summary>
	/// The Unit class defines a unit for a quantity.
    /// <para>This is a trivial implementation of OpenMI.Standard.IUnit, refer there for further details.</para>
    /// </summary>
	[Serializable]
	public class Unit : IUnit
	{
		private string _description="";
		private string _id="";
		private double _conversionFactor = 1;
		private double _conversionOffset = 0;

		/// <summary>
		/// Constructor
		/// </summary>
		public Unit()
		{
		}

		/// <summary>
		/// Copy constructor
		/// </summary>
		/// <param name="source">The unit to copy</param>
		public Unit(IUnit source)
		{
			Description = source.Description;
			ID = source.ID;
			ConversionFactorToSI = source.ConversionFactorToSI;
			OffSetToSI = source.OffSetToSI;
		}

		/// <summary>
		/// Constructor
		/// </summary>
		/// <param name="ID">ID</param>
		/// <param name="conversionFactor">Conversion factor to SI</param>
		/// <param name="conversionOffset">Conversion offset to SI</param>
		public Unit(string ID, double conversionFactor, double conversionOffset)
		{
			_id = ID;
			_conversionFactor = conversionFactor;
			_conversionOffset = conversionOffset;
			_description = "";
		}

		/// <summary>
		/// Constructor
		/// </summary>
		/// <param name="ID">ID</param>
		/// <param name="conversionFactor">Conversion factor to SI</param>
		/// <param name="conversionOffset">Conversion offset to SI</param>
		/// <param name="description">Description</param>
		public Unit(string ID, double conversionFactor, double conversionOffset,string description)
		{
			_id = ID;
			_conversionFactor = conversionFactor;
			_conversionOffset = conversionOffset;
			_description = description;
		}

		/// <summary>
		/// Getter and setter for description
		/// </summary>
		public string Description
		{
			get { return _description;}
			set
			{
				_description = value;
			}
		}

		/// <summary>
		/// Getter and setter for conversion factor to SI
		/// </summary>
		public double ConversionFactorToSI
		{
			get {return _conversionFactor;}
			set
			{
				_conversionFactor = value;
			}
		}

		/// <summary>
		/// Getter and setter for offset to SI
		/// </summary>
		public double OffSetToSI
		{
			get {return _conversionOffset;}
			set
			{
				_conversionOffset = value;
			}
		}

		/// <summary>
		/// Getter and setter for ID
		/// </summary>
		public string ID
		{
			get {return _id;}
			set
			{
				_id = value;
			}
		}

		///<summary>
		/// Check if the current instance equals another instance of this class.
		///</summary>
		///<param name="obj">The instance to compare the current instance with.</param>
		///<returns><code>true</code> if the instances are the same instance or have the same content.</returns>
		public override bool Equals(Object obj) 
		{
			if (obj == null || GetType() != obj.GetType()) 
				return false;
			Unit u = (Unit) obj;
			if (!ID.Equals(u.ID))
				return false;
			if (!Description.Equals(u.Description))
				return false;
			if (!ConversionFactorToSI.Equals(u.ConversionFactorToSI))
				return false;
			if (!OffSetToSI.Equals(u.OffSetToSI))
				return false;
			return true;
		}

		///<summary>
		/// Get Hash Code.
		///</summary>
		///<returns>Hash Code for the current instance.</returns>
		public override int GetHashCode()
		{
			int hashCode = base.GetHashCode();
			if (_id != null) hashCode += _id.GetHashCode();
			return hashCode;
		}
	}
}