Renamed variables in UML diagrams and comments

docs/uml/main/ExtEvSimulationClasses.puml

@@ -165,7 +165,7 @@ package simona-api {
 
     interface ExtTriggerResponse
     class CompletionMessage {
-        - List<Long> newTriggers
+        - Optional<Long> nextActivation
     }
     CompletionMessage --|> ExtTriggerResponse
 

docs/uml/main/ParticipantInheritance.puml

@@ -26,7 +26,7 @@
     + getAndCheckNodalVoltage(...): ComparableQuantity[Dimensionless]
     + initializeParticipant(...): FSM.State[AgentState, ParticipantStateData]
     + {abstract} determineBaseStateData(...): BaseStateData[ApparentPower]
-    + determineTriggersThroughoutSimulation(...): Option[List[ScheduleTriggerMessage]]
+    + determineTriggersThroughoutSimulation(...): Option[List[ScheduleActivation]]
     + baseStateDataForExternalDataProvision(...): FromOutsideBaseStateData
     + queryPrimaryDataAndChangeState(...): FSM.State[AgentState, ParticipantStateData]
     + querySecondaryDataAndChangeState(...): FSM.State[AgentState, ParticipantStateData]

docs/uml/protocol/ExtEvSimulationSequence.puml

@@ -43,7 +43,7 @@ Scheduler -> ExtEvDataService: <font color=red>!</font> Activation(t1)
 deactivate Scheduler
 activate ExtEvDataService
 
-ExtSimulation -> ExtSimAdapter: <font color=red>!</font> CompletionMessage(newTriggers)
+ExtSimulation -> ExtSimAdapter: <font color=red>!</font> Completion(newTriggers)
 deactivate ExtSimulation
 activate ExtSimAdapter
 
@@ -192,7 +192,7 @@ group Provide arriving EVs
     deactivate EvcsAgent2
 end
 
-ExtSimulation -> ExtSimAdapter: <font color=red>!</font> CompletionMessage(t2)
+ExtSimulation -> ExtSimAdapter: <font color=red>!</font> Completion(t2)
 deactivate ExtSimulation
 activate ExtSimAdapter
 

docs/uml/protocol/InitializationPhase.puml

@@ -1,19 +1,19 @@
 @startuml
-MainController -> Listener: create()
-MainController -> SimScheduler: create()
-MainController -> Services: create()
-MainController -> SimScheduler: <font color=red>!</font> ScheduleTriggerMessage(\n\tInitializeServiceTrigger(0),\n\tweatherActorRef)
-MainController -> GridAgents: create()
-MainController -> SimScheduler: <font color=red>!</font> ScheduleTriggerMessage(\n\tInitializeGridAgentTrigger(0),\n\tgridAgentInitData,\n\tgridAgentRef)
-MainController -> SimScheduler: <font color=red>?</font> StartScheduleMessage()
-SimScheduler -> Services: <font color=red>!</font> TriggerWithIdMessage(\n\tInitializeServiceTrigger(_),\n\ttriggerId,\n\t_)
-Services --> SimScheduler: <font color=red>!</font> CompletionMessage(\n\ttriggerId,\n\tScheduleTriggerMessage[...])
-SimScheduler -> GridAgents: <font color=red>!</font> TriggerWithIdMessage(\n\tInitializeGridAgentTrigger(_),\n\ttriggerId,\n\t_)
-GridAgents -> SimScheduler: <font color=red>!</font> ScheduleTriggerMessage(\n\tInitializeSystemComponentsTrigger(0),\n\tassetAgentRef)
-GridAgents --> SimScheduler: <font color=red>!</font> CompletionMessage(triggerId, ScheduleTriggerMessage[...])
-SimScheduler -> ParticipantAgents: <font color=red>!</font> TriggerWithIdMessage(\n\tIInitializeSystemComponentsTrigger(_),\n\ttriggerId,\n\t_)
+SimonaSim -> Listener: create()
+SimonaSim -> Scheduler: create()
+SimonaSim -> Services: create()
+SimonaSim -> Scheduler: <font color=red>!</font> ScheduleActivation(\n\tTick(),\n\tweatherActorRef)
+SimonaSim -> GridAgents: create()
+SimonaSim -> Scheduler: <font color=red>!</font> ScheduleActivation(\n\tTick(),\n\tgridAgentInitData,\n\tgridAgentRef)
+SimonaSim -> Scheduler: <font color=red>?</font> StartScheduleMessage()
+Scheduler -> Services: <font color=red>!</font> TriggerWithIdMessage(\n\tInitializeServiceTrigger(_),\n\ttriggerId,\n\t_)
+Services --> Scheduler: <font color=red>!</font> Completion(\n\tScheduleActivation[...])
+Scheduler -> GridAgents: <font color=red>!</font> TriggerWithIdMessage(\n\tInitializeGridAgentTrigger(_),\n\ttriggerId,\n\t_)
+GridAgents -> Scheduler: <font color=red>!</font> ScheduleActivation(\n\tTick(),\n\tassetAgentRef)
+GridAgents --> Scheduler: <font color=red>!</font> Completion(ScheduleActivation[...])
+Scheduler -> ParticipantAgents: <font color=red>!</font> TriggerWithIdMessage(\n\tIInitializeSystemComponentsTrigger(_),\n\ttriggerId,\n\t_)
 ParticipantAgents -> Services: <font color=red>!</font> RegisterForWeatherMessage(lat, lon)
 ParticipantAgents -> Services: <font color=red>!</font> RegisterFor...
 Services --> ParticipantAgents: <font color=red>!</font> RegistrationResponseMessages
-ParticipantAgents --> SimScheduler: <font color=red>!</font> CompletionMessage(\n\ttriggerId,\n\tScheduleTriggerMessage[\n\t\tActivityStartTrigger(tick)\n\t])
+ParticipantAgents --> Scheduler: <font color=red>!</font> Completion(\n\tScheduleActivation[\n\t\tActivation(tick)\n\t])
 @enduml

docs/uml/protocol/ParticipantTriggeredByItself.puml

@@ -1,6 +1,6 @@
 @startuml
-SimScheduler -> ParticipantAgents: <font color=red>!</font> TriggerWithIdMessage(\n\tIInitializeSystemComponentsTrigger(_),\n\ttriggerId,\n\t_)
-ParticipantAgents --> SimScheduler: <font color=red>!</font> CompletionMessage(triggerId, ScheduleTriggerMessage[...])
-SimScheduler -> ParticipantAgents: <font color=red>!</font> TriggerWithIdMessage(\n\tActivityStartTrigger(tick),\n\t_,\n\t_)
-ParticipantAgents --> SimScheduler: <font color=red>!</font> CompletionMessage(triggerId, None)
+Scheduler -> ParticipantAgents: <font color=red>!</font> TriggerWithIdMessage(\n\tIInitializeSystemComponentsTrigger(_),\n\ttriggerId,\n\t_)
+ParticipantAgents --> Scheduler: <font color=red>!</font> Completion(triggerId, ScheduleActivation[...])
+Scheduler -> ParticipantAgents: <font color=red>!</font> TriggerWithIdMessage(\n\tActivation(tick),\n\t_,\n\t_)
+ParticipantAgents --> Scheduler: <font color=red>!</font> Completion(triggerId, None)
 @enduml

docs/uml/protocol/ParticipantTriggeredByPrimaryData.puml

@@ -1,7 +1,7 @@
 @startuml
-SimScheduler -> PrimaryServiceWorker: <font color=red>!</font> TriggerWithIdMessage(\n\tActivityStartTrigger(tick),\n\t_,\n\t_)
+Scheduler -> PrimaryServiceWorker: <font color=red>!</font> TriggerWithIdMessage(\n\tActivation(tick),\n\t_,\n\t_)
 PrimaryServiceWorker -> ParticipantAgents: <font color=red>!</font> <i>ProvisionMessage</i>
-PrimaryServiceWorker --> SimScheduler: <font color=red>!</font> CompletionMessage(triggerId, None)
-SimScheduler -> ParticipantAgents: <font color=red>!</font> TriggerWithIdMessage(\n\tActivityStartTrigger(tick),\n\t_,\n\t_)
-ParticipantAgents --> SimScheduler: <font color=red>!</font> CompletionMessage(triggerId, None)
+PrimaryServiceWorker --> Scheduler: <font color=red>!</font> Completion(triggerId, None)
+Scheduler -> ParticipantAgents: <font color=red>!</font> TriggerWithIdMessage(\n\tActivation(tick),\n\t_,\n\t_)
+ParticipantAgents --> Scheduler: <font color=red>!</font> Completion(triggerId, None)
 @enduml

docs/uml/protocol/ParticipantTriggeredBySecondaryData.puml

@@ -1,10 +1,10 @@
 @startuml
-SimScheduler -> Services: <font color=red>!</font> TriggerWithIdMessage(\n\tActivityStartTrigger(tick),\n\t_,\n\t_)
+Scheduler -> Services: <font color=red>!</font> TriggerWithIdMessage(\n\tActivation(tick),\n\t_,\n\t_)
 Services -> ParticipantAgents: <font color=red>!</font> ProvideWeatherMessage(\n\ttick,\n\tweatherData,\n\tnextDataTick)
-SimScheduler -> ParticipantAgents: <font color=red>!</font> TriggerWithIdMessage(\n\tActivityStartTrigger(tick),\n\t_,\n\t_)
+Scheduler -> ParticipantAgents: <font color=red>!</font> TriggerWithIdMessage(\n\tActivation(tick),\n\t_,\n\t_)
 Services -> ParticipantAgents: <font color=red>!</font> <i>ProvisionMessage</i>
 Services -> ParticipantAgents: <font color=red>!</font> <i>ProvisionMessage</i>
-Services --> SimScheduler: <font color=red>!</font> CompletionMessage(triggerId, None)
+Services --> Scheduler: <font color=red>!</font> Completion(triggerId, None)
 ParticipantAgents -> ParticipantAgents: <font color=red>!</font> StartCalculationTrigger(tick)
-ParticipantAgents --> SimScheduler: <font color=red>!</font> CompletionMessage(triggerId, None)
+ParticipantAgents --> Scheduler: <font color=red>!</font> Completion(triggerId, None)
 @enduml

src/main/scala/edu/ie3/simona/agent/participant/ParticipantAgentFundamentals.scala

@@ -301,7 +301,7 @@ protected trait ParticipantAgentFundamentals[
           awaitRegistrationResponsesFrom,
         )
       } else {
-        /* Determine the next activation tick, create a ScheduleTriggerMessage and remove the recently triggered tick */
+        /* Determine the next activation tick, create a ScheduleActivation and remove the recently triggered tick */
         val (newTick, nextBaseStateData) = popNextActivationTrigger(
           baseStateData
         )
@@ -902,7 +902,7 @@ protected trait ParticipantAgentFundamentals[
       updatedState,
     )
 
-    /* In this case, without secondary data, the agent has been triggered by an ActivityStartTrigger by itself,
+    /* In this case, without secondary data, the agent has been triggered by an Activation(tick) by itself,
      * therefore pop the next one */
     val baseStateDataWithUpdatedResultStore =
       baseStateData.copy(

src/test/scala/edu/ie3/simona/agent/participant/EvcsAgentModelCalculationSpec.scala

@@ -368,7 +368,7 @@ class EvcsAgentModelCalculationSpec
         RegistrationSuccessfulMessage(evService.ref, Some(900L)),
       )
 
-      /* I'm not interested in the content of the CompletionMessage */
+      /* I'm not interested in the content of the Completion */
       scheduler.expectMsgType[Completion]
 
       evcsAgent.stateName shouldBe Idle
@@ -434,7 +434,7 @@ class EvcsAgentModelCalculationSpec
         RegistrationSuccessfulMessage(evService.ref, Some(0)),
       )
 
