GSStationList_Cargo Class Reference

Creates a list of stations associated with cargo at a station. More...

Inheritance diagram for GSStationList_Cargo:

GSList GSStationList_CargoPlanned GSStationList_CargoWaiting GSStationList_CargoPlannedByFrom GSStationList_CargoPlannedByVia GSStationList_CargoPlannedFromByVia GSStationList_CargoPlannedViaByFrom GSStationList_CargoWaitingByFrom GSStationList_CargoWaitingByVia GSStationList_CargoWaitingFromByVia GSStationList_CargoWaitingViaByFrom

Public Types

enum  CargoSelector {
  CS_BY_FROM,
  CS_VIA_BY_FROM,
  CS_BY_VIA,
  CS_FROM_BY_VIA
}
 Criteria of selecting and grouping cargo at a station. More...
enum  CargoMode {
  CM_WAITING,
  CM_PLANNED
}
 Ways of associating cargo to stations. More...

Public Member Functions

 GSStationList_Cargo (GSStationList_Cargo::CargoMode mode, GSStationList_Cargo::CargoSelector selector, StationID station_id, CargoID cargo, StationID other_station)
 Creates a list of stations associated with cargo in the specified way, selected and grouped by the chosen criteria.

Detailed Description

Creates a list of stations associated with cargo at a station.

This is very generic. Use the subclasses for all practical purposes.


Member Enumeration Documentation

Criteria of selecting and grouping cargo at a station.

Enumerator:
CS_BY_FROM  Group by origin station.
CS_VIA_BY_FROM  Select by next hop and group by origin station.
CS_BY_VIA  Group by next hop.
CS_FROM_BY_VIA  Select by origin station and group by next hop.

Ways of associating cargo to stations.

Enumerator:
CM_WAITING  Waiting cargo.
CM_PLANNED  Planned cargo.


Constructor & Destructor Documentation

GSStationList_Cargo::GSStationList_Cargo ( GSStationList_Cargo::CargoMode  mode,
GSStationList_Cargo::CargoSelector  selector,
StationID  station_id,
CargoID  cargo,
StationID  other_station 
)

Creates a list of stations associated with cargo in the specified way, selected and grouped by the chosen criteria.

Parameters:
mode Mode of association, either waiting cargo or planned cargo.
selector Mode of grouping and selecting to be applied.
station_id Station to be queried.
cargo Cargo type to query for.
other_station Other station to restrict the query with.


Generated on Sun Dec 24 12:50:17 2017 for OpenTTD Game API by  doxygen 1.5.6