# HG changeset patch # User IBBoard # Date 1303468683 0 # Node ID 47acc63cf529d4db1916e70e9eaed1e03a66a347 # Parent 65fccdd51aec3fef09b8398b8edb3bedd50d5e76 Re #27: Unit requirements * Bit mask the values with a bitwise AND rather than an OR diff -r 65fccdd51aec -r 47acc63cf529 API/Objects/Requirement/Validation.cs --- 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 -{ - /// - /// 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. - /// - public enum Validation - { - Passed = 1, - Failed = 2, - NotApplicable = 3 - } - - /// - /// A helper class to handle the enums and treat them as booleans where a pass/fail is all that is necessary. - /// - public class Validates - { - /// - /// Checks if the validation was okay (pass or not applicable) - /// - /// - /// true if the validation passed or was not applicable, else false - /// - /// - /// The Validation enum value to check - /// - public static bool AsOkay(Validation result) - { - return (result | Validation.Passed) == Validation.Passed; - } - - /// - /// Checks if the validation result was not okay (failed or not applicable). Note that this is different - /// to !Validates.AsOkay(result) because this method treats not applicable as not being okay. - /// - /// - /// true if the validation failed or was not applicable, else false - /// - /// - /// The Validation enum value to check - /// - 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 +{ + /// + /// 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. + /// + public enum Validation + { + Passed = 1, + Failed = 2, + NotApplicable = 3 + } + + /// + /// A helper class to handle the enums and treat them as booleans where a pass/fail is all that is necessary. + /// + public class Validates + { + /// + /// Checks if the validation was okay (pass or not applicable) + /// + /// + /// true if the validation passed or was not applicable, else false + /// + /// + /// The Validation enum value to check + /// + public static bool AsOkay(Validation result) + { + return (result & Validation.Passed) == Validation.Passed; + } + + /// + /// Checks if the validation result was not okay (failed or not applicable). Note that this is different + /// to !Validates.AsOkay(result) because this method treats not applicable as not being okay. + /// + /// + /// true if the validation failed or was not applicable, else false + /// + /// + /// The Validation enum value to check + /// + public static bool AsNotOkay (Validation result) + { + return (result & Validation.Failed) == Validation.Failed; + } + } +} +