aurorafw.entity.system source code

1 /*
2                                     __
3                                    / _|
4   __ _ _   _ _ __ ___  _ __ __ _  | |_ ___  ___ ___
5  / _` | | | | '__/ _ \| '__/ _` | |  _/ _ \/ __/ __|
6 | (_| | |_| | | | (_) | | | (_| | | || (_) \__ \__ \
7  \__,_|\__,_|_|  \___/|_|  \__,_| |_| \___/|___/___/
8 
9 Copyright (C) 2019 Aurora Free Open Source Software.
10 Copyright (C) 2019 João Lourenço <joao@aurorafoss.org>
11 
12 This file is part of the Aurora Free Open Source Software. This
13 organization promote free and open source software that you can
14 redistribute and/or modify under the terms of the GNU Lesser General
15 Public License Version 3 as published by the Free Software Foundation or
16 (at your option) any later version approved by the Aurora Free Open Source
17 Software Organization. The license is available in the package root path
18 as 'LICENSE' file. Please review the following information to ensure the
19 GNU Lesser General Public License version 3 requirements will be met:
20 https://www.gnu.org/licenses/lgpl.html .
21 
22 Alternatively, this file may be used under the terms of the GNU General
23 Public License version 3 or later as published by the Free Software
24 Foundation. Please review the following information to ensure the GNU
25 General Public License requirements will be met:
26 https://www.gnu.org/licenses/gpl-3.0.html.
27 
28 NOTE: All products, services or anything associated to trademarks and
29 service marks used or referenced on this file are the property of their
30 respective companies/owners or its subsidiaries. Other names and brands
31 may be claimed as the property of others.
32 
33 For more info about intellectual property visit: aurorafoss.org or
34 directly send an email to: contact (at) aurorafoss.org .
35 */
36 
37 module aurorafw.entity.system;
38 
39 import aurorafw.entity.systemmanager;
40 
41 version(unittest) import aurorafw.unit.assertion;
42 
43 
44 abstract class System
45 {
46 	/**
47 	 * Update policy
48 	 *
49 	 * Decides wether or not a system is updated manualy or automatically
50 	 */
51 	enum UpdatePolicy
52 	{
53 		Automatic,
54 		Manual
55 	}
56 
57 
58 	@safe pure
59 	public this(UpdatePolicy updatePolicy = UpdatePolicy.Automatic)
60 	{
61 		this.updatePolicy = updatePolicy;
62 	}
63 
64 
65 	/**
66 	 * Update
67 	 *
68 	 * Use this method to update each system
69 	 *
70 	 * Examples:
71 	 * --------------------
72 	 * final class FooSystem : System
73 	 * {
74 	 *    override public void update() { *everything you want to update* }
75 	 * }
76 	 * --------------------
77 	 */
78 	@safe pure
79 	public abstract void update();
80 
81 
82 	public UpdatePolicy updatePolicy;
83 	package SystemManager manager;
84 }