Mercurial > repos > IBBoard.WarFoundry.API
changeset 354:47acc63cf529
Re #27: Unit requirements
* Bit mask the values with a bitwise AND rather than an OR
| author | IBBoard <dev@ibboard.co.uk> |
|---|---|
| date | Fri, 22 Apr 2011 10:38:03 +0000 |
| parents | 65fccdd51aec |
| children | 47712a323cf2 |
| files | API/Objects/Requirement/Validation.cs |
| diffstat | 1 files changed, 54 insertions(+), 54 deletions(-) [+] |
line wrap: on
line diff
--- a/API/Objects/Requirement/Validation.cs Sun Apr 17 20:08:43 2011 +0000 +++ b/API/Objects/Requirement/Validation.cs Fri Apr 22 10:38:03 2011 +0000 @@ -1,54 +1,54 @@ -// This file (Validation.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2011 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; - -namespace IBBoard.WarFoundry.API.Objects.Requirement -{ - /// <summary> - /// A custom enum for validation to distinguish between "validation wasn't necessary" and "validation passed". - /// This should allow for easier handling of failed requirements later being satisfied. - /// </summary> - public enum Validation - { - Passed = 1, - Failed = 2, - NotApplicable = 3 - } - - /// <summary> - /// A helper class to handle the enums and treat them as booleans where a pass/fail is all that is necessary. - /// </summary> - public class Validates - { - /// <summary> - /// Checks if the validation was okay (pass or not applicable) - /// </summary> - /// <returns> - /// <code>true</code> if the validation passed or was not applicable, else <code>false</code> - /// </returns> - /// <param name='passed'> - /// The Validation enum value to check - /// </param> - public static bool AsOkay(Validation result) - { - return (result | Validation.Passed) == Validation.Passed; - } - - /// <summary> - /// Checks if the validation result was not okay (failed or not applicable). Note that this is different - /// to <code>!Validates.AsOkay(result)</code> because this method treats not applicable as not being okay. - /// </summary> - /// <returns> - /// <code>true</code> if the validation failed or was not applicable, else <code>false</code> - /// </returns> - /// <param name='result'> - /// The Validation enum value to check - /// </param> - public static bool AsNotOkay (Validation result) - { - return (result | Validation.Failed) == Validation.Failed; - } - } -} - +// This file (Validation.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2011 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; + +namespace IBBoard.WarFoundry.API.Objects.Requirement +{ + /// <summary> + /// A custom enum for validation to distinguish between "validation wasn't necessary" and "validation passed". + /// This should allow for easier handling of failed requirements later being satisfied. + /// </summary> + public enum Validation + { + Passed = 1, + Failed = 2, + NotApplicable = 3 + } + + /// <summary> + /// A helper class to handle the enums and treat them as booleans where a pass/fail is all that is necessary. + /// </summary> + public class Validates + { + /// <summary> + /// Checks if the validation was okay (pass or not applicable) + /// </summary> + /// <returns> + /// <code>true</code> if the validation passed or was not applicable, else <code>false</code> + /// </returns> + /// <param name='passed'> + /// The Validation enum value to check + /// </param> + public static bool AsOkay(Validation result) + { + return (result & Validation.Passed) == Validation.Passed; + } + + /// <summary> + /// Checks if the validation result was not okay (failed or not applicable). Note that this is different + /// to <code>!Validates.AsOkay(result)</code> because this method treats not applicable as not being okay. + /// </summary> + /// <returns> + /// <code>true</code> if the validation failed or was not applicable, else <code>false</code> + /// </returns> + /// <param name='result'> + /// The Validation enum value to check + /// </param> + public static bool AsNotOkay (Validation result) + { + return (result & Validation.Failed) == Validation.Failed; + } + } +} +