Traveller Functionality

[sync-by-unito[bot]]

This class is used to represent any entity travelling from a start building to a destination. It has been built in a flexible manner, so that it can represent different vehicles (cars, bikes, bus, truck, etc… ), and walkers. It

‌

Private attributes:

• DeltaD - this is the velocity of the traveller with respect to the currentEdge. Used to calculate how far along the current edge the traveller should move.
• PositionOnEdge - this is the proportion of the edge the traveller has gone down. Used to show the position of the traveller on the UI.
• RateOfEmission - metric used to track pollution.
• CurrentPath - pointer to path, represents the route the traveller is taking to reach their destination.
• PreviousPaths - list of pointers to paths.

Public attributes:

• CurrentEdge - pointer to edge the traveller is on.
• CurrentVelocity - the velocity the traveller is simulated to be going at (km/h).
• MaxVelocity - the maximum velocity the traveller can be simulated to be at (km/h).
• NoOfPassengers - the number of people travelling. Useful to represent groups of people, buses, cars…
• ModeOfTransport - This value will be an enum, where different types of traveller will be classified differently. e.g. {0: [walker, bicycle], 1: [car, van], 2: [truck, bus]}. ( https://trello.com/c/Re9GyDZR )

‌

Functionality:

• Getters / Setters - appropriate getters and setters should be produced
• destination - returns the destination of the traveller
• start - returns the origin of the travellers journey
• calculateDeltaD - This function converts the actual velocity of the traveller (currentVelocity) to deltaD.
• onUpdate() - call the Move() function
• move - This function moves the traveller. It uses deltaD to calculate the new position the traveller should appear along the edge, with the travellers sprite being moved in the UI accordingly. In the case that the traveller cannot move forward due to congestion, it will move whatever it can, and after the tick completes its postion in the edge queue will update. This should happen organically due to the order of execution of events (travellers should only move once travellers ahead of them in an edge queue have moved), the traveller should subscribe (using said function) to that edge, attributes being updated where necessary (and leave current edge, using the unsubscribe function). In the case that the travellers has reached the end of the street, the next edge must be selected from the path. This is an oppurtunity to represent human decisions by letting the traveller “decide” to traverse a different edge is the one they intend on joining is too busy. This approach would require the route to be recalculated. In the case the traveller has reached their destination, relevant attributes must be updated, and the vehicle must be added to the terminal building vehicle pool, and its occupancy updated. Finally, the position of the underlying object must be moved to its new, calculated value. (latex is: $pos = A_d+B_(1-d).)
• calculateEmissions - calculate the total distance the traveller moved, and calculate the total emissions using the rateOfEmission attribute.
• subscribe - set currentEdge to the next edge on the path of the traveller, activated when the traveller is about to change edge.

‌

Specified by: Ted Proctor

Implemented by: Scott DeVerinne

Validated by:

┆Issue is synchronized with this Trello card by Unito ┆Attachments: Edge.cs:

[sync-by-unito[bot]]

➤ Zdenek Plesek commented:

The following is a list of issues as observed on 08/12/2023 \@ 00:02 on the buildings-edges-travellers-merge branch

Validation Errors in [Traveller.cs]

• missing Move() function
  • calculateDeltaD was removed
  • maybe accidentally placed into EdgeFuncionality.cs?

[sync-by-unito[bot]]

➤ Scott DeVerinne commented:

zp235 Confusion on where its placement should be, as it is labelled ‘Edge Functionality Extension’ on its Trello card