Refactoring EM messages

Signed-off-by: Sebastian Peter <sebastian.peter@tu-dortmund.de>

CHANGELOG.md

@@ -79,6 +79,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Updated `Gradle` to version V8.10 [#829](https://github.com/ie3-institute/simona/issues/829)
 - Updated AUTHORS.md [#905](https://github.com/ie3-institute/simona/issues/905)
 - Rewrote BMModelTest from groovy to scala [#646](https://github.com/ie3-institute/simona/issues/646)
+- Refactoring EM messages [#947](https://github.com/ie3-institute/simona/issues/947)
 
 ### Fixed
 - Removed a repeated line in the documentation of vn_simona config [#658](https://github.com/ie3-institute/simona/issues/658)

docs/readthedocs/models/em.md

@@ -6,11 +6,11 @@ Energy Management Agents (EmAgents) control power feed-in and load of system par
 
 ## Protocol
 
-During simulation, EmAgents send `RequestFlexOptions` and `IssueFlexControl` messages and receive `ProvideFlexOptions` and `FlexCompletion` messages.
-After having been requested to calculate flex options via `RequestFlexOptions`, controllable assets send back their flex options to the controlling unit using `ProvideFlexOptions`. 
+During simulation, EmAgents send `FlexActivation` and `IssueFlexControl` messages and receive `ProvideFlexOptions` and `FlexCompletion` messages.
+After having been requested to calculate flex options via `FlexActivation`, controllable assets send back their flex options to the controlling unit using `ProvideFlexOptions`. 
 Eventually the controlling EmAgent responds with some type of `IssueFlexControl` messages, setting a power set point for operation.
 The asset then tries to realize the set power as best as it can and replies with a `FlexCompletion` messages.
-If an EmAgent is itself controlled by another EmAgent, it also behaves like a system participant (sends `RequestFlexOptions` and `IssueFlexControl` messages etc.).
+If an EmAgent is itself controlled by another EmAgent, it also behaves like a system participant (sends `FlexActivation` and `IssueFlexControl` messages etc.).
 
 
 Every EmAgent aggregates flex options and power of its connected assets and disaggregates flex control among the connected assets. 

docs/uml/protocol/em/ControlledEm.puml

@@ -54,13 +54,13 @@ deactivate WeatherService
 Scheduler -> EmAgent1: Activation(tick=0)
 activate EmAgent1
 
-EmAgent1 -> EmAgent2: RequestFlexOptions(tick=0)
+EmAgent1 -> EmAgent2: FlexActivation(tick=0)
 activate EmAgent2
 
-EmAgent2 -> StorageAgent: RequestFlexOptions(tick=0)
+EmAgent2 -> StorageAgent: FlexActivation(tick=0)
 activate StorageAgent
 
-EmAgent2 -> PvAgent: RequestFlexOptions(tick=0)
+EmAgent2 -> PvAgent: FlexActivation(tick=0)
 activate PvAgent
 
 PvAgent -> EmAgent2: ProvideFlexOptions
@@ -101,10 +101,10 @@ deactivate EmAgent1
 Scheduler -> EmAgent1: Activation(tick=1805)
 activate EmAgent1
 
-EmAgent1 -> EmAgent2: RequestFlexOptions(tick=1805)
+EmAgent1 -> EmAgent2: FlexActivation(tick=1805)
 activate EmAgent2
 
-EmAgent2 -> StorageAgent: RequestFlexOptions(tick=1805)
+EmAgent2 -> StorageAgent: FlexActivation(tick=1805)
 activate StorageAgent
 
 StorageAgent -> EmAgent2: ProvideFlexOptions

docs/uml/protocol/em/UncontrolledEm.puml

@@ -50,10 +50,10 @@ deactivate WeatherService
 Scheduler -> EmAgent: Activation(tick=0)
 activate EmAgent
 
-EmAgent -> StorageAgent: RequestFlexOptions(tick=0)
+EmAgent -> StorageAgent: FlexActivation(tick=0)
 activate StorageAgent
 
-EmAgent -> PvAgent: RequestFlexOptions(tick=0)
+EmAgent -> PvAgent: FlexActivation(tick=0)
 activate PvAgent
 
 PvAgent -> EmAgent: ProvideFlexOptions

src/main/scala/edu/ie3/simona/agent/em/EmAgent.scala

@@ -191,10 +191,10 @@ object EmAgent {
       val flexOptionsCore = core.activate(msg.tick)
 
       msg match {
-        case Flex(_: RequestFlexOptions) | EmActivation(_) =>
+        case Flex(_: FlexActivation) | EmActivation(_) =>
           val (toActivate, newCore) = flexOptionsCore.takeNewFlexRequests()
           toActivate.foreach {
-            _ ! RequestFlexOptions(msg.tick)
+            _ ! FlexActivation(msg.tick)
           }
 
           newCore.fold(
@@ -371,7 +371,7 @@ object EmAgent {
         updatedCore,
       )
 
-    case completion: FlexCtrlCompletion =>
+    case completion: FlexCompletion =>
       val updatedCore = core.handleCompletion(completion)
 
       updatedCore
@@ -436,7 +436,7 @@ object EmAgent {
           schedulerData.activationAdapter,
           inactiveCore.nextActiveTick,
         ),
-      _.emAgent ! FlexCtrlCompletion(
+      _.emAgent ! FlexCompletion(
         modelShell.uuid,
         inactiveCore.hasFlexWithNext,
         inactiveCore.nextActiveTick,

src/main/scala/edu/ie3/simona/agent/em/EmDataCore.scala

@@ -446,7 +446,7 @@ object EmDataCore {
       *   on critical error
       */
     def handleCompletion(
-        completion: FlexCtrlCompletion
+        completion: FlexCompletion
     ): AwaitingCompletions = {
       if (!awaitedCompletions.contains(completion.modelUuid))
         throw new CriticalFailureException(

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

@@ -49,7 +49,7 @@ import edu.ie3.simona.ontology.messages.Activation
 import edu.ie3.simona.ontology.messages.flex.FlexibilityMessage.{
   FlexResponse,
   IssueFlexControl,
-  RequestFlexOptions,
+  FlexActivation,
 }
 import edu.ie3.simona.ontology.messages.services.ServiceMessage.RegistrationResponseMessage.RegistrationSuccessfulMessage
 import edu.ie3.simona.ontology.messages.services.ServiceMessage.{
@@ -221,7 +221,7 @@ abstract class ParticipantAgent[
       finalizeTickAfterPF(baseStateData, tick)
 
     case Event(
-          RequestFlexOptions(tick),
+          FlexActivation(tick),
           baseStateData: ParticipantModelBaseStateData[PD, CD, MS, M],
         ) =>
       val expectedSenders = baseStateData.foreseenDataTicks
@@ -336,7 +336,7 @@ abstract class ParticipantAgent[
       )(stateData.baseStateData.outputConfig)
 
     case Event(
-          RequestFlexOptions(tick),
+          FlexActivation(tick),
           stateData: DataCollectionStateData[PD],
         ) =>
       checkForExpectedDataAndChangeState(

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

@@ -802,7 +802,7 @@ protected trait ParticipantAgentFundamentals[
       result.primaryData.toApparentPower,
     )
 
-    flexStateData.emAgent ! FlexCtrlCompletion(
+    flexStateData.emAgent ! FlexCompletion(
       baseStateData.modelUuid,
       flexChangeIndicator.changesAtNextActivation,
       nextActivation,

src/main/scala/edu/ie3/simona/ontology/messages/flex/FlexibilityMessage.scala

@@ -77,12 +77,11 @@ object FlexibilityMessage {
     * @param tick
     *   The tick to request flex options for
     */
-  final case class RequestFlexOptions(override val tick: Long)
-      extends FlexRequest
+  final case class FlexActivation(override val tick: Long) extends FlexRequest
 
   /** Message that provides flex options to an
     * [[edu.ie3.simona.agent.em.EmAgent]] after they have been requested via
-    * [[RequestFlexOptions]]
+    * [[FlexActivation]]
     */
   trait ProvideFlexOptions extends FlexResponse
 
@@ -117,8 +116,8 @@ object FlexibilityMessage {
       extends IssueFlexControl
 
   /** Message sent by flex options providers that transports the result after
-    * flex control has been handled. Has to be sent before
-    * [[FlexCtrlCompletion]], but is not required during initialization.
+    * flex control has been handled. Has to be sent before [[FlexCompletion]],
+    * but is not required during initialization.
     *
     * @param modelUuid
     *   The UUID of the flex options provider asset model
@@ -147,7 +146,7 @@ object FlexibilityMessage {
     * i.e. the tick at which the flex options provider would like to be
     * activated at the latest.
     */
-  final case class FlexCtrlCompletion(
+  final case class FlexCompletion(
       override val modelUuid: UUID,
       requestAtNextActivation: Boolean = false,
       requestAtTick: Option[Long] = None,