-      /* I'm not interested in the content of the CompletionMessage */
+      /* I'm not interested in the content of the Completion */
       scheduler.expectMsgType[Completion]
       awaitAssert(evcsAgent.stateName shouldBe Idle)
       /* State data is tested in another test */
@@ -568,7 +568,7 @@ class EvcsAgentModelCalculationSpec
         RegistrationSuccessfulMessage(evService.ref, Some(0)),
       )
 
-      /* I'm not interested in the content of the CompletionMessage */
+      /* I'm not interested in the content of the Completion */
       scheduler.expectMsgType[Completion]
       awaitAssert(evcsAgent.stateName shouldBe Idle)
       /* State data is tested in another test */
@@ -699,7 +699,7 @@ class EvcsAgentModelCalculationSpec
         RegistrationSuccessfulMessage(evService.ref, Some(10800)),
       )
 
-      /* I'm not interested in the content of the CompletionMessage */
+      /* I'm not interested in the content of the Completion */
       scheduler.expectMsgType[Completion]
       awaitAssert(evcsAgent.stateName shouldBe Idle)
 
@@ -744,7 +744,7 @@ class EvcsAgentModelCalculationSpec
         RegistrationSuccessfulMessage(evService.ref, Some(0)),
       )
 
-      /* I'm not interested in the content of the CompletionMessage */
+      /* I'm not interested in the content of the CompletionM */
       scheduler.expectMsgType[Completion]
       awaitAssert(evcsAgent.stateName shouldBe Idle)
 
