starling_sim.basemodel.trace.events

This module contains event classes that compose agents’ traces

Module Contents

Classes

Event	This class represents the events contained in the trace
InputEvent	This event describes the generation of a traced element.
MoveEvent	This event describes an agent moving
RouteEvent	This event describes the route of an agent
PositionChangeEvent	This event describes a position change of an agent
WaitEvent	This event describes the a waiting agent
IdleEvent	This event describes an idle agent
ServiceEvent	This event describes a status change of an agent service.
RequestEvent	This event describes a user request
StopEvent	This event describes the processing of a Stop
StaffOperationEvent	This event describes a staff operation
GetVehicleEvent	This event describes an agent getting a vehicle
LeaveVehicleEvent	This event describes an agent returning a vehicle
LeaveSystemEvent	This event describes an agent leaving the simulation
DestinationReachedEvent	This event describes an agent reaching its destination
LeaveSimulationEvent	This event describes an agent leaving the simulation.

class starling_sim.basemodel.trace.events.Event(time, message='')

This class represents the events contained in the trace

It should be extended to describe the different kinds of events of the agents

__str__()

Gives a string display to the event

class starling_sim.basemodel.trace.events.InputEvent(time, element, message='')

Bases: Event

This event describes the generation of a traced element.

__str__()

Gives a string display to the event

class starling_sim.basemodel.trace.events.MoveEvent(time, move_distance, move_duration, mode, message='')

Bases: Event

This event describes an agent moving

class starling_sim.basemodel.trace.events.RouteEvent(time, route_data, mode, message='')

Bases: MoveEvent

This event describes the route of an agent

set_route_data(route_data)

__str__()

Gives a string display to the event

class starling_sim.basemodel.trace.events.PositionChangeEvent(time, origin, destination, distance, duration, mode, message='')

Bases: MoveEvent

This event describes a position change of an agent

__str__()

Gives a string display to the event

class starling_sim.basemodel.trace.events.WaitEvent(time, reason, waiting_time, message='')

Bases: Event

This event describes the a waiting agent

__str__()

Gives a string display to the event

class starling_sim.basemodel.trace.events.IdleEvent(time, idle_duration, message='')

Bases: Event

This event describes an idle agent

__str__()

Gives a string display to the event

class starling_sim.basemodel.trace.events.ServiceEvent(time, former_status, new_status, message='')

Bases: Event

This event describes a status change of an agent service.

__str__()

Gives a string display to the event

class starling_sim.basemodel.trace.events.RequestEvent(time, request, message='')

Bases: Event

This event describes a user request

__str__()

Gives a string display to the event

class starling_sim.basemodel.trace.events.StopEvent(time, operator, service_vehicle, trip, stop, message='')

Bases: Event

This event describes the processing of a Stop

set_dropoffs(dropoffs, dropoff_time)

set_pickups(pickups, pickup_time)

__str__()

Gives a string display to the event

class starling_sim.basemodel.trace.events.StaffOperationEvent(time, staff, total, goal, targets=None, structure=None, message='')

Bases: Event

This event describes a staff operation

__str__()

Gives a string display to the event

class starling_sim.basemodel.trace.events.GetVehicleEvent(time, agent, vehicle, message='')

Bases: Event

This event describes an agent getting a vehicle

__str__()

Gives a string display to the event

class starling_sim.basemodel.trace.events.LeaveVehicleEvent(time, agent, vehicle, message='')

Bases: Event

This event describes an agent returning a vehicle

__str__()

Gives a string display to the event

class starling_sim.basemodel.trace.events.LeaveSystemEvent(time, message='')

Bases: Event

This event describes an agent leaving the simulation

__str__()

Gives a string display to the event

class starling_sim.basemodel.trace.events.DestinationReachedEvent(time, message='')

Bases: Event

This event describes an agent reaching its destination

__str__()

Gives a string display to the event

class starling_sim.basemodel.trace.events.LeaveSimulationEvent(time, agent, cause, message='')

Bases: Event

This event describes an agent leaving the simulation.

__str__()

Gives a string display to the event