src/ai/api/ai_stationlist.hpp
author truebrain
Thu, 28 Feb 2008 01:11:23 +0000
branchnoai
changeset 9803 c86d5834fb11
parent 9778 38560cd27070
child 9816 35e866676c00
permissions -rw-r--r--
(svn r12309) [NoAI] -Codechange: optimize a little bit (a very small little bit, but every bit counts :) ) (glx)
/* $Id$ */

/** @file ai_stationlist.hpp list all the stations (you own) */
/** @defgroup AIStationList AIStationList - Valuators and lists working on/with AIStationList */

#ifndef AI_STATIONLIST_HPP
#define AI_STATIONLIST_HPP

#include "ai_abstractlist.hpp"
#include "ai_station.hpp"

/**
 * Creates a list of stations of which you are the owner.
 * @ingroup AIStationList
 */
class AIStationList : public AIAbstractList {
public:
	static const char *GetClassName() { return "AIStationList"; }

	/**
	 * @param station_type The type of station to make a list of stations for.
	 */
	AIStationList(AIStation::StationType station_type);

private:
	const char *GetListName() const { return "AIStationList"; }
};

/**
 * Creates a list of stations which the vehicle has in its orders.
 * @ingroup AIStationList
 */
class AIStationList_Vehicle : public AIAbstractList {
public:
	static const char *GetClassName() { return "AIStationList_Vehicle"; }

	/**
	 * @param vehicle_id The vehicle to get the list of stations he has in its orders from.
	 */
	AIStationList_Vehicle(VehicleID vehicle_id);

private:
	const char *GetListName() const { return "AIStationList"; }
};

#endif /* AI_STATIONLIST_HPP */