OpenTTD Source: CargoArray Struct Reference

OpenTTD Source 12.2

Public Member Functions | Private Attributes
CargoArray Struct Reference

Class for storing amounts of cargo. More...

`#include <cargo_type.h>`

## Public Member Functions
| CargoArray ()
| Default constructor.
void | Clear ()
| Reset all entries.
uint & | operator[] (CargoID cargo)
| Read/write access to an amount of a specific cargo type. More...
const uint & | operator[] (CargoID cargo) const
| Read-only access to an amount of a specific cargo type. More...
template<typename T >
const T | GetSum () const
| Get the sum of all cargo amounts. More...
byte | GetCount () const
| Get the amount of cargos that have an amount. More...

## Private Attributes
uint | amount [NUM_CARGO]
| Amount of each type of cargo.

## Detailed Description

Class for storing amounts of cargo.

Definition at line 82 of file cargo_type.h.

## Member Function Documentation

## ◆ GetCount()

byte CargoArray::GetCount | ( |  | ) | const
| inline

Get the amount of cargos that have an amount.

Returns
  The amount.

Definition at line 135 of file cargo_type.h.

References lengthof.

## ◆ GetSum()

template<typename T >

const T CargoArray::GetSum | ( |  | ) | const
| inline

Get the sum of all cargo amounts.

Returns
  The sum.

Definition at line 122 of file cargo_type.h.

Referenced by GetTotalCapacityOfArticulatedParts().

## ◆ operator[]() [1/2]

uint& CargoArray::operator[] | ( | CargoID | cargo | ) |
| inline

Read/write access to an amount of a specific cargo type.

Parameters

  cargo | Cargo type to access.

Definition at line 103 of file cargo_type.h.

## ◆ operator[]() [2/2]

const uint& CargoArray::operator[] | ( | CargoID | cargo | ) | const
| inline

Read-only access to an amount of a specific cargo type.

Parameters

  cargo | Cargo type to access.

Definition at line 112 of file cargo_type.h.

The documentation for this struct was generated from the following file:

- src/cargo_type.h