HapiProduct

data class HapiProduct(name: String?, internalName: String?, addName: String?, displayNumber: String?, num: String?, line: String?, lineId: String?, catOut: String?, catIn: String?, catCode: String?, cls: Int?, catOutS: String?, catOutL: String?, operatorCode: String?, operator: String?, admin: String?, routeIdxFrom: Int?, routeIdxTo: Int?, matchId: String?, icon: HapiIcon?, status: HapiProduct.Status?)

Product context, provides access to internal data. For the product category attributes, their assignments are defined in the "zugart" file from the raw Hafas plan data.

Constructors

HapiProduct

fun HapiProduct(name: String?, internalName: String?, addName: String?, displayNumber: String?, num: String?, line: String?, lineId: String?, catOut: String?, catIn: String?, catCode: String?, cls: Int?, catOutS: String?, catOutL: String?, operatorCode: String?, operator: String?, admin: String?, routeIdxFrom: Int?, routeIdxTo: Int?, matchId: String?, icon: HapiIcon?, status: HapiProduct.Status?)

Types

Status

data class Status(code: Int?, txt: String?, icon: HapiIcon?, rtIcon: HapiIcon?)

Properties

addName

val addName: String?

Additional product name. This is customer specific.

admin

val admin: String?

The administration name.

catCode

val catCode: String?

Product category code.

catIn

val catIn: String?

Internal product category name.

catOut

val catOut: String?

Product category name as used for display in standard form.

catOutL

val catOutL: String?

Product category name for display in long form.

catOutS

val catOutS: String?

Product category name for display in short form.

cls

val cls: Int?

Product category in decimal form.

displayNumber

val displayNumber: String?

Number for display

icon

val icon: HapiIcon?

internalName

val internalName: String?

Internal product name. Not used for display. Used e.g. in reconstruction services.

line

val line: String?

Line name if available (e.g. "R10")

lineId

val lineId: String?

External line id for use in further requests

matchId

val matchId: String?

The match ID.

name

val name: String?

Product name for display. The name might be composed from product number, line and/or category. This is customer specific.

num

val num: String?

Internal product number (e.g. train number)

operator

val operator: String?

The operator name.

operatorCode

val operatorCode: String?

The operator code.

routeIdxFrom

val routeIdxFrom: Int?

Defines the first stop/station where this name is valid. See the Stops list for details of the stop/station.

routeIdxTo

val routeIdxTo: Int?

Defines the last stop/station where this name is valid. See the Stops list for details of the stop/station.

status

val status: HapiProduct.Status?