darwin.md

Classes

Darwin

a service for connecting and communicating with the National Rail Darwin PushPort server

External

Schedule

Schedule data class

Association

Association data class

TrainOrder

TrainOrder data class

StationMessage

StationMessage data class

TrainStatus

TrainStatus data class

Darwin

a service for connecting and communicating with the National Rail Darwin PushPort server

Kind: global class

• Darwin
  • instance
    • "trainStatus"
    • "schedule"
    • "association"
    • "trainOrder"
    • "stationMessage"
  • inner
    • ~connect(queue)

"trainStatus"

Kind: event emitted by Darwin
Properties

Name	Type	Description
ts	string	a timestamp of when the event was issued
trainStatus	TrainStatus	a train status class
origin	string	where the event originated from

"schedule"

Kind: event emitted by Darwin
Properties

Name	Type	Description
id	string	an id for the event
ts	string	a timestamp of when the event was issued
schedule	Schedule	a schedule class
origin	string	where the event originated from
source	string	which source did the vent originate from

"association"

Kind: event emitted by Darwin
Properties

Name	Type	Description
id	string	an id for the event
ts	string	a timestamp of when the event was issued
association	Association	a association class
origin	string	where the event originated from
source	string	which source did the vent originate from

"trainOrder"

Kind: event emitted by Darwin
Properties

Name	Type	Description
id	string	an id for the event
ts	string	a timestamp of when the event was issued
trainOrder	TrainOrder	a TrainOrder class
origin	string	where the event originated from
source	string	which source did the vent originate from

"stationMessage"

Kind: event emitted by Darwin
Properties

Name	Type	Description
ts	string	a timestamp of when the event was issued
stationMessage	StationMessage	a StationMessage class
origin	string	where the event originated from

Darwin~connect(queue)

connects to the Darwin server and subscribes to a specified queue

Kind: inner method of Darwin
Emits: trainStatus, schedule, association, trainOrder, stationMessage

Param	Type	Description
queue	string	the queue to subscribe to

Schedule

Schedule data class

Kind: global external
See: Schedule

Association

Association data class

Kind: global external
See: Association

TrainOrder

TrainOrder data class

Kind: global external
See: TrainOrder

StationMessage

StationMessage data class

Kind: global external
See: StationMessage

TrainStatus

TrainStatus data class

Kind: global external
See: TrainStatus