Mercurial > repos > IBBoard.WarFoundry.API
diff api/Objects/InvalidContainershipException.cs @ 61:3c77722a02b5
Re #61 - Complete structure of WarFoundry API objects
* Add containership support to Unit class
* Add method to UnitType to check if a UnitType is of an allowed type
author | IBBoard <dev@ibboard.co.uk> |
---|---|
date | Thu, 09 Apr 2009 14:17:53 +0000 |
parents | |
children | 2f3cafb69799 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/api/Objects/InvalidContainershipException.cs Thu Apr 09 14:17:53 2009 +0000 @@ -0,0 +1,46 @@ +// This file (InvalidContainershipException.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; + +namespace IBBoard.WarFoundry.API.Objects +{ + /// <summary> + /// A custom exception for when a unit was added as a sub-unit of another unit, but was not of a <see cref=" UnitType"/> that can be contained + /// by that unit. + /// </summary> + public class InvalidContainershipException : Exception + { + private Unit containing; + private Unit contained; + + public InvalidContainershipException(Unit containingUnit, Unit containedUnit) : base(CreateMessageString(containingUnit, containedUnit)) + { + containing = containingUnit; + contained = containedUnit; + } + + private static string CreateMessageString(Unit containingUnit, Unit containedUnit) + { + return containingUnit.Name+" cannot contain "+containedUnit.Name+" because units of "+containingUnit.UnitType.Name+" cannot contain units of "+containedUnit.UnitType.Name; + } + + /// <value> + /// The <see cref=" Unit"/> that the contained unit was added to + /// </value> + public Unit ContainingUnit + { + get { return containing; } + } + + /// <value> + /// The <see cref=" Unit"/> that was added as a contained unit, but which was not of an allowed type + /// </value> + public Unit ContainedUnit + { + get { return contained; } + } + } +}