initial commit of the BSConf class.

[hbs.git] / bs / fleet.h

diff --git a/bs/fleet.h b/bs/fleet.h
index 16422dd7b80b163ed2dec9913ec0b66f1c46e058..7fb4f44d182a884119dd9e8773450c49310e91e1 100644 (file)
--- a/bs/fleet.h
+++ b/bs/fleet.h
@@ -18,17 +18,70 @@
 #ifndef FLEET_H
 #define FLEET_H
 
+#include <map>
+#include <string>
+#include <vector>
 
-/**
+#include "unittype.h"
+
+//!This is the engine for the whole battlesystem.
+/**This is the engine for the whole battlesystem.
+  *    One of the few parts that I plan make fully portable.
+  *\todo LOTS (I think ;)
   *@author Michael Andreen
-  *This is the engine for the whole battlesystem.
   */
-
 class Fleet 
 {
 public: 
        Fleet();
        ~Fleet();
+
+       /**Sets the name that represents this fleet. Might be different a name
+        * like foobar or some coordinates like 1:1:1. The name doesn't have to be unique,
+        * since it's up to the rest of the program to handle that part.
+        * \see Name
+        */
+       void   setName(std::string sName);
+       /**Returns the name of this fleet.
+        * \see setName
+        */
+       std::string Name();
+
+       /**The race string decides what type of ships this fleet can have.
+        * The values must be feeded into this class.
+        * \param sRace This is just the name of the race. It's case-sensitive.
+        * \return If the race is available this function returns true, if not false is returned. The race is set in both cases though.
+        * \see Race
+        */
+       bool   setRace(std::string sRace);
+       /**Just returns what race this fleet belongs to.. 
+        * \return The race, represented as a string.
+        * \see setRace
+        */
+       std::string Race();
+
+       /**Returns the total number of ships in this fleet
+        */
+       int NumberOfShips();
+
+       /**Sets the estimated time of arrival. The time as a single integer,
+        * in relation to the current time. For example if the current time is
+        * 10, and the arrival is at 12, then the eta is 2.
+        */
+       void setETA(int eta);
+       /**Return the estimated time of arrival. It's counted from the current time (tick).
+        */
+       int  ETA();
+
+
+protected:
+       std::string     m_sName;
+       std::string     m_sRace;
+       int         m_iETA;
+       std::map<std::string, std::vector<int> >        m_Fleet;
+
+       static std::map<std::string, UnitType>  s_Units;
+       static std::map<std::string, std::vector<int> > s_Races;
 };
 
 #endif