feat(application): introduce agent unit and agent operating system #457

kschrab · 2025-01-15T14:36:16Z

Description

spawning of agents via mapping_config.json
creating agent units in mosaic-application
provide AgentOperatingSystem with access to public transport routing and other really basic API
still no functionality, as the core Agent-Simulator is still missing

Issue(s) related to this PR

Resolves issue # / internal issue

Affected parts of the online documentation

Changes in the documentation required?

Definition of Done

Prerequisites

You have read CONTRIBUTING.md carefully.
You have signed the Contributor License Agreement.
Your GitHub user id is linked with your Eclipse Account.

Required

The title of this merge request follows the scheme type(scope): description (in the style of Conventional Commits)
You have assigned a suitable label to this pull request (e.g., enhancement, or bugfix)
origin/main has been merged into your Fork.
Coding guidelines have been followed (see CONTRIBUTING.md).
All checks on GitHub pass.
All tests on Jenkins pass.

Requested (can be enforced by maintainers)

New functionality is covered by unit tests or integration tests. Code coverage must not decrease.
If a bug has been fixed, a new unit test has been written (beforehand) to prove misbehavior
There are no new SpotBugs warnings.

Special notes to reviewer

* spawning of agents via mapping_config.json * creating agent units in mosaic-application * provide AgentOperatingSystem with access to public transport routing and other really basic API * still no functionality, as the core Agent-Simulator is still missing

schwepmo · 2025-01-22T07:54:12Z

lib/mosaic-objects/src/main/java/org/eclipse/mosaic/lib/objects/mapping/AgentMapping.java

+
+    private static final long serialVersionUID = 1L;
+
+    private final double walkingSpeed;


Add a comment here or probably better at getter including the unit the walking speed is handled in.

schwepmo · 2025-01-22T08:43:25Z

fed/mosaic-mapping/src/main/resources/CMappingAmbassadorScheme.json

+                    "items": { "type": "string" }
+                },
+                "walkingSpeed": {
+                    "description": "Speed which is used for walking, in m/s.",


At least the walking speed unit is here :)

schwepmo · 2025-01-22T08:49:48Z

fed/mosaic-mapping/src/main/java/org/eclipse/mosaic/fed/mapping/config/units/CAgent.java

+    public GeoPoint destination;
+
+    /**
+     * Walking speed of this agent.


Just to be ultra verbose.

Suggested change

* Walking speed of this agent.

* Walking speed of this agent. [m/s]

schwepmo · 2025-01-22T09:05:19Z

...c-mapping/src/main/java/org/eclipse/mosaic/fed/mapping/ambassador/spawning/AgentSpawner.java

+    public void fillInPrototype(CPrototype prototypeConfiguration) {
+        super.fillInPrototype(prototypeConfiguration);
+
+        if (prototypeConfiguration != null && prototypeConfiguration.maxSpeed != null) {


Should we check here if the walkingSpeed has been set by the CAgent beforehand?
In the VehicleFlowGenerator we do maxSpeed = defaultIfNull(maxSpeed, prototypeConfiguration.maxSpeed);

Good catch!

...cation/src/main/java/org/eclipse/mosaic/fed/application/app/api/os/AgentOperatingSystem.java

schwepmo · 2025-01-22T09:40:46Z

...rg/eclipse/mosaic/fed/application/ambassador/simulation/navigation/AgentPtRoutingModule.java

+    public PtRoutingResponse calculateRoute(long requestTime, GeoPoint origin, GeoPoint destination, PtRoutingParameters routingParameters) {
+        PtRoutingRequest routingRequest = new PtRoutingRequest(requestTime, origin, destination, routingParameters);
+        if (routingParameters.getWalkingSpeedMps() == null) {
+            routingParameters.walkingSpeedMps(defaultWalkingSpeed);


PtRoutingParameters already has a default value for the walking speed, do we need it here again?

Not anymore. Since every agent can be defined with its own walking speed in the mapping_config, we should use that value instead. Only if it's re-defined by the user with custom routing parameters, than we use that what the user/app specifies, otherwise the value from mapping.

schwepmo · 2025-01-22T12:55:51Z

lib/mosaic-routing/src/main/java/org/eclipse/mosaic/lib/routing/pt/PtRoute.java

+    /**
+     * Returns the individual legs of this multi-modal route.
+     */
+    public List<Leg> getLegs() {


Is it a multi-modal or a pt route? Or is the comment referring to different modes of public transport?

Oh that is from before refactoring. Will change that.

schwepmo · 2025-01-22T13:07:30Z

lib/mosaic-routing/src/main/java/org/eclipse/mosaic/lib/routing/pt/PtRouting.java

-        ghRequest.setWalkSpeedKmH(SpeedUtils.ms2kmh(request.getRoutingParameters().getWalkingSpeedMps()));
+
+        if (request.getRoutingParameters().getWalkingSpeedMps() == null) {
+            ghRequest.setWalkSpeedKmH(5);


This is a magic number

I think I will throw an exception if it is not set, since with the current code it will be never null here.

schwepmo · 2025-01-22T13:07:38Z

lib/mosaic-routing/src/main/java/org/eclipse/mosaic/lib/routing/pt/PtRouting.java

@@ -136,7 +136,12 @@ public PtRoutingResponse findPtRoute(PtRoutingRequest request) {
        );
        // ghRequest.setBlockedRouteTypes(request.getRoutingParameters().excludedPtModes);//FIXME generalize this


Do we still need this?

To be fair, currently we don't need anything of this 🫣 But yes, I will delete that and we will see once we actually use this if we would need to exclude certain public transport modes.

schwepmo · 2025-01-22T13:09:06Z

lib/mosaic-routing/src/main/java/org/eclipse/mosaic/lib/routing/pt/PtRouting.java

@@ -136,7 +136,12 @@ public PtRoutingResponse findPtRoute(PtRoutingRequest request) {
        );
        // ghRequest.setBlockedRouteTypes(request.getRoutingParameters().excludedPtModes);//FIXME generalize this
        ghRequest.setEarliestDepartureTime(departureTime);
-        ghRequest.setWalkSpeedKmH(SpeedUtils.ms2kmh(request.getRoutingParameters().getWalkingSpeedMps()));
+
+        if (request.getRoutingParameters().getWalkingSpeedMps() == null) {


Wouldn't it be easier to initialize the walking speed in the PtRoutingParameters with a default value?

For correctness, we need to use the speed of the mapping config as default. That's not possible by defining it in PtRoutingParameters.

* unified naming of Pt vs PublicTransport * moved `vehicle.PublicTransportData` to `pt.PtVehicleData`. * added missing javadoc * fixed walking speed configuration in mapping

…terface

kschrab force-pushed the 974-create-agent-unit branch from cc7f6c1 to 671ffc8 Compare January 15, 2025 14:41

kschrab force-pushed the 974-create-agent-unit branch from 671ffc8 to a4ea233 Compare January 16, 2025 16:39

kschrab requested a review from schwepmo January 16, 2025 16:40

kschrab marked this pull request as ready for review January 20, 2025 09:58

schwepmo requested changes Jan 22, 2025

View reviewed changes

kschrab added 5 commits January 23, 2025 16:48

clean: work after review

301fefc

* unified naming of Pt vs PublicTransport * moved `vehicle.PublicTransportData` to `pt.PtVehicleData`. * added missing javadoc * fixed walking speed configuration in mapping

test(agents): unit test for mapping and launching agents

2e50840

fix(mapping): dont let agent spawner extend from StationarySpawner in…

48b6908

…terface

fix(objects): resolve spotbugs warnings (equals/hashcode/serializable)

775adaf

fix(agent): resolve checkstyle warnings

cae9f29

kschrab requested a review from schwepmo January 24, 2025 12:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(application): introduce agent unit and agent operating system #457

feat(application): introduce agent unit and agent operating system #457

kschrab commented Jan 15, 2025 •

edited

Loading

schwepmo Jan 22, 2025

schwepmo Jan 22, 2025

schwepmo Jan 22, 2025

schwepmo Jan 22, 2025

kschrab Jan 23, 2025

schwepmo Jan 22, 2025

kschrab Jan 23, 2025

schwepmo Jan 22, 2025

kschrab Jan 23, 2025

schwepmo Jan 22, 2025

kschrab Jan 23, 2025

schwepmo Jan 22, 2025

kschrab Jan 23, 2025

schwepmo Jan 22, 2025

kschrab Jan 23, 2025


		private static final long serialVersionUID = 1L;

		private final double walkingSpeed;

	* Walking speed of this agent.
	* Walking speed of this agent. [m/s]

		@@ -136,7 +136,12 @@ public PtRoutingResponse findPtRoute(PtRoutingRequest request) {
		);
		// ghRequest.setBlockedRouteTypes(request.getRoutingParameters().excludedPtModes);//FIXME generalize this

feat(application): introduce agent unit and agent operating system #457

Are you sure you want to change the base?

feat(application): introduce agent unit and agent operating system #457

Conversation

kschrab commented Jan 15, 2025 • edited Loading

Description

Issue(s) related to this PR

Affected parts of the online documentation

Definition of Done

Special notes to reviewer

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kschrab commented Jan 15, 2025 •

edited

Loading