1

/* $Id$ */

     2

     3

/** @file cargopacket.h */

     4

     5

#ifndef CARGOPACKET_H

     6

#define CARGOPACKET_H

     7

     8

#include "economy_type.h"

     9

#include "tile_type.h"

    11

#include <list>

    12

    13

typedef uint32 CargoPacketID;

    14

struct CargoPacket;

    15

    16

/** We want to use a pool */

    17

DECLARE_OLD_POOL(CargoPacket, CargoPacket, 10, 1000)

    18

    19

    20

/**

    21

 * Container for cargo from the same location and time

    22

 */

    23

struct CargoPacket : PoolItem<CargoPacket, CargoPacketID, &_CargoPacket_pool> {

    24

	StationID source;       ///< The station where the cargo came from first

    25

	TileIndex source_xy;    ///< The origin of the cargo (first station in feeder chain)

    26

	TileIndex loaded_at_xy; ///< Location where this cargo has been loaded into the vehicle

    27

    28

	uint16 count;           ///< The amount of cargo in this packet

    29

	byte days_in_transit;   ///< Amount of days this packet has been in transit

    30

	Money feeder_share;     ///< Value of feeder pickup to be paid for on delivery of cargo

    31

	bool paid_for;          ///< Have we been paid for this cargo packet?

    32

    33

	/**

    34

	 * Creates a new cargo packet

    35

	 * @param source the source of the packet

    36

	 * @param count  the number of cargo entities to put in this packet

    37

	 * @pre count != 0 || source == INVALID_STATION

    38

	 */

    39

	CargoPacket(StationID source = INVALID_STATION, uint16 count = 0);

    40

    41

	/** Destroy the packet */

    42

	virtual ~CargoPacket();

    43

    44

    45

	/**

    46

	 * Is this a valid cargo packet ?

    47

	 * @return true if and only it is valid

    48

	 */

    49

	inline bool IsValid() const { return this->count != 0; }

    50

    51

	/**

    52

	 * Checks whether the cargo packet is from (exactly) the same source

    53

	 * in time and location.

    54

	 * @param cp the cargo packet to compare to

    55

	 * @return true if and only if days_in_transit and source_xy are equal

    56

	 */

    57

	bool SameSource(const CargoPacket *cp) const;

    58

};

    59

    60

/**

    61

 * Iterate over all _valid_ cargo packets from the given start

    62

 * @param cp    the variable used as "iterator"

    63

 * @param start the cargo packet ID of the first packet to iterate over

    64

 */

    65

#define FOR_ALL_CARGOPACKETS_FROM(cp, start) for (cp = GetCargoPacket(start); cp != NULL; cp = (cp->index + 1U < GetCargoPacketPoolSize()) ? GetCargoPacket(cp->index + 1U) : NULL) if (cp->IsValid())

    66

    67

/**

    68

 * Iterate over all _valid_ cargo packets from the begin of the pool

    69

 * @param cp    the variable used as "iterator"

    70

 */

    71

#define FOR_ALL_CARGOPACKETS(cp) FOR_ALL_CARGOPACKETS_FROM(cp, 0)

    72

    73

extern void SaveLoad_STNS(Station *st);

    74

    75

/**

    76

 * Simple collection class for a list of cargo packets

    77

 */

    78

class CargoList {

    79

public:

    80

	/** List of cargo packets */

    81

	typedef std::list<CargoPacket *> List;

    82

    83

	/** Kind of actions that could be done with packets on move */

    84

	enum MoveToAction {

    85

		MTA_FINAL_DELIVERY, ///< "Deliver" the packet to the final destination, i.e. destroy the packet

    86

		MTA_CARGO_LOAD,     ///< Load the packet onto a vehicle, i.e. set the last loaded station ID

    87

		MTA_OTHER           ///< "Just" move the packet to another cargo list

    88

	};

    89

    90

private:

    91

	List packets;         ///< The cargo packets in this list

    92

    93

	bool empty;           ///< Cache for whether this list is empty or not

    94

	uint count;           ///< Cache for the number of cargo entities

    95

	bool unpaid_cargo;    ///< Cache for the unpaid cargo

    96

	Money feeder_share;   ///< Cache for the feeder share

    97

	StationID source;     ///< Cache for the source of the packet

    98

	uint days_in_transit; ///< Cache for the number of days in transit

    99

   100

public:

   101

	friend void SaveLoad_STNS(Station *st);

   102

   103

	/** Create the cargo list */

   104

	CargoList() { this->InvalidateCache(); }

   105

	/** And destroy it ("frees" all cargo packets) */

   106

	~CargoList();

   107

   108

	/**

   109

	 * Returns a pointer to the cargo packet list (so you can iterate over it etc).

   110

	 * @return pointer to the packet list

   111

	 */

   112

	const CargoList::List *Packets() const;

   113

   114

	/**

   115

	 * Ages the all cargo in this list

   116

	 */

   117

	void AgeCargo();

   118

   119

	/**

   120

	 * Checks whether this list is empty

   121

	 * @return true if and only if the list is empty

   122

	 */

   123

	bool Empty() const;

   124

   125

	/**

   126

	 * Returns the number of cargo entities in this list

   127

	 * @return the before mentioned number

   128

	 */

   129

	uint Count() const;

   130

   131

	/**

   132

	 * Is there some cargo that has not been paid for?

   133

	 * @return true if and only if there is such a cargo

   134

	 */

   135

	bool UnpaidCargo() const;

   136

   137

	/**

   138

	 * Returns total sum of the feeder share for all packets

   139

	 * @return the before mentioned number

   140

	 */

   141

	Money FeederShare() const;

   142

   143

	/**

   144

	 * Returns source of the first cargo packet in this list

   145

	 * @return the before mentioned source

   146

	 */

   147

	StationID Source() const;

   148

   149

	/**

   150

	 * Returns average number of days in transit for a cargo entity

   151

	 * @return the before mentioned number

   152

	 */

   153

	uint DaysInTransit() const;

   154

   155

   156

	/**

   157

	 * Appends the given cargo packet

   158

	 * @warning After appending this packet may not exist anymore!

   159

	 * @note Do not use the cargo packet anymore after it has been appended to this CargoList!

   160

	 * @param cp the cargo packet to add

   161

	 * @pre cp != NULL

   162

	 */

   163

	void Append(CargoPacket *cp);

   164

   165

	/**

   166

	 * Truncates the cargo in this list to the given amount. It leaves the

   167

	 * first count cargo entities and removes the rest.

   168

	 * @param count the maximum amount of entities to be in the list after the command

   169

	 */

   170

	void Truncate(uint count);

   171

   172

	/**

   173

	 * Moves the given amount of cargo to another list.

   174

	 * Depending on the value of mta the side effects of this function differ:

   175

	 *  - MTA_FINAL_DELIVERY: destroys the packets that do not originate from a specific station

   176

	 *  - MTA_CARGO_LOAD:     sets the loaded_at_xy value of the moved packets

   177

	 *  - MTA_OTHER:          just move without side effects

   178

	 * @param dest  the destination to move the cargo to

   179

	 * @param count the amount of cargo entities to move

   180

	 * @param mta   how to handle the moving (side effects)

   181

	 * @param data  Depending on mta the data of this variable differs:

   182

	 *              - MTA_FINAL_DELIVERY - station ID of packet's origin not to remove

   183

	 *              - MTA_CARGO_LOAD     - station's tile index of load

   184

	 *              - MTA_OTHER          - unused

   185

	 * @param mta == MTA_FINAL_DELIVERY || dest != NULL

   186

	 * @return true if there are still packets that might be moved from this cargo list

   187

	 */

   188

	bool MoveTo(CargoList *dest, uint count, CargoList::MoveToAction mta = MTA_OTHER, uint data = 0);

   189

   190

	/** Invalidates the cached data and rebuild it */

   191

	void InvalidateCache();

   192

};

   193

   194

#endif /* CARGOPACKET_H */