IBBoard.WarFoundry.API: API/Factories/AbstractWarFoundryFactory.cs annotate

annotate API/Factories/AbstractWarFoundryFactory.cs @ 487:248df19652f9

Re #410: Create "N units per M models in parent unit" requirement * Add null adding context * Add initial skeleton of "N units per M models in parent unit" requirement * Update use of context * Standardise some of "is applicable" testing

author	IBBoard <dev@ibboard.co.uk>
date	Fri, 27 Jul 2012 20:31:12 +0100
parents	1ed2f3ab5e35
children

rev	line source
337 3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	1 // This file (AbstractWarFoundryFactory.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2007, 2008, 2009 IBBoard.
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	2 //
3c4a6403a88c * Fix capitalisation so that new files are in the namespace 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.
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	4
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	5 using System;
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	6 using System.IO;
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	7 using System.Collections.Generic;
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	8 using IBBoard.WarFoundry.API.Objects;
482 1ed2f3ab5e35 Re #419: Remove assumptions of a file-based install IBBoard <dev@ibboard.co.uk> parents: 337 diff changeset	9 using IBBoard.WarFoundry.API.Loading;
337 3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	10
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	11 namespace IBBoard.WarFoundry.API.Factories
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	12 {
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	13 public abstract class AbstractWarFoundryFactory<FILE_TYPE> : IWarFoundryFactory
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	14 {
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	15 public event SingleArgMethodInvoker<GameSystem> GameSystemLoaded;
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	16
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	17 public event SingleArgMethodInvoker<Race> RaceLoaded;
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	18
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	19 public event SingleArgMethodInvoker<Army> ArmyLoaded;
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	20
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	21 public virtual void CompleteLoading(IWarFoundryStagedLoadObject obj)
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	22 {
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	23 //Pretend we've fully loaded, as this will probably be standard for non-native factories and some native factories
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	24 obj.SetAsFullyLoaded();
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	25 }
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	26
482 1ed2f3ab5e35 Re #419: Remove assumptions of a file-based install IBBoard <dev@ibboard.co.uk> parents: 337 diff changeset	27 public bool CanHandleFileFormat(ILoadableObject file)
337 3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	28 {
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	29 FILE_TYPE typedFile = GetFileAsSupportedType(file);
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	30 bool canHandle = typedFile != null && CheckCanHandleFileFormat(typedFile);
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	31
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	32 if (typedFile != null)
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	33 {
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	34 CleanUpFileAsSupportedType(typedFile);
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	35 }
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	36
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	37 return canHandle;
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	38 }
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	39
482 1ed2f3ab5e35 Re #419: Remove assumptions of a file-based install IBBoard <dev@ibboard.co.uk> parents: 337 diff changeset	40 public bool CanHandleFileAsRace(ILoadableObject file)
337 3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	41 {
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	42 FILE_TYPE typedFile = GetFileAsSupportedType(file);
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	43 bool canHandle = typedFile != null && CheckCanHandleFileAsRace(typedFile);
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	44
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	45 if (typedFile != null)
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	46 {
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	47 CleanUpFileAsSupportedType(typedFile);
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	48 }
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	49
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	50 return canHandle;
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	51 }
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	52
482 1ed2f3ab5e35 Re #419: Remove assumptions of a file-based install IBBoard <dev@ibboard.co.uk> parents: 337 diff changeset	53 public bool CanHandleFileAsGameSystem(ILoadableObject file)
337 3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	54 {
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	55 FILE_TYPE typedFile = GetFileAsSupportedType(file);
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	56 bool canHandle = typedFile != null && CheckCanHandleFileAsGameSystem(typedFile);
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	57
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	58 if (typedFile != null)
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	59 {
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	60 CleanUpFileAsSupportedType(typedFile);
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	61 }
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	62
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	63 return canHandle;
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	64 }
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	65
482 1ed2f3ab5e35 Re #419: Remove assumptions of a file-based install IBBoard <dev@ibboard.co.uk> parents: 337 diff changeset	66 public bool CanHandleFileAsArmy(ILoadableObject file)
337 3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	67 {
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	68 FILE_TYPE typedFile = GetFileAsSupportedType(file);
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	69 bool canHandle = typedFile != null && CheckCanHandleFileAsArmy(typedFile);
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	70
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	71 if (typedFile != null)
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	72 {
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	73 CleanUpFileAsSupportedType(typedFile);
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	74 }
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	75
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	76 return canHandle;
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	77 }
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	78
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	79 protected virtual void CleanUpFileAsSupportedType(FILE_TYPE typedFile)
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	80 {
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	81 //Do nothing by default
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	82 }
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	83
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	84 /// <summary>
482 1ed2f3ab5e35 Re #419: Remove assumptions of a file-based install IBBoard <dev@ibboard.co.uk> parents: 337 diff changeset	85 /// Converts the <see cref="ILoadableObject"/> object in to the appropriate type for this class so that it can perform its checks. If no conversion is required (the test can be performed on a <see cref="ILoadableObject"/> object) the object should be returned with no modification.
337 3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	86 /// If the file is not of supported type the <code>null</code> should be returned.
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	87 /// </summary>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	88 /// <param name="file">
482 1ed2f3ab5e35 Re #419: Remove assumptions of a file-based install IBBoard <dev@ibboard.co.uk> parents: 337 diff changeset	89 /// A <see cref="ILoadableObject"/> to get the supported source object from.
337 3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	90 /// </param>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	91 /// <returns>
482 1ed2f3ab5e35 Re #419: Remove assumptions of a file-based install IBBoard <dev@ibboard.co.uk> parents: 337 diff changeset	92 /// An object of type <see cref="FILE_TYPE"/> that has been converted from the input <see cref="ILoadableObject"/> object, or <code>null</code> if the conversion cannot be made.
337 3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	93 /// </returns>
482 1ed2f3ab5e35 Re #419: Remove assumptions of a file-based install IBBoard <dev@ibboard.co.uk> parents: 337 diff changeset	94 protected abstract FILE_TYPE GetFileAsSupportedType(ILoadableObject file);
337 3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	95
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	96 /// <summary>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	97 /// Checks whether the factory thinks it can load data from the file in its paramaterised type.
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	98 /// </summary>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	99 /// <param name="file">
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	100 /// An object of the converted <see cref="FILE_TYPE"/> to check support for
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	101 /// </param>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	102 /// <returns>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	103 /// <code>true</code> if the factory thinks it can support the file, else <code>false</code>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	104 /// </returns>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	105 protected abstract bool CheckCanHandleFileFormat(FILE_TYPE file);
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	106
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	107 /// <summary>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	108 /// Checks whether the factory thinks it can load data from the file in its paramaterised type as a Race object.
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	109 /// </summary>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	110 /// <param name="file">
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	111 /// An object of the converted <see cref="FILE_TYPE"/> to check support for
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	112 /// </param>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	113 /// <returns>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	114 /// <code>true</code> if the factory thinks it can support the file as a Race, else <code>false</code>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	115 /// </returns>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	116 protected abstract bool CheckCanHandleFileAsRace(FILE_TYPE file);
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	117
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	118 /// <summary>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	119 /// Checks whether the factory thinks it can load data from the file in its paramaterised type as a GameSystem object.
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	120 /// </summary>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	121 /// <param name="file">
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	122 /// An object of the converted <see cref="FILE_TYPE"/> to check support for
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	123 /// </param>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	124 /// <returns>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	125 /// <code>true</code> if the factory thinks it can support the file as a GameSystem, else <code>false</code>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	126 /// </returns>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	127 protected abstract bool CheckCanHandleFileAsGameSystem(FILE_TYPE file);
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	128
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	129 /// <summary>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	130 /// Checks whether the factory thinks it can load data from the file in its paramaterised type as an Army object.
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	131 /// </summary>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	132 /// <param name="file">
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	133 /// An object of the converted <see cref="FILE_TYPE"/> to check support for
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	134 /// </param>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	135 /// <returns>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	136 /// <code>true</code> if the factory thinks it can support the file as a Army, else <code>false</code>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	137 /// </returns>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	138 protected abstract bool CheckCanHandleFileAsArmy(FILE_TYPE file);
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	139
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	140
482 1ed2f3ab5e35 Re #419: Remove assumptions of a file-based install IBBoard <dev@ibboard.co.uk> parents: 337 diff changeset	141 public ICollection<IWarFoundryObject> CreateObjectsFromFile(ILoadableObject file)
337 3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	142 {
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	143 return DoCreateObjectsFromFile(GetFileAsSupportedType(file));
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	144 }
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	145
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	146 /// <summary>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	147 /// Reads the data from the supplied converted <see cref="FILE_TYPE"/> object and returns it as a collection of loadable objects.
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	148 /// In addition, the method fires the appropriate XxxLoaded event for each object created for asynchronous use.
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	149 /// </summary>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	150 /// <param name="file">
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	151 /// An object of the converted <see cref="FILE_TYPE"/> for the file to load data from
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	152 /// </param>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	153 /// <returns>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	154 /// A <see cref="ICollection`1"/> of <see cref="IWarFoundryObject"/>s that were loaded from the file object
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	155 /// </returns>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	156 protected abstract ICollection<IWarFoundryObject> DoCreateObjectsFromFile(FILE_TYPE file);
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	157
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	158 protected void OnGameSystemLoaded(GameSystem system)
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	159 {
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	160 if (GameSystemLoaded != null)
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	161 {
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	162 GameSystemLoaded(system);
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	163 }
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	164 }
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	165
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	166 protected void OnRaceLoaded(Race race)
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	167 {
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	168 if (RaceLoaded != null)
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	169 {
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	170 RaceLoaded(race);
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	171 }
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	172 }
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	173
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	174 protected void OnArmyLoaded(Army army)
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	175 {
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	176 if (ArmyLoaded != null)
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	177 {
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	178 ArmyLoaded(army);
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	179 }
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	180 }
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	181 }
3c4a6403a88c * Fix capitalisation so that new files are in the namespace IBBoard <dev@ibboard.co.uk> parents: diff changeset	182 }

Mercurial > repos > IBBoard.WarFoundry.API

annotate API/Factories/AbstractWarFoundryFactory.cs @ 487:248df19652f9