Mercurial > repos > IBDev-IBBoard.WarFoundry.API
view api/Objects/WarFoundryObject.cs @ 46:a5855fcd75ab
Re #11 - Document classes and methods
* Document methods in UnitType and Category classes
author | IBBoard <dev@ibboard.co.uk> |
---|---|
date | Mon, 23 Mar 2009 20:57:07 +0000 |
parents | 306558904c2a |
children | 3ea0ab04352b |
line wrap: on
line source
// This file (WarFoundryObject.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2009 IBBoard. // // The file and the library/program it is in are licensed under the GNU LGPL license, either version 3 of the License or (at your option) any later version. Please see COPYING.LGPL 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 = GenerateID(); } return id; } set { id = (value == null ? GenerateID() : value.Trim()); } } public virtual string Name { get { if (HasDefaultName()) { return DefaultName(); } else { return name; } } set { string oldValue = name; name = value; if (name!=oldValue) { OnNameChanged(oldValue, name); } } } protected 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 "ID" + UnixTimestamp.GetTimestamp(DateTime.Now) + "." + DateTime.Now.Millisecond; } } }