view api/Objects/WarFoundryObject.cs @ 161:81abc04b3dbe

Re #192: Improve "clean coding" practice * Move some calculation methods for equipment out of the encapsulation objects
author IBBoard <dev@ibboard.co.uk>
date Sun, 04 Oct 2009 12:00:16 +0000
parents f58051572ec7
children
line wrap: on
line source

// This file (WarFoundryObject.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2007, 2008, 2009 IBBoard.
//
// The file and the library/program it is in are licensed and distributed, without warranty, under the GNU Affero GPL license, either version 3 of the License or (at your option) any later version. Please see COPYING for more information and the full license.

using System;
using IBBoard.WarFoundry.API.Factories;

namespace IBBoard.WarFoundry.API.Objects
{
	/// <summary>
	/// Summary description for WarFoundryObject.
	/// </summary>
	public abstract class WarFoundryObject : IWarFoundryObject
	{
		protected string id;
		protected string name;
		public event StringValChangedDelegate NameChanged;
		
		protected WarFoundryObject()
		{
		}
				
		protected WarFoundryObject(string objName) : this()
		{
			Name = objName;
		}
		
		protected WarFoundryObject(string objId, string objName) : this(objName)
		{
			ID = objId;
		}	

		public virtual string ID
		{
			get
			{
				if (id == null || id == "")
				{
					id = GenerateID();
				}
				
				return id;
			}
			
			set
			{
				string newId = (value == null ? "" : value.Trim());
				id = (newId == "" ? GenerateID() : newId);
			}
		}

		public virtual string Name
		{
			get 
			{
				if (HasDefaultName())
				{
					return DefaultName();
				}
				else
				{
					return name;
				} 
			}
			set 
			{ 
				string oldValue = name;
				name = value;

				if (name!=oldValue)
				{
					OnNameChanged(oldValue, name);
				}
			}
		}

		public bool HasDefaultName()
		{
			return (name == null || name == "");
		}

		protected void OnNameChanged(string oldValue, string newValue)
		{
			if (NameChanged!=null)
			{
				NameChanged(this, oldValue, newValue);
			}
		}

		protected virtual string DefaultName()
		{
			return "-";
		}

		protected string GenerateID()
		{
			return Name + UnixTimestamp.GetTimestamp(DateTime.Now) + "." + DateTime.Now.Millisecond;
		}
	}
}