Mercurial > repos > IBDev-IBBoard.WarFoundry.API

comparison api/Objects/InvalidContainershipException.cs @ 61:3c77722a02b5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
comparison
equal deleted inserted replaced
60:0c3500fca49d 61:3c77722a02b5
1 // This file (InvalidContainershipException.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2009 IBBoard
2 //
3 // 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.
4 //
5
6 using System;
7
8 namespace IBBoard.WarFoundry.API.Objects
9 {
10 /// <summary>
11 /// 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
12 /// by that unit.
13 /// </summary>
14 public class InvalidContainershipException : Exception
15 {
16 private Unit containing;
17 private Unit contained;
18
19 public InvalidContainershipException(Unit containingUnit, Unit containedUnit) : base(CreateMessageString(containingUnit, containedUnit))
20 {
21 containing = containingUnit;
22 contained = containedUnit;
23 }
24
25 private static string CreateMessageString(Unit containingUnit, Unit containedUnit)
26 {
27 return containingUnit.Name+" cannot contain "+containedUnit.Name+" because units of "+containingUnit.UnitType.Name+" cannot contain units of "+containedUnit.UnitType.Name;
28 }
29
30 /// <value>
31 /// The <see cref=" Unit"/> that the contained unit was added to
32 /// </value>
33 public Unit ContainingUnit
34 {
35 get { return containing; }
36 }
37
38 /// <value>
39 /// The <see cref=" Unit"/> that was added as a contained unit, but which was not of an allowed type
40 /// </value>
41 public Unit ContainedUnit
42 {
43 get { return contained; }
44 }
45 }
46 }