Mercurial > repos > IBBoard.WarFoundry.API

annotate API/Objects/Requirement/IRequirement.cs @ 494:4f01fdc3bb41

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Re #410: Create "N units per M models in parent unit" requirement * Make sure that adding context is in at the top level and propagated through requirement handling
author IBBoard <dev@ibboard.co.uk>
date Mon, 06 Aug 2012 20:50:59 +0100
parents 248df19652f9
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
358
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
1 // This file (Requirement.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2011 IBBoard
347
44a6539fadf9 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
2 //
44a6539fadf9 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
3 // 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.
44a6539fadf9 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
4 using System;
487
248df19652f9 Re #410: Create "N units per M models in parent unit" requirement
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
5 using IBBoard.WarFoundry.API.Objects.Requirement.Context;
347
44a6539fadf9 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
6
44a6539fadf9 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
7 namespace IBBoard.WarFoundry.API.Objects.Requirement
358
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
8 {
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
9 /// <summary>
455
afc6410e4efc Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents: 428
diff changeset
10 /// Base interface for a Requirement that constrains the IWarFoundryObjects that can be taken in an army
347
44a6539fadf9 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
11 /// </summary>
44a6539fadf9 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
12 public interface IRequirement
358
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
13 {
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
14 /// <summary>
428
8f5125740316 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 364
diff changeset
15 /// Gets the ID of the requirement type. This is used by the requirement factories.
8f5125740316 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 364
diff changeset
16 /// It may be, but is not required to be, the name of the class.
8f5125740316 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 364
diff changeset
17 /// </summary>
8f5125740316 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 364
diff changeset
18 /// <value>
8f5125740316 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 364
diff changeset
19 /// The ID of the requirement type.
8f5125740316 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 364
diff changeset
20 /// </value>
8f5125740316 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 364
diff changeset
21 string RequirementID { get; }
8f5125740316 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 364
diff changeset
22
8f5125740316 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 364
diff changeset
23 /// <summary>
455
afc6410e4efc Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents: 428
diff changeset
24 /// Checks whether the supplied IWarFoundryObject can be added to the supplied army.
358
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
25 /// </summary>
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
26 /// <returns>
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
27 /// A <code>Validation</code> enum to show the result of the validation
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
28 /// </returns>
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
29 /// <param name='wfObject'>
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
30 /// The object that we want to add. This may be involved in the check, or it may not affect the evaluation of the requirement
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
31 /// </param>
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
32 /// <param name='toArmy'>
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
33 /// The army to add the object to.
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
34 /// </param>
494
4f01fdc3bb41 Re #410: Create "N units per M models in parent unit" requirement
IBBoard <dev@ibboard.co.uk>
parents: 487
diff changeset
35 Validation AllowsAdding(IWarFoundryObject wfObject, Army toArmy, AddingContext context);
358
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
36
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
37 /// <summary>
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
38 /// Checks whether the supplied army is currently valid according to this requirement.
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
39 /// </summary>
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
40 /// <returns>
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
41 /// A <code>Validation</code> enum to show the result of the validation
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
42 /// </returns>
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
43 /// <param name='toValidate'>
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
44 /// The army to validate
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
45 /// </param>
347
44a6539fadf9 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
46 Validation ValidatesArmy(Army army);
358
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
47
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
48 /// <summary>
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
49 /// Gets the validation message from validating the army
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
50 /// </summary>
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
51 /// <returns>
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
52 /// A validation message, if the validation fails, else an empty string.
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
53 /// </returns>
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
54 /// <param name='army'>
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
55 /// The army to validate.
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
56 /// </param>
dbe7ccb1e557 Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 347
diff changeset
57 string GetValidationMessage(Army army);
364
0dd8dbe8afe9 Fixes #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 358
diff changeset
58
0dd8dbe8afe9 Fixes #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 358
diff changeset
59 /// <summary>
455
afc6410e4efc Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents: 428
diff changeset
60 /// Gets the validation message for adding an IWarFoundryObject to the army
364
0dd8dbe8afe9 Fixes #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 358
diff changeset
61 /// </summary>
0dd8dbe8afe9 Fixes #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 358
diff changeset
62 /// <returns>
455
afc6410e4efc Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents: 428
diff changeset
63 /// A validation message, if the object cannot be added, else an empty string.
364
0dd8dbe8afe9 Fixes #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 358
diff changeset
64 /// </returns>
0dd8dbe8afe9 Fixes #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 358
diff changeset
65 /// <param name='toAdd'>
455
afc6410e4efc Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents: 428
diff changeset
66 /// The IWarFoundryObject to try to add
364
0dd8dbe8afe9 Fixes #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 358
diff changeset
67 /// </param>
0dd8dbe8afe9 Fixes #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 358
diff changeset
68 /// <param name='toArmy'>
455
afc6410e4efc Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents: 428
diff changeset
69 /// The army the object will be added to
364
0dd8dbe8afe9 Fixes #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 358
diff changeset
70 /// </param>
487
248df19652f9 Re #410: Create "N units per M models in parent unit" requirement
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
71 /// <param name="context">
248df19652f9 Re #410: Create "N units per M models in parent unit" requirement
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
72 /// The context of the addition
248df19652f9 Re #410: Create "N units per M models in parent unit" requirement
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
73 /// </para>
248df19652f9 Re #410: Create "N units per M models in parent unit" requirement
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
74 string GetAllowsAddingMessage(IWarFoundryObject toAdd, Army toArmy, AddingContext context);
347
44a6539fadf9 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
75 }
44a6539fadf9 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
76 }
44a6539fadf9 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
77