From 61ce180e0cd88c0eccc5c5e1051b02d0e1e9294b Mon Sep 17 00:00:00 2001 From: ll7 Date: Mon, 25 Mar 2024 19:26:45 +0100 Subject: [PATCH] Refactor pyreverse.md to use code block for command --- docs/pyreverse.md | 4 +- robot_sf/classes.svg | 150 +++++++--------- robot_sf/packages.svg | 408 +++++++++++++++++++++++++----------------- 3 files changed, 309 insertions(+), 253 deletions(-) diff --git a/docs/pyreverse.md b/docs/pyreverse.md index 437b6fb..1cc4d91 100644 --- a/docs/pyreverse.md +++ b/docs/pyreverse.md @@ -1,3 +1,5 @@ # pyreverse -`pyreverse -o svg --colorized .` \ No newline at end of file +```shell +pyreverse -o svg --colorized . +``` \ No newline at end of file diff --git a/robot_sf/classes.svg b/robot_sf/classes.svg index 2cf75cc..56f5288 100644 --- a/robot_sf/classes.svg +++ b/robot_sf/classes.svg @@ -4,11 +4,11 @@ - + classes - + robot_sf.robot.bicycle_drive.BicycleDriveRobot @@ -328,9 +328,9 @@ respawn_group_at_start(gid: int) step() - + -robot_sf.nav.map_config.GlobalRoute +robot_sf.nav.gloabal_route.GlobalRoute GlobalRoute @@ -385,7 +385,7 @@ find_route(spawn_id: int, goal_id: int): Union[GlobalRoute, None] - + robot_sf.sim.simulator.Simulator Simulator @@ -422,14 +422,14 @@ MapDefinitionPool -map_defs : List[MapDefinition] -maps_folder : str +map_defs : Dict[str, MapDefinition] +maps_folder : str choose_random_map(): MapDefinition - + -robot_sf.nav.map_config.Obstacle +robot_sf.nav.obstacle.Obstacle Obstacle @@ -473,7 +473,7 @@ config - + robot_sf.sim.sim_config.SimulationSettings SimulationSettings @@ -663,24 +663,6 @@ sensors - - -robot_sf.simple_robot_env.SimpleRobotEnv - -SimpleRobotEnv - -action_space : Discrete -info : dict -observation_space : Discrete - -close -() -render -(mode) -reset(seed) -step -(action) - robot_sf.sim.sim_config.SimulationSettings->robot_sf.sim.simulator.Simulator @@ -689,35 +671,35 @@ config - + robot_sf.sim.sim_view.SimulationView - -SimulationView - -font : Font -goal_radius : float -height : float -is_abortion_requested : bool -is_exit_requested : bool -obstacles : List[Obstacle] -ped_radius : float -robot_radius : float -scaling : float -screen -size_changed : bool -surface_obstacles -timestep_text_pos -ui_events_thread : Thread -width : float - -clear() -exit() -preprocess_obstacles(): pygame.Surface -render(state: VisualizableSimState) -show() + +SimulationView + +font : Font +goal_radius : float +height : float +is_abortion_requested : bool +is_exit_requested : bool +obstacles : List[Obstacle] +ped_radius : float +robot_radius : float +scaling : float +screen +size_changed : bool +surface_obstacles +timestep_text_pos +ui_events_thread : Thread +width : float + +clear() +exit() +preprocess_obstacles(): pygame.Surface +render(state: VisualizableSimState) +show() - + robot_sf.eval.VecEnvMetrics VecEnvMetrics @@ -739,42 +721,42 @@ metrics - + robot_sf.sim.sim_view.VisualizableAction - -VisualizableAction - -robot_action : Union[DifferentialDriveAction, BicycleAction] -robot_goal : Tuple -robot_pose : Tuple - - + +VisualizableAction + +robot_action : Union[DifferentialDriveAction, BicycleAction] +robot_goal : Tuple +robot_pose : Tuple + + - + robot_sf.sim.sim_view.VisualizableSimState - -VisualizableSimState - -action : Union[VisualizableAction, None] -ped_actions : ndarray -pedestrian_positions : ndarray -ray_vecs : ndarray -robot_pose : Tuple -timestep : int - - + +VisualizableSimState + +action : Union[VisualizableAction, None] +ped_actions : ndarray +pedestrian_positions : ndarray +ray_vecs : ndarray +robot_pose : Tuple +timestep : int + + - + robot_sf.ped_npc.ped_population.ZonePointsGenerator - -ZonePointsGenerator - -zone_areas : List[float] -zones : List[Zone] - -generate(num_samples: int): Tuple[List[Vec2D], int] + +ZonePointsGenerator + +zone_areas : List[float] +zones : List[Zone] + +generate(num_samples: int): Tuple[List[Vec2D], int] diff --git a/robot_sf/packages.svg b/robot_sf/packages.svg index de66af5..f2182ce 100644 --- a/robot_sf/packages.svg +++ b/robot_sf/packages.svg @@ -4,334 +4,406 @@ - - + + packages - + robot_sf - -robot_sf + +robot_sf robot_sf.eval - -robot_sf.eval + +robot_sf.eval robot_sf.feature_extractor - -robot_sf.feature_extractor + +robot_sf.feature_extractor + + + +robot_sf.sensor.sensor_fusion + +robot_sf.sensor.sensor_fusion + + + +robot_sf.feature_extractor->robot_sf.sensor.sensor_fusion + + robot_sf.nav - -robot_sf.nav + +robot_sf.nav - + +robot_sf.nav.gloabal_route + +robot_sf.nav.gloabal_route + + + +robot_sf.nav.nav_types + +robot_sf.nav.nav_types + + + +robot_sf.nav.gloabal_route->robot_sf.nav.nav_types + + + + + robot_sf.nav.map_config - -robot_sf.nav.map_config + +robot_sf.nav.map_config + + + +robot_sf.nav.map_config->robot_sf.nav.gloabal_route + + + + + +robot_sf.nav.map_config->robot_sf.nav.nav_types + + + + + +robot_sf.nav.obstacle + +robot_sf.nav.obstacle + + + +robot_sf.nav.map_config->robot_sf.nav.obstacle + + - + robot_sf.nav.navigation - -robot_sf.nav.navigation + +robot_sf.nav.navigation - + robot_sf.nav.navigation->robot_sf.nav.map_config - - + + + + + +robot_sf.nav.navigation->robot_sf.nav.nav_types + + - + robot_sf.ped_npc.ped_zone - -robot_sf.ped_npc.ped_zone + +robot_sf.ped_npc.ped_zone - + robot_sf.nav.navigation->robot_sf.ped_npc.ped_zone - - + + + + + +robot_sf.nav.obstacle->robot_sf.nav.nav_types + + - + robot_sf.nav.occupancy - -robot_sf.nav.occupancy + +robot_sf.nav.occupancy - + robot_sf.ped_npc - -robot_sf.ped_npc + +robot_sf.ped_npc - + robot_sf.ped_npc.ped_behavior - -robot_sf.ped_npc.ped_behavior + +robot_sf.ped_npc.ped_behavior - + robot_sf.ped_npc.ped_behavior->robot_sf.nav.map_config - - + + + + + +robot_sf.ped_npc.ped_behavior->robot_sf.nav.nav_types + + - + robot_sf.ped_npc.ped_behavior->robot_sf.nav.navigation - - + + - + robot_sf.ped_npc.ped_grouping - -robot_sf.ped_npc.ped_grouping + +robot_sf.ped_npc.ped_grouping - + robot_sf.ped_npc.ped_behavior->robot_sf.ped_npc.ped_grouping - - + + - + robot_sf.ped_npc.ped_behavior->robot_sf.ped_npc.ped_zone - - + + - + robot_sf.ped_npc.ped_population - -robot_sf.ped_npc.ped_population + +robot_sf.ped_npc.ped_population - + robot_sf.ped_npc.ped_population->robot_sf.nav.map_config - - + + + + + +robot_sf.ped_npc.ped_population->robot_sf.nav.nav_types + + - + robot_sf.ped_npc.ped_population->robot_sf.ped_npc.ped_behavior - - + + - + robot_sf.ped_npc.ped_population->robot_sf.ped_npc.ped_grouping - - + + - + robot_sf.ped_npc.ped_population->robot_sf.ped_npc.ped_zone - - + + - + robot_sf.ped_npc.ped_robot_force - -robot_sf.ped_npc.ped_robot_force + +robot_sf.ped_npc.ped_robot_force + + + +robot_sf.ped_npc.ped_zone->robot_sf.nav.nav_types + + - + robot_sf.robot - -robot_sf.robot + +robot_sf.robot - + robot_sf.robot.bicycle_drive - -robot_sf.robot.bicycle_drive + +robot_sf.robot.bicycle_drive - + robot_sf.robot.differential_drive - -robot_sf.robot.differential_drive + +robot_sf.robot.differential_drive - + robot_sf.robot.robot_state - -robot_sf.robot.robot_state + +robot_sf.robot.robot_state - + robot_sf.robot.robot_state->robot_sf.nav.navigation - - + + - + robot_sf.robot.robot_state->robot_sf.nav.occupancy - - - - - -robot_sf.sensor.sensor_fusion - -robot_sf.sensor.sensor_fusion + + - + robot_sf.robot.robot_state->robot_sf.sensor.sensor_fusion - - + + - + robot_sf.sensor - -robot_sf.sensor + +robot_sf.sensor - + robot_sf.sensor.goal_sensor - -robot_sf.sensor.goal_sensor + +robot_sf.sensor.goal_sensor - + robot_sf.sensor.range_sensor - -robot_sf.sensor.range_sensor + +robot_sf.sensor.range_sensor - + robot_sf.sensor.range_sensor->robot_sf.nav.occupancy - - + + - + robot_sf.sim - -robot_sf.sim + +robot_sf.sim - + robot_sf.sim.sim_config - -robot_sf.sim.sim_config + +robot_sf.sim.sim_config - + robot_sf.sim.sim_config->robot_sf.ped_npc.ped_robot_force - - + + - + robot_sf.sim.sim_view - -robot_sf.sim.sim_view + +robot_sf.sim.sim_view - + robot_sf.sim.sim_view->robot_sf.nav.map_config - - + + - + robot_sf.sim.sim_view->robot_sf.robot.bicycle_drive - - + + - + robot_sf.sim.sim_view->robot_sf.robot.differential_drive - - + + - + robot_sf.sim.simulator - -robot_sf.sim.simulator + +robot_sf.sim.simulator - + robot_sf.sim.simulator->robot_sf.nav.map_config - - + + - + robot_sf.sim.simulator->robot_sf.nav.navigation - - + + - + robot_sf.sim.simulator->robot_sf.ped_npc.ped_behavior - - + + - + robot_sf.sim.simulator->robot_sf.ped_npc.ped_grouping - - + + - + robot_sf.sim.simulator->robot_sf.ped_npc.ped_population - - + + - + robot_sf.sim.simulator->robot_sf.ped_npc.ped_robot_force - - + + - + robot_sf.sim.simulator->robot_sf.robot.bicycle_drive - - + + - + robot_sf.sim.simulator->robot_sf.robot.differential_drive - - - - - -robot_sf.simple_robot_env - -robot_sf.simple_robot_env + + - + robot_sf.tb_logging - -robot_sf.tb_logging + +robot_sf.tb_logging - + robot_sf.tb_logging->robot_sf.eval - - + +