1

/* $Id$ */

     2

     3

/** @file group.h Base class from groups. */

     4

     5

#ifndef GROUP_H

     6

#define GROUP_H

     7

     8

#include "group_type.h"

     9

#include "oldpool.h"

    10

#include "player_type.h"

    11

#include "vehicle_type.h"

    12

#include "engine_type.h"

    13

    14

DECLARE_OLD_POOL(Group, Group, 5, 2047)

    15

    16

struct Group : PoolItem<Group, GroupID, &_Group_pool> {

    17

	char *name;                             ///< Group Name

    18

    19

	uint16 num_vehicle;                     ///< Number of vehicles wich belong to the group

    20

	PlayerByte owner;                       ///< Group Owner

    21

	VehicleTypeByte vehicle_type;           ///< Vehicle type of the group

    22

    23

	bool replace_protection;                ///< If set to true, the global autoreplace have no effect on the group

    24

	uint16 *num_engines;                    ///< Caches the number of engines of each type the player owns (no need to save this)

    25

    26

	Group(PlayerID owner = INVALID_PLAYER);

    27

	virtual ~Group();

    28

    29

	bool IsValid() const;

    30

};

    31

    32

    33

static inline bool IsValidGroupID(GroupID index)

    34

{

    35

	return index < GetGroupPoolSize() && GetGroup(index)->IsValid();

    36

}

    37

    38

static inline bool IsDefaultGroupID(GroupID index)

    39

{

    40

	return index == DEFAULT_GROUP;

    41

}

    42

    43

/**

    44

 * Checks if a GroupID stands for all vehicles of a player

    45

 * @param id_g The GroupID to check

    46

 * @return true is id_g is identical to ALL_GROUP

    47

 */

    48

static inline bool IsAllGroupID(GroupID id_g)

    49

{

    50

	return id_g == ALL_GROUP;

    51

}

    52

    53

#define FOR_ALL_GROUPS_FROM(g, start) for (g = GetGroup(start); g != NULL; g = (g->index + 1U < GetGroupPoolSize()) ? GetGroup(g->index + 1) : NULL) if (g->IsValid())

    54

#define FOR_ALL_GROUPS(g) FOR_ALL_GROUPS_FROM(g, 0)

    55

    56

/**

    57

 * Get the current size of the GroupPool

    58

 */

    59

static inline uint GetGroupArraySize(void)

    60

{

    61

	const Group *g;

    62

	uint num = 0;

    63

    64

	FOR_ALL_GROUPS(g) num++;

    65

    66

	return num;

    67

}

    68

    69

/**

    70

 * Get the number of engines with EngineID id_e in the group with GroupID

    71

 * id_g

    72

 * @param id_g The GroupID of the group used

    73

 * @param id_e The EngineID of the engine to count

    74

 * @return The number of engines with EngineID id_e in the group

    75

 */

    76

uint GetGroupNumEngines(PlayerID p, GroupID id_g, EngineID id_e);

    77

    78

static inline void IncreaseGroupNumVehicle(GroupID id_g)

    79

{

    80

	if (IsValidGroupID(id_g)) GetGroup(id_g)->num_vehicle++;

    81

}

    82

    83

static inline void DecreaseGroupNumVehicle(GroupID id_g)

    84

{

    85

	if (IsValidGroupID(id_g)) GetGroup(id_g)->num_vehicle--;

    86

}

    87

    88

    89

void InitializeGroup();

    90

void SetTrainGroupID(Vehicle *v, GroupID grp);

    91

void UpdateTrainGroupID(Vehicle *v);

    92

void RemoveVehicleFromGroup(const Vehicle *v);

    93

void RemoveAllGroupsForPlayer(const PlayerID p);

    94

    95

#endif /* GROUP_H */