Elevator Saga
User Guide
Data Models
Client Architecture and Proxy Models
HTTP Communication Architecture
Event-Driven Simulation and Tick-Based Execution
Logging System
API Reference
API Reference
Elevator Saga
Index
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
W
_
__init__() (elevator_saga.client.base_controller.ElevatorController method)
(Logger method)
__setattr__() (elevator_saga.client.proxy_models.ProxyElevator method)
(elevator_saga.client.proxy_models.ProxyFloor method)
(elevator_saga.client.proxy_models.ProxyPassenger method)
A
acknowledge_gui_read() (elevator_saga.server.simulator.ClientManager method)
add_entry() (elevator_saga.core.models.TrafficPattern method)
add_event() (elevator_saga.core.models.SimulationState method)
add_waiting_passenger() (elevator_saga.core.models.FloorState method)
after_request() (in module elevator_saga.server.simulator)
ALGORITHM (elevator_saga.server.simulator.ClientType attribute)
APIRequest (class in elevator_saga.core.models)
APIResponse (class in elevator_saga.core.models)
arrival_wait_time (elevator_saga.core.models.PassengerInfo property)
arrive_tick (elevator_saga.core.models.PassengerInfo attribute)
arrived (elevator_saga.core.models.PassengerInfo attribute)
average_arrival_wait_time (elevator_saga.core.models.PerformanceMetrics attribute)
average_floor_wait_time (elevator_saga.core.models.PerformanceMetrics attribute)
B
built-in function
debug()
error()
get_logger()
info()
set_log_level()
warning()
C
can_execute_command() (elevator_saga.server.simulator.ClientManager method)
CANCELLED (elevator_saga.core.models.PassengerStatus attribute)
clear_destinations() (elevator_saga.core.models.ElevatorState method)
client_id (elevator_saga.server.simulator.ClientInfo attribute)
client_type (elevator_saga.server.simulator.ClientInfo attribute)
ClientInfo (class in elevator_saga.server.simulator)
ClientManager (class in elevator_saga.server.simulator)
ClientType (class in elevator_saga.server.simulator)
command_type (elevator_saga.core.models.ElevatorCommand attribute)
(elevator_saga.core.models.GoToFloorCommand attribute)
COMPLETED (elevator_saga.core.models.PassengerStatus attribute)
completed (elevator_saga.server.simulator.PassengerSummary attribute)
completed_passengers (elevator_saga.core.models.PerformanceMetrics attribute)
completion_rate (elevator_saga.core.models.PerformanceMetrics property)
CONSTANT_SPEED (elevator_saga.core.models.ElevatorStatus attribute)
create_empty_simulation_state() (in module elevator_saga.core.models)
create_simple_traffic_pattern() (in module elevator_saga.core.models)
current_floor (elevator_saga.core.models.ElevatorState property)
(elevator_saga.core.models.Position attribute)
current_floor_float (elevator_saga.core.models.ElevatorState property)
(elevator_saga.core.models.Position property)
CustomJSONEncoder (class in elevator_saga.server.simulator)
D
data (elevator_saga.core.models.SimulationEvent attribute)
DEBUG (LogLevel attribute)
debug()
built-in function
debug() (Logger method)
default() (elevator_saga.server.simulator.CustomJSONEncoder method)
description (elevator_saga.core.models.TrafficPattern attribute)
destination (elevator_saga.core.models.PassengerInfo attribute)
(elevator_saga.core.models.TrafficEntry attribute)
Direction (class in elevator_saga.core.models)
DOWN (elevator_saga.core.models.Direction attribute)
down (elevator_saga.core.models.ElevatorIndicators attribute)
DOWN_BUTTON_PRESSED (elevator_saga.core.models.EventType attribute)
down_queue (elevator_saga.core.models.FloorState attribute)
dropoff_tick (elevator_saga.core.models.PassengerInfo attribute)
duration (elevator_saga.core.models.TrafficPattern property)
E
ELEVATOR_APPROACHING (elevator_saga.core.models.EventType attribute)
elevator_go_to_floor() (elevator_saga.server.simulator.ElevatorSimulation method)
(in module elevator_saga.server.simulator)
elevator_id (elevator_saga.core.models.ElevatorCommand attribute)
(elevator_saga.core.models.ElevatorCommandResponse attribute)
(elevator_saga.core.models.GoToFloorCommand attribute)
(elevator_saga.core.models.PassengerInfo attribute)
ELEVATOR_MOVE (elevator_saga.core.models.EventType attribute)
elevator_saga.client.api_client
module
elevator_saga.client.base_controller
module
elevator_saga.client.proxy_models
module
elevator_saga.core.models
module
elevator_saga.server.simulator
module
ElevatorAPIClient (class in elevator_saga.client.api_client)
ElevatorCommand (class in elevator_saga.core.models)
ElevatorCommandResponse (class in elevator_saga.core.models)
ElevatorController (class in elevator_saga.client.base_controller)
ElevatorIndicators (class in elevator_saga.core.models)
elevators (elevator_saga.core.models.SimulationState attribute)
(elevator_saga.server.simulator.ElevatorSimulation property)
(elevator_saga.server.simulator.SimulationStateResponse attribute)
ElevatorSimulation (class in elevator_saga.server.simulator)
ElevatorState (class in elevator_saga.core.models)
ElevatorStatus (class in elevator_saga.core.models)
energy_consumed (elevator_saga.core.models.ElevatorState attribute)
energy_rate (elevator_saga.core.models.ElevatorState attribute)
entries (elevator_saga.core.models.TrafficPattern attribute)
ERROR (LogLevel attribute)
error()
built-in function
error() (Logger method)
error_message (elevator_saga.core.models.APIResponse attribute)
(elevator_saga.core.models.StepResponse attribute)
events (elevator_saga.core.models.SimulationState attribute)
(elevator_saga.core.models.StepResponse attribute)
EventType (class in elevator_saga.core.models)
F
floor (elevator_saga.core.models.FloorState attribute)
(elevator_saga.core.models.GoToFloorCommand attribute)
floor_up_position (elevator_saga.core.models.Position attribute)
floor_up_position_add() (elevator_saga.core.models.Position method)
floor_wait_time (elevator_saga.core.models.PassengerInfo property)
floors (elevator_saga.core.models.SimulationState attribute)
(elevator_saga.server.simulator.ElevatorSimulation property)
(elevator_saga.server.simulator.SimulationStateResponse attribute)
FloorState (class in elevator_saga.core.models)
force_complete_remaining_passengers() (elevator_saga.server.simulator.ElevatorSimulation method)
from_dict() (elevator_saga.core.models.SerializableModel class method)
from_json() (elevator_saga.core.models.SerializableModel class method)
from_string() (LogLevel class method)
G
get_client_id_from_request() (in module elevator_saga.server.simulator)
get_client_info() (elevator_saga.server.simulator.ClientManager method)
get_client_type_from_request() (in module elevator_saga.server.simulator)
get_elevator_by_id() (elevator_saga.core.models.SimulationState method)
get_entries_for_tick() (elevator_saga.core.models.TrafficPattern method)
get_events() (elevator_saga.server.simulator.ElevatorSimulation method)
get_floor_by_number() (elevator_saga.core.models.SimulationState method)
get_logger()
built-in function
get_passengers_by_status() (elevator_saga.core.models.SimulationState method)
get_state() (elevator_saga.client.api_client.ElevatorAPIClient method)
(elevator_saga.server.simulator.ElevatorSimulation method)
(in module elevator_saga.server.simulator)
get_tick_events() (elevator_saga.server.simulator.ClientManager method)
get_traffic_info() (elevator_saga.client.api_client.ElevatorAPIClient method)
(elevator_saga.server.simulator.ElevatorSimulation method)
(in module elevator_saga.server.simulator)
go_to_floor() (elevator_saga.client.api_client.ElevatorAPIClient method)
(elevator_saga.client.proxy_models.ProxyElevator method)
GoToFloorCommand (class in elevator_saga.core.models)
GUI (elevator_saga.server.simulator.ClientType attribute)
H
has_waiting_passengers (elevator_saga.core.models.FloorState property)
I
id (elevator_saga.core.models.ElevatorState attribute)
(elevator_saga.core.models.PassengerInfo attribute)
(elevator_saga.core.models.TrafficEntry attribute)
IDLE (elevator_saga.core.models.EventType attribute)
immediate (elevator_saga.core.models.GoToFloorCommand attribute)
IN_ELEVATOR (elevator_saga.core.models.PassengerStatus attribute)
in_transit (elevator_saga.server.simulator.PassengerSummary attribute)
include_events (elevator_saga.core.models.StateRequest attribute)
include_passengers (elevator_saga.core.models.StateRequest attribute)
indicators (elevator_saga.core.models.ElevatorState attribute)
INFO (LogLevel attribute)
info()
built-in function
info() (Logger method)
is_algorithm_client() (elevator_saga.server.simulator.ClientManager method)
is_full (elevator_saga.core.models.ElevatorState property)
is_idle (elevator_saga.core.models.ElevatorState property)
is_running (elevator_saga.core.models.ElevatorState property)
J
json_response() (in module elevator_saga.server.simulator)
L
last_tick_direction (elevator_saga.core.models.ElevatorState attribute)
last_update_tick (elevator_saga.core.models.ElevatorState attribute)
load_current_traffic() (elevator_saga.server.simulator.ElevatorSimulation method)
load_factor (elevator_saga.core.models.ElevatorState property)
load_traffic() (elevator_saga.server.simulator.ElevatorSimulation method)
Logger (built-in class)
LogLevel (built-in class)
M
main() (in module elevator_saga.server.simulator)
mark_tick_processed() (elevator_saga.client.api_client.ElevatorAPIClient method)
max_capacity (elevator_saga.core.models.ElevatorState attribute)
max_duration_ticks (elevator_saga.server.simulator.ElevatorSimulation attribute)
metadata (elevator_saga.core.models.TrafficPattern attribute)
metrics (elevator_saga.core.models.SimulationState attribute)
(elevator_saga.server.simulator.SimulationStateResponse attribute)
module
elevator_saga.client.api_client
elevator_saga.client.base_controller
elevator_saga.client.proxy_models
elevator_saga.core.models
elevator_saga.server.simulator
N
name (elevator_saga.core.models.TrafficPattern attribute)
next_passenger_id (elevator_saga.server.simulator.ElevatorSimulation attribute)
next_target_floor (elevator_saga.core.models.ElevatorState attribute)
next_traffic_round() (elevator_saga.client.api_client.ElevatorAPIClient method)
(elevator_saga.server.simulator.ElevatorSimulation method)
(in module elevator_saga.server.simulator)
O
on_elevator_approaching() (elevator_saga.client.base_controller.ElevatorController method)
on_elevator_idle() (elevator_saga.client.base_controller.ElevatorController method)
on_elevator_move() (elevator_saga.client.base_controller.ElevatorController method)
on_elevator_passing_floor() (elevator_saga.client.base_controller.ElevatorController method)
on_elevator_stopped() (elevator_saga.client.base_controller.ElevatorController method)
on_event_execute_end() (elevator_saga.client.base_controller.ElevatorController method)
on_event_execute_start() (elevator_saga.client.base_controller.ElevatorController method)
on_init() (elevator_saga.client.base_controller.ElevatorController method)
on_passenger_alight() (elevator_saga.client.base_controller.ElevatorController method)
on_passenger_board() (elevator_saga.client.base_controller.ElevatorController method)
on_passenger_call() (elevator_saga.client.base_controller.ElevatorController method)
on_simulation_complete() (elevator_saga.client.base_controller.ElevatorController method)
on_start() (elevator_saga.client.base_controller.ElevatorController method)
on_stop() (elevator_saga.client.base_controller.ElevatorController method)
origin (elevator_saga.core.models.PassengerInfo attribute)
(elevator_saga.core.models.TrafficEntry attribute)
P
p95_arrival_wait_time (elevator_saga.core.models.PerformanceMetrics attribute)
p95_floor_wait_time (elevator_saga.core.models.PerformanceMetrics attribute)
parameters (elevator_saga.core.models.ElevatorCommand attribute)
(elevator_saga.core.models.GoToFloorCommand property)
PASSENGER_ALIGHT (elevator_saga.core.models.EventType attribute)
PASSENGER_BOARD (elevator_saga.core.models.EventType attribute)
passenger_destinations (elevator_saga.core.models.ElevatorState attribute)
PassengerInfo (class in elevator_saga.core.models)
passengers (elevator_saga.core.models.ElevatorState attribute)
(elevator_saga.core.models.SimulationState attribute)
(elevator_saga.server.simulator.ElevatorSimulation property)
(elevator_saga.server.simulator.SimulationStateResponse attribute)
PassengerStatus (class in elevator_saga.core.models)
PassengerSummary (class in elevator_saga.server.simulator)
PASSING_FLOOR (elevator_saga.core.models.EventType attribute)
PerformanceMetrics (class in elevator_saga.core.models)
pickup_tick (elevator_saga.core.models.PassengerInfo attribute)
Position (class in elevator_saga.core.models)
position (elevator_saga.core.models.ElevatorState attribute)
pressed_floors (elevator_saga.core.models.ElevatorState property)
ProxyElevator (class in elevator_saga.client.proxy_models)
ProxyFloor (class in elevator_saga.client.proxy_models)
ProxyPassenger (class in elevator_saga.client.proxy_models)
R
register_client() (elevator_saga.server.simulator.ClientManager method)
(in module elevator_saga.server.simulator)
registered_tick (elevator_saga.server.simulator.ClientInfo attribute)
remove_waiting_passenger() (elevator_saga.core.models.FloorState method)
request_id (elevator_saga.core.models.APIRequest attribute)
(elevator_saga.core.models.APIResponse attribute)
(elevator_saga.core.models.ElevatorCommand attribute)
(elevator_saga.core.models.GoToFloorCommand attribute)
(elevator_saga.core.models.StepResponse attribute)
reset() (elevator_saga.client.api_client.ElevatorAPIClient method)
(elevator_saga.server.simulator.ClientManager method)
(elevator_saga.server.simulator.ElevatorSimulation method)
reset_simulation() (in module elevator_saga.server.simulator)
run_status (elevator_saga.core.models.ElevatorState attribute)
S
save_current_traffic_result() (elevator_saga.server.simulator.ElevatorSimulation method)
save_final_results() (elevator_saga.server.simulator.ElevatorSimulation method)
send_elevator_command() (elevator_saga.client.api_client.ElevatorAPIClient method)
SerializableModel (class in elevator_saga.core.models)
set_direction() (elevator_saga.core.models.ElevatorIndicators method)
set_level() (Logger method)
set_log_level()
built-in function
SimulationEvent (class in elevator_saga.core.models)
SimulationState (class in elevator_saga.core.models)
SimulationStateResponse (class in elevator_saga.server.simulator)
since_tick (elevator_saga.core.models.StateRequest attribute)
speed_pre_tick (elevator_saga.core.models.ElevatorState attribute)
start() (elevator_saga.client.base_controller.ElevatorController method)
START_DOWN (elevator_saga.core.models.ElevatorStatus attribute)
START_UP (elevator_saga.core.models.ElevatorStatus attribute)
StateRequest (class in elevator_saga.core.models)
status (elevator_saga.core.models.PassengerInfo property)
step() (elevator_saga.client.api_client.ElevatorAPIClient method)
(elevator_saga.server.simulator.ElevatorSimulation method)
step_simulation() (in module elevator_saga.server.simulator)
StepRequest (class in elevator_saga.core.models)
StepResponse (class in elevator_saga.core.models)
stop() (elevator_saga.client.base_controller.ElevatorController method)
STOPPED (elevator_saga.core.models.Direction attribute)
(elevator_saga.core.models.ElevatorStatus attribute)
STOPPED_AT_FLOOR (elevator_saga.core.models.EventType attribute)
store_tick_events() (elevator_saga.server.simulator.ClientManager method)
success (elevator_saga.core.models.APIResponse attribute)
(elevator_saga.core.models.ElevatorCommandResponse attribute)
(elevator_saga.core.models.StepResponse attribute)
T
target_floor (elevator_saga.core.models.ElevatorState property)
(elevator_saga.core.models.Position attribute)
target_floor_direction (elevator_saga.core.models.ElevatorState property)
tick (elevator_saga.core.models.SimulationEvent attribute)
(elevator_saga.core.models.SimulationState attribute)
(elevator_saga.core.models.StepResponse attribute)
(elevator_saga.core.models.TrafficEntry attribute)
(elevator_saga.server.simulator.ElevatorSimulation property)
(elevator_saga.server.simulator.SimulationStateResponse attribute)
ticks (elevator_saga.core.models.StepRequest attribute)
timestamp (elevator_saga.core.models.APIRequest attribute)
(elevator_saga.core.models.APIResponse attribute)
(elevator_saga.core.models.ElevatorCommand attribute)
(elevator_saga.core.models.GoToFloorCommand attribute)
(elevator_saga.core.models.SimulationEvent attribute)
(elevator_saga.core.models.StepResponse attribute)
to_dict() (elevator_saga.core.models.SerializableModel method)
to_json() (elevator_saga.core.models.SerializableModel method)
total (elevator_saga.server.simulator.PassengerSummary attribute)
total_energy_consumption (elevator_saga.core.models.PerformanceMetrics attribute)
total_passengers (elevator_saga.core.models.PerformanceMetrics attribute)
(elevator_saga.core.models.TrafficPattern property)
total_waiting (elevator_saga.core.models.FloorState property)
traffic_queue (elevator_saga.server.simulator.ElevatorSimulation attribute)
TrafficEntry (class in elevator_saga.core.models)
TrafficPattern (class in elevator_saga.core.models)
travel_direction (elevator_saga.core.models.PassengerInfo property)
type (elevator_saga.core.models.SimulationEvent attribute)
U
UNKNOWN (elevator_saga.server.simulator.ClientType attribute)
UP (elevator_saga.core.models.Direction attribute)
up (elevator_saga.core.models.ElevatorIndicators attribute)
UP_BUTTON_PRESSED (elevator_saga.core.models.EventType attribute)
up_queue (elevator_saga.core.models.FloorState attribute)
W
wait_for_algorithm_step() (elevator_saga.server.simulator.ClientManager method)
wait_for_gui_acknowledgment() (elevator_saga.server.simulator.ClientManager method)
WAITING (elevator_saga.core.models.PassengerStatus attribute)
waiting (elevator_saga.server.simulator.PassengerSummary attribute)
WARNING (LogLevel attribute)
warning()
built-in function
warning() (Logger method)