1

/* $Id$ */

     2

     3

/** @file cargotype.h */

     4

     5

#ifndef CARGOPACKET_H

     6

#define CARGOPACKET_H

     7

     8

#include <list>

     9

    10

typedef uint32 CargoPacketID;

    11

struct CargoPacket;

    12

    13

/** We want to use a pool */

    14

DECLARE_OLD_POOL(CargoPacket, CargoPacket, 10, 1000)

    15

    16

    17

/**

    18

 * Container for cargo from the same location and time

    19

 */

    20

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

    21

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

    22

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

    23

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

    24

    25

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

    26

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

    27

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

    28

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

    29

    30

	/**

    31

	 * Creates a new cargo packet

    32

	 * @param source the source of the packet

    33

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

    34

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

    35

	 */

    36

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

    37

    38

	/** Destroy the packet */

    39

	virtual ~CargoPacket();

    40

    41

    42

	/**

    43

	 * Is this a valid cargo packet ?

    44

	 * @return true if and only it is valid

    45

	 */

    46

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

    47

    48

	/**

    49

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

    50

	 * in time and location.

    51

	 * @param cp the cargo packet to compare to

    52

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

    53

	 */

    54

	bool SameSource(CargoPacket *cp);

    55

};

    56

    57

/**

    58

 * Iterate over all _valid_ cargo packets from the given start

    59

 * @param cp    the variable used as "iterator"

    60

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

    61

 */

    62

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

    63

    64

/**

    65

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

    66

 * @param cp    the variable used as "iterator"

    67

 */

    68

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

    69

    70

/**

    71

 * Simple collection class for a list of cargo packets

    72

 */

    73

class CargoList {

    74

public:

    75

	/** List of cargo packets */

    76

	typedef std::list<CargoPacket *> List;

    77

    78

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

    79

	enum MoveToAction {

    80

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

    81

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

    82

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

    83

	};

    84

    85

private:

    86

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

    87

    88

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

    89

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

    90

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

    91

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

    92

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

    93

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

    94

    95

public:

    96

	/**

    97

	 * Needed for an ugly hack:

    98

	 *  - vehicles and stations need to store cargo lists, so they use CargoList as container

    99

	 *  - this internals of the container should be protected, e.g. private (or protected) by C++

   100

	 *  - for saving/loading we need to pass pointer to objects

   101

	 *  -> so *if* the pointer to the cargo list is the same as the pointer to the packet list

   102

	 *     encapsulated in the CargoList, we can just pass the CargoList as "offset".

   103

	 *     Normally we would then just add the offset of the packets variable within the cargo list

   104

	 *     but that is not possible because the variable is private. Furthermore we are not sure

   105

	 *     that this works on all platforms, we need to check whether the offset is actually 0.

   106

	 *     This cannot be done compile time, because the variable is private. So we need to write

   107

	 *     a function that does actually check the offset runtime and call it somewhere where it

   108

	 *     is always called but it should not be called often.

   109

	 */

   110

	static void AssertOnWrongPacketOffset();

   111

   112

	/** Create the cargo list */

   113

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

   114

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

   115

	~CargoList();

   116

   117

	/**

   118

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

   119

	 * @return pointer to the packet list

   120

	 */

   121

	const CargoList::List *Packets() const;

   122

   123

	/**

   124

	 * Ages the all cargo in this list

   125

	 */

   126

	void AgeCargo();

   127

   128

	/**

   129

	 * Checks whether this list is empty

   130

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

   131

	 */

   132

	bool Empty() const;

   133

   134

	/**

   135

	 * Returns the number of cargo entities in this list

   136

	 * @return the before mentioned number

   137

	 */

   138

	uint Count() const;

   139

   140

	/**

   141

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

   142

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

   143

	 */

   144

	bool UnpaidCargo() const;

   145

   146

	/**

   147

	 * Returns total sum of the feeder share for all packets

   148

	 * @return the before mentioned number

   149

	 */

   150

	Money FeederShare() const;

   151

   152

	/**

   153

	 * Returns source of the first cargo packet in this list

   154

	 * @return the before mentioned source

   155

	 */

   156

	StationID Source() const;

   157

   158

	/**

   159

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

   160

	 * @return the before mentioned number

   161

	 */

   162

	uint DaysInTransit() const;

   163

   164

   165

	/**

   166

	 * Appends the given cargo packet

   167

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

   168

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

   169

	 * @param cp the cargo packet to add

   170

	 * @pre cp != NULL

   171

	 */

   172

	void Append(CargoPacket *cp);

   173

   174

	/**

   175

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

   176

	 * first count cargo entities and removes the rest.

   177

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

   178

	 */

   179

	void Truncate(uint count);

   180

   181

	/**

   182

	 * Moves the given amount of cargo to another list.

   183

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

   184

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

   185

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

   186

	 *  - MTA_OTHER:          just move without side effects

   187

	 * @param dest  the destination to move the cargo to

   188

	 * @param count the amount of cargo entities to move

   189

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

   190

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

   191

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

   192

	 *              - MTA_CARGO_LOAD     - station's tile index of load

   193

	 *              - MTA_OTHER          - unused

   194

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

   195

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

   196

	 */

   197

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

   198

   199

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

   200

	void InvalidateCache();

   201

};

   202

   203

#endif /* CARGOPACKET_H */