@@ -825,7 +825,7 @@ class EvcsAgentModelCalculationSpec
         RegistrationSuccessfulMessage(evService.ref, Some(0)),
       )
 
-      /* I'm not interested in the content of the CompletionMessage */
+      /* I'm not interested in the content of the Completion */
       scheduler.expectMsgType[Completion]
       awaitAssert(evcsAgent.stateName shouldBe Idle)
 
@@ -903,7 +903,7 @@ class EvcsAgentModelCalculationSpec
         RegistrationSuccessfulMessage(evService.ref, Some(0)),
       )
 
-      /* I'm not interested in the content of the CompletionMessage */
+      /* I'm not interested in the content of the Completion */
       scheduler.expectMsgType[Completion]
       awaitAssert(evcsAgent.stateName shouldBe Idle)
 

src/test/scala/edu/ie3/simona/agent/participant/FixedFeedInAgentModelCalculationSpec.scala

@@ -249,7 +249,7 @@ class FixedFeedInAgentModelCalculationSpec
         RegistrationFailedMessage(primaryServiceProxy.ref),
       )
 
-      /* I'm not interested in the content of the CompletionMessage */
+      /* I'm not interested in the content of the Completion */
       scheduler.expectMsgType[Completion]
 
       fixedFeedAgent.stateName shouldBe Idle
@@ -305,7 +305,7 @@ class FixedFeedInAgentModelCalculationSpec
         RegistrationFailedMessage(primaryServiceProxy.ref),
       )
 
-      /* I am not interested in the CompletionMessage */
+      /* I am not interested in the Completion */
       scheduler.expectMsgType[Completion]
       awaitAssert(fixedFeedAgent.stateName shouldBe Idle)
       /* State data is tested in another test */

src/test/scala/edu/ie3/simona/agent/participant/HpAgentModelCalculationSpec.scala

@@ -382,7 +382,7 @@ class HpAgentModelCalculationSpec
         RegistrationSuccessfulMessage(weatherService.ref, Some(900L)),
       )
 
-      /* I'm not interested in the content of the CompletionMessage */
+      /* I'm not interested in the content of the Completion */
       scheduler.expectMsgType[Completion]
 
       hpAgent.stateName shouldBe Idle
@@ -446,7 +446,7 @@ class HpAgentModelCalculationSpec
         RegistrationSuccessfulMessage(weatherService.ref, Some(0L)),
       )
 
-      /* I'm not interested in the content of the CompletionMessage */
+      /* I'm not interested in the content of the Completion */
       scheduler.expectMsgType[Completion]
       awaitAssert(hpAgent.stateName shouldBe Idle)
       /* State data is tested in another test */
@@ -577,7 +577,7 @@ class HpAgentModelCalculationSpec
         RegistrationSuccessfulMessage(weatherService.ref, Some(0L)),
       )
 
-      /* I'm not interested in the content of the CompletionMessage */
+      /* I'm not interested in the content of the Completion */
       scheduler.expectMsgType[Completion]
       awaitAssert(hpAgent.stateName shouldBe Idle)
 
@@ -706,7 +706,7 @@ class HpAgentModelCalculationSpec
         RegistrationSuccessfulMessage(weatherService.ref, Some(3600L)),
       )
 
-      /* I'm not interested in the content of the CompletionMessage */
+      /* I'm not interested in the content of the Completion */
       scheduler.expectMsgType[Completion]
       awaitAssert(hpAgent.stateName shouldBe Idle)
 
@@ -777,7 +777,7 @@ class HpAgentModelCalculationSpec
         RegistrationSuccessfulMessage(weatherService.ref, Some(0L)),
       )
 
-      /* I'm not interested in the content of the CompletionMessage */
+      /* I'm not interested in the content of the Completion */
       scheduler.expectMsgType[Completion]
       awaitAssert(hpAgent.stateName shouldBe Idle)
 

src/test/scala/edu/ie3/simona/agent/participant/LoadAgentFixedModelCalculationSpec.scala

@@ -243,7 +243,7 @@ class LoadAgentFixedModelCalculationSpec
         RegistrationFailedMessage(primaryServiceProxy.ref),
       )
 
-      /* I'm not interested in the content of the CompletionMessage */
+      /* I'm not interested in the content of the Completion */
       scheduler.expectMsgType[Completion]
 
       loadAgent.stateName shouldBe Idle
@@ -299,7 +299,7 @@ class LoadAgentFixedModelCalculationSpec
         RegistrationFailedMessage(primaryServiceProxy.ref),
       )
 
-      /* I am not interested in the CompletionMessage */
+      /* I am not interested in the Completion */
       scheduler.expectMsgType[Completion]
       awaitAssert(loadAgent.stateName shouldBe Idle)
       /* State data is tested in another test */

src/test/scala/edu/ie3/simona/agent/participant/LoadAgentProfileModelCalculationSpec.scala

@@ -243,7 +243,7 @@ class LoadAgentProfileModelCalculationSpec
         RegistrationFailedMessage(primaryServiceProxy.ref),
       )
 
-      /* I'm not interested in the content of the CompletionMessage */
+      /* I'm not interested in the content of the Completion */
       scheduler.expectMsgType[Completion]
 
       loadAgent.stateName shouldBe Idle
@@ -299,7 +299,7 @@ class LoadAgentProfileModelCalculationSpec
         RegistrationFailedMessage(primaryServiceProxy.ref),
       )
 
-      /* I am not interested in the CompletionMessage */
+      /* I am not interested in the Completion */
       scheduler.expectMsgType[Completion]
       awaitAssert(loadAgent.stateName shouldBe Idle)
       /* State data is tested in another test */

src/test/scala/edu/ie3/simona/agent/participant/ParticipantAgent2ListenerSpec.scala

@@ -286,7 +286,7 @@ class ParticipantAgent2ListenerSpec
       /* Trigger the data generation in tick 0 */
       scheduler.send(mockAgent, Activation(0))
 
-      /* Appreciate the existence of two CompletionMessages */
+      /* Appreciate the existence of two Completion */
       scheduler.expectMsg(Completion(mockAgent.toTyped))
 
       /* Ask the agent for average power in tick 3000 */

src/test/scala/edu/ie3/simona/agent/participant/ParticipantAgentExternalSourceSpec.scala

@@ -247,7 +247,7 @@ class ParticipantAgentExternalSourceSpec
         RegistrationSuccessfulMessage(primaryServiceProxy.ref, Some(900L)),
       )
 
-      /* I'm not interested in the content of the CompletionMessage */
+      /* I'm not interested in the content of the Completion */
       scheduler.expectMsgType[Completion]
       awaitAssert(mockAgent.stateName shouldBe Idle)
 
@@ -312,7 +312,7 @@ class ParticipantAgentExternalSourceSpec
         RegistrationSuccessfulMessage(primaryServiceProxy.ref, Some(900L)),
       )
 
-      /* I'm not interested in the content of the CompletionMessage */
+      /* I'm not interested in the content of the Completion */
       scheduler.expectMsgType[Completion]
       awaitAssert(mockAgent.stateName shouldBe Idle)
 
@@ -413,7 +413,7 @@ class ParticipantAgentExternalSourceSpec
         RegistrationSuccessfulMessage(primaryServiceProxy.ref, Some(900L)),
       )
 
-      /* I'm not interested in the content of the CompletionMessage */
+      /* I'm not interested in the content of the Completion */
       scheduler.expectMsgType[Completion]
       awaitAssert(mockAgent.stateName shouldBe Idle)
 
@@ -508,7 +508,7 @@ class ParticipantAgentExternalSourceSpec
         RegistrationSuccessfulMessage(primaryServiceProxy.ref, Some(900L)),
       )
 
-      /* I'm not interested in the content of the CompletionMessage */
+      /* I'm not interested in the content of the Completion */
       scheduler.expectMsgType[Completion]
       awaitAssert(mockAgent.stateName shouldBe Idle)
 
@@ -624,7 +624,7 @@ class ParticipantAgentExternalSourceSpec
         RegistrationSuccessfulMessage(primaryServiceProxy.ref, Some(900L)),
       )
 
-      /* I'm not interested in the content of the CompletionMessage */
+      /* I'm not interested in the content of the Completion */
       scheduler.expectMsgType[Completion]
       awaitAssert(mockAgent.stateName shouldBe Idle)
 

src/test/scala/edu/ie3/simona/agent/participant/PvAgentModelCalculationSpec.scala

@@ -376,7 +376,7 @@ class PvAgentModelCalculationSpec
         RegistrationSuccessfulMessage(weatherService.ref, Some(900L)),
       )
 
-      /* I'm not interested in the content of the CompletionMessage */
+      /* I'm not interested in the content of the Completion */
       scheduler.expectMsgType[Completion]
 
       pvAgent.stateName shouldBe Idle
@@ -439,7 +439,7 @@ class PvAgentModelCalculationSpec
         RegistrationSuccessfulMessage(weatherService.ref, Some(0L)),
       )
 
-      /* I'm not interested in the content of the CompletionMessage */
+      /* I'm not interested in the content of the Completion */
       scheduler.expectMsgType[Completion]
       awaitAssert(pvAgent.stateName shouldBe Idle)
       /* State data is tested in another test */
@@ -546,7 +546,7 @@ class PvAgentModelCalculationSpec
         RegistrationSuccessfulMessage(weatherService.ref, Some(0L)),
       )
 
-      /* I'm not interested in the content of the CompletionMessage */
+      /* I'm not interested in the content of the Completion */
       scheduler.expectMsgType[Completion]
       awaitAssert(pvAgent.stateName shouldBe Idle)
 
@@ -651,7 +651,7 @@ class PvAgentModelCalculationSpec
         RegistrationSuccessfulMessage(weatherService.ref, Some(3600L)),
       )
 
-      /* I'm not interested in the content of the CompletionMessage */
+      /* I'm not interested in the content of the Completion */
       scheduler.expectMsgType[Completion]
       awaitAssert(pvAgent.stateName shouldBe Idle)
 
@@ -722,7 +722,7 @@ class PvAgentModelCalculationSpec
         RegistrationSuccessfulMessage(weatherService.ref, Some(0L)),
       )
 
-      /* I'm not interested in the content of the CompletionMessage */
+      /* I'm not interested in the content of the Completion */
       scheduler.expectMsgType[Completion]
       awaitAssert(pvAgent.stateName shouldBe Idle)