1

/* $Id$ */

     2

     3

/** @file cargotype.h */

     4

     5

#ifndef CARGOPACKET_H

     6

#define CARGOPACKET_H

     7

     8

#include "economy_type.h"

     9

#include <list>

    10

    11

typedef uint32 CargoPacketID;

    12

struct CargoPacket;

    13

    14

/** We want to use a pool */

    15

DECLARE_OLD_POOL(CargoPacket, CargoPacket, 10, 1000)

    16

    17

    18

/**

    19

 * Container for cargo from the same location and time

    20

 */

    21

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

    22

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

    23

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

    24

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

    25

    26

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

    27

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

    28

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

    29

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

    30

    31

	/**

    32

	 * Creates a new cargo packet

    33

	 * @param source the source of the packet

    34

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

    35

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

    36

	 */

    37

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

    38

    39

	/** Destroy the packet */

    40

	virtual ~CargoPacket();

    41

    42

    43

	/**

    44

	 * Is this a valid cargo packet ?

    45

	 * @return true if and only it is valid

    46

	 */

    47

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

    48

    49

	/**

    50

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

    51

	 * in time and location.

    52

	 * @param cp the cargo packet to compare to

    53

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

    54

	 */

    55

	bool SameSource(CargoPacket *cp);

    56

};

    57

    58

/**

    59

 * Iterate over all _valid_ cargo packets from the given start

    60

 * @param cp    the variable used as "iterator"

    61

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

    62

 */

    63

#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())

    64

    65

/**

    66

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

    67

 * @param cp    the variable used as "iterator"

    68

 */

    69

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

    70

    71

extern void SaveLoad_STNS(Station *st);

    72

    73

/**

    74

 * Simple collection class for a list of cargo packets

    75

 */

    76

class CargoList {

    77

public:

    78

	/** List of cargo packets */

    79

	typedef std::list<CargoPacket *> List;

    80

    81

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

    82

	enum MoveToAction {

    83

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

    84

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

    85

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

    86

	};

    87

    88

private:

    89

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

    90

    91

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

    92

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

    93

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

    94

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

    95

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

    96

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

    97

    98

public:

    99

	friend void SaveLoad_STNS(Station *st);

   100

   101

	/** Create the cargo list */

   102

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

   103

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

   104

	~CargoList();

   105

   106

	/**

   107

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

   108

	 * @return pointer to the packet list

   109

	 */

   110

	const CargoList::List *Packets() const;

   111

   112

	/**

   113

	 * Ages the all cargo in this list

   114

	 */

   115

	void AgeCargo();

   116

   117

	/**

   118

	 * Checks whether this list is empty

   119

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

   120

	 */

   121

	bool Empty() const;

   122

   123

	/**

   124

	 * Returns the number of cargo entities in this list

   125

	 * @return the before mentioned number

   126

	 */

   127

	uint Count() const;

   128

   129

	/**

   130

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

   131

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

   132

	 */

   133

	bool UnpaidCargo() const;

   134

   135

	/**

   136

	 * Returns total sum of the feeder share for all packets

   137

	 * @return the before mentioned number

   138

	 */

   139

	Money FeederShare() const;

   140

   141

	/**

   142

	 * Returns source of the first cargo packet in this list

   143

	 * @return the before mentioned source

   144

	 */

   145

	StationID Source() const;

   146

   147

	/**

   148

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

   149

	 * @return the before mentioned number

   150

	 */

   151

	uint DaysInTransit() const;

   152

   153

   154

	/**

   155

	 * Appends the given cargo packet

   156

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

   157

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

   158

	 * @param cp the cargo packet to add

   159

	 * @pre cp != NULL

   160

	 */

   161

	void Append(CargoPacket *cp);

   162

   163

	/**

   164

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

   165

	 * first count cargo entities and removes the rest.

   166

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

   167

	 */

   168

	void Truncate(uint count);

   169

   170

	/**

   171

	 * Moves the given amount of cargo to another list.

   172

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

   173

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

   174

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

   175

	 *  - MTA_OTHER:          just move without side effects

   176

	 * @param dest  the destination to move the cargo to

   177

	 * @param count the amount of cargo entities to move

   178

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

   179

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

   180

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

   181

	 *              - MTA_CARGO_LOAD     - station's tile index of load

   182

	 *              - MTA_OTHER          - unused

   183

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

   184

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

   185

	 */

   186

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

   187

   188

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

   189

	void InvalidateCache();

   190

};

   191

   192

#endif /* CARGOPACKET_H */