LL/#73 first implementation of input

.gitattributes

@@ -1,3 +1,2 @@
 # These are explicitly windows files and should use crlf
 *.bat           text eol=crlf
-

.scalafmt.conf

@@ -0,0 +1 @@
+runner.dialect = scala3

build.gradle

@@ -73,6 +73,9 @@ dependencies {
   implementation 'com.typesafe:config:1.4.2'
   implementation "com.github.scopt:scopt_$scalaMajorVersion:4.0.1" // cmd args parser
 
+  // osm4scala
+  implementation 'com.acervera.osm4scala:osm4scala-core_2.13:1.0.10'
+
   // todo CLEANUP following old dependencies
   //	 ie³ power system utils
   implementation('com.github.ie3-institute:PowerSystemUtils:2.0-SNAPSHOT') {

gradle/scripts/spotless.gradle

@@ -33,7 +33,7 @@ spotless {
 
   //sets a license header, removes unused imports and formats conforming to the scala fmt formatter
   scala {
-    scalafmt()
+    scalafmt().configFile('.scalafmt.conf')
     licenseHeader ie3LicHead, "package.*\\n"
   }
 

gradle/scripts/tscfg.gradle

@@ -5,7 +5,7 @@ task genConfigClass {
   doLast {
     def tscfgJarFile = project.file('build/tscfg-' + tscfgVersion + '.jar')
     if (!tscfgJarFile.exists() || !tscfgJarFile.isFile()) {
-      download {
+      download.run {
         src 'https://github.com/carueda/tscfg/releases/download/v' + tscfgVersion + '/tscfg-' + tscfgVersion + '.jar'
         dest buildDir
       }
@@ -37,7 +37,7 @@ task genConfigSample {
   doLast {
     def tscfgJarFile = project.file('build/tscfg-' + tscfgVersion + '.jar')
     if (!tscfgJarFile.exists() || !tscfgJarFile.isFile()) {
-      download {
+      download.run {
         src 'https://github.com/carueda/tscfg/releases/download/v' + tscfgVersion + '/tscfg-' + tscfgVersion + '.jar'
         dest buildDir
       }

src/main/resources/config/config-template.conf

@@ -23,5 +23,13 @@ generation: {
   #@optional
   lv: {
     distinctHouseConnections: Boolean | false # If there shall be distinct lines for house connection
+    osm: {
+      #@optional
+      filter: { # filter to be applied for the LvOsmoGridModel
+        building: [string]
+        highway: [string]
+        landuse: [string]
+      }
+    }
   }
 }

src/main/resources/logback-test.xml

@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration>
+
+  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+    <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
+      <level>INFO</level>
+    </filter>
+    <encoder>
+      <pattern>[%date{ISO8601}] [%level] [%logger] [%thread] - %msg MDC: {%mdc}%n</pattern>
+    </encoder>
+  </appender>
+
+  <!--
+  Logging from tests are silenced by this appender. When there is a test failure
+  the captured logging events are flushed to the appenders defined for the
+  akka.actor.testkit.typed.internal.CapturingAppenderDelegate logger.
+  -->
+  <appender name="CapturingAppender" class="akka.actor.testkit.typed.internal.CapturingAppender" />
+
+  <!--
+  The appenders defined for this CapturingAppenderDelegate logger are used
+  when there is a test failure and all logging events from the test are
+  flushed to these appenders.
+  -->
+  <logger name="akka.actor.testkit.typed.internal.CapturingAppenderDelegate" >
+    <appender-ref ref="STDOUT"/>
+  </logger>
+
+  <root level="DEBUG">
+    <appender-ref ref="CapturingAppender"/>
+  </root>
+</configuration>

src/main/scala/edu/ie3/osmogrid/ActorStopSupport.scala

@@ -8,26 +8,36 @@ package edu.ie3.osmogrid
 
 import akka.actor.typed.Behavior
 import akka.actor.typed.scaladsl.Behaviors
-import edu.ie3.osmogrid.io.input.InputDataProvider.Request
 import org.slf4j.Logger
 
-trait ActorStopSupport[T] {
+/** Support trait for executing clean up tasks with stopping an actor
+  *
+  * @tparam T
+  *   Behavior type
+  * @tparam S
+  *   StateData type. Optional, use [[Any]] if not applicable
+  */
+trait ActorStopSupport[T, S] {
 
-  /** Partial function to perform cleanup tasks while shutting down
+  /** Function to perform cleanup tasks while shutting down
     */
-  protected val cleanUp: () => Unit
-
-  protected def terminate(log: Logger): Behavior[T] = {
-    log.info("Got request to terminate.")
-    stopBehavior
-  }
+  protected def cleanUp(stateData: S): Unit
 
   /** Specific stop state with clean up actions issued
     */
-  protected val stopBehavior: Behavior[T] = Behaviors.stopped(cleanUp)
+  protected def stopBehavior(stateData: S): Behavior[T] =
+    Behaviors.stopped(() => cleanUp(stateData))
+
+  final protected def terminate(log: Logger, stateData: S): Behavior[T] = {
+    log.info("Got request to terminate.")
+    stopBehavior(stateData)
+  }
 
-  protected def postStopCleanUp(log: Logger): Behavior[T] = {
+  final protected def postStopCleanUp(
+      log: Logger,
+      stateData: S
+  ): Behavior[T] = {
     log.info("Got terminated by ActorSystem.")
-    stopBehavior
+    stopBehavior(stateData)
   }
 }

src/main/scala/edu/ie3/osmogrid/ActorStopSupportStateless.scala

@@ -0,0 +1,36 @@
+/*
+ * © 2022. TU Dortmund University,
+ * Institute of Energy Systems, Energy Efficiency and Energy Economics,
+ * Research group Distribution grid planning and operation
+ */
+
+package edu.ie3.osmogrid
+
+import akka.actor.typed.Behavior
+import akka.actor.typed.scaladsl.Behaviors
+import org.slf4j.Logger
+
+/** Support trait for executing clean up tasks with stopping an actor
+  * @tparam T
+  *   Behavior type
+  */
+trait ActorStopSupportStateless[T] {
+
+  /** Function to perform cleanup tasks while shutting down
+    */
+  protected def cleanUp(): Unit
+
+  /** Specific stop state with clean up actions issued
+    */
+  protected val stopBehavior: Behavior[T] = Behaviors.stopped(cleanUp)
+
+  final protected def terminate(log: Logger): Behavior[T] = {
+    log.info("Got request to terminate.")
+    stopBehavior
+  }
+
+  final protected def postStopCleanUp(log: Logger): Behavior[T] = {
+    log.info("Got terminated by ActorSystem.")
+    stopBehavior
+  }
+}

src/main/scala/edu/ie3/osmogrid/cfg/ConfigFailFast.scala

@@ -47,8 +47,19 @@ object ConfigFailFast extends LazyLogging {
 
   private def checkLvConfig(lv: OsmoGridConfig.Generation.Lv): Unit = lv match {
     case Lv(
-          distinctHouseConnections
+          amountOfGridGenerators,
+          amountOfRegionCoordinators,
+          distinctHouseConnections,
+          lv.osm
         ) =>
+      if (amountOfGridGenerators < 1)
+        throw IllegalConfigException(
+          s"The amount of lv grid generation actors needs to be at least 1 (provided: $amountOfGridGenerators)."
+        )
+      if (amountOfRegionCoordinators < 1)
+        throw IllegalConfigException(
+          s"The amount of lv region coordination actors needs to be at least 1 (provided: $amountOfRegionCoordinators)."
+        )
   }
 
   private def checkInputConfig(input: OsmoGridConfig.Input): Unit =

src/main/scala/edu/ie3/osmogrid/cfg/OsmoGridConfig.scala

@@ -17,18 +17,81 @@ object OsmoGridConfig {
   )
   object Generation {
     final case class Lv(
-        distinctHouseConnections: scala.Boolean
+        amountOfGridGenerators: scala.Int,
+        amountOfRegionCoordinators: scala.Int,
+        distinctHouseConnections: scala.Boolean,
+        osm: OsmoGridConfig.Generation.Lv.Osm
     )
     object Lv {
+      final case class Osm(
+          filter: scala.Option[OsmoGridConfig.Generation.Lv.Osm.Filter]
+      )
+      object Osm {
+        final case class Filter(
+            building: scala.List[java.lang.String],
+            highway: scala.List[java.lang.String],
+            landuse: scala.List[java.lang.String]
+        )
+        object Filter {
+          def apply(
+              c: com.typesafe.config.Config,
+              parentPath: java.lang.String,
+              $tsCfgValidator: $TsCfgValidator
+          ): OsmoGridConfig.Generation.Lv.Osm.Filter = {
+            OsmoGridConfig.Generation.Lv.Osm.Filter(
+              building =
+                $_L$_str(c.getList("building"), parentPath, $tsCfgValidator),
+              highway =
+                $_L$_str(c.getList("highway"), parentPath, $tsCfgValidator),
+              landuse =
+                $_L$_str(c.getList("landuse"), parentPath, $tsCfgValidator)
+            )
+          }
+        }
+
+        def apply(
+            c: com.typesafe.config.Config,
+            parentPath: java.lang.String,
+            $tsCfgValidator: $TsCfgValidator
+        ): OsmoGridConfig.Generation.Lv.Osm = {
+          OsmoGridConfig.Generation.Lv.Osm(
+            filter =
+              if (c.hasPathOrNull("filter"))
+                scala.Some(
+                  OsmoGridConfig.Generation.Lv.Osm.Filter(
+                    c.getConfig("filter"),
+                    parentPath + "filter.",
+                    $tsCfgValidator
+                  )
+                )
+              else None
+          )
+        }
+      }
+
       def apply(
           c: com.typesafe.config.Config,
           parentPath: java.lang.String,
           $tsCfgValidator: $TsCfgValidator
       ): OsmoGridConfig.Generation.Lv = {
         OsmoGridConfig.Generation.Lv(
+          amountOfGridGenerators =
+            if (c.hasPathOrNull("amountOfGridGenerators"))
+              c.getInt("amountOfGridGenerators")
+            else 10,
+          amountOfRegionCoordinators =
+            if (c.hasPathOrNull("amountOfRegionCoordinators"))
+              c.getInt("amountOfRegionCoordinators")
+            else 5,
           distinctHouseConnections = c.hasPathOrNull(
             "distinctHouseConnections"
-          ) && c.getBoolean("distinctHouseConnections")
+          ) && c.getBoolean("distinctHouseConnections"),
+          osm = OsmoGridConfig.Generation.Lv.Osm(
+            if (c.hasPathOrNull("osm")) c.getConfig("osm")
+            else com.typesafe.config.ConfigFactory.parseString("osm{}"),
+            parentPath + "osm.",
+            $tsCfgValidator
+          )
         )
       }
     }
@@ -271,6 +334,31 @@ object OsmoGridConfig {
     $tsCfgValidator.validate()
     $result
   }
+
+  private def $_L$_str(
+      cl: com.typesafe.config.ConfigList,
+      parentPath: java.lang.String,
+      $tsCfgValidator: $TsCfgValidator
+  ): scala.List[java.lang.String] = {
+    import scala.jdk.CollectionConverters._
+    cl.asScala.map(cv => $_str(cv)).toList
+  }
+  private def $_expE(
+      cv: com.typesafe.config.ConfigValue,
+      exp: java.lang.String
+  ) = {
+    val u: Any = cv.unwrapped
+    new java.lang.RuntimeException(
+      s"${cv.origin.lineNumber}: " +
+        "expecting: " + exp + " got: " +
+        (if (u.isInstanceOf[java.lang.String]) "\"" + u + "\"" else u)
+    )
+  }
+
+  private def $_str(cv: com.typesafe.config.ConfigValue): java.lang.String = {
+    java.lang.String.valueOf(cv.unwrapped())
+  }
+
   final class $TsCfgValidator {
     private val badPaths =
       scala.collection.mutable.ArrayBuffer[java.lang.String]()

src/main/scala/edu/ie3/osmogrid/exception/PbfReadFailedException.scala

@@ -0,0 +1,12 @@
+/*
+ * © 2021. TU Dortmund University,
+ * Institute of Energy Systems, Energy Efficiency and Energy Economics,
+ * Research group Distribution grid planning and operation
+ */
+
+package edu.ie3.osmogrid.exception
+
+case class PbfReadFailedException(
+    msg: String = "",
+    cause: Throwable = None.orNull
+) extends Exception(msg, cause)

src/main/scala/edu/ie3/osmogrid/guardian/run/RunSupport.scala

@@ -107,7 +107,7 @@ private trait RunSupport {
       outputConfig: OsmoGridConfig.Output,
       ctx: ActorContext[Request]
   ): (
-      ActorRef[InputDataProvider.Request],
+      ActorRef[InputDataProvider.InputDataEvent],
       Option[ActorRef[ResultListener.ResultEvent]]
   ) = (
     spawnInputDataProvider(runId, inputConfig, ctx),
@@ -129,7 +129,7 @@ private trait RunSupport {
       runId: UUID,
       inputConfig: OsmoGridConfig.Input,
       ctx: ActorContext[Request]
-  ): ActorRef[InputDataProvider.Request] = {
+  ): ActorRef[InputDataProvider.InputDataEvent] = {
     ctx.log.info("Starting input data provider ...")
     val inputProvider =
       ctx.spawn(
@@ -191,7 +191,7 @@ private trait RunSupport {
     */
   private def startLvGridGeneration(
       runId: UUID,
-      inputDataProvider: ActorRef[InputDataProvider.Request],
+      inputDataProvider: ActorRef[InputDataProvider.InputDataEvent],
       lvConfig: OsmoGridConfig.Generation.Lv,
       lvCoordinatorAdapter: ActorRef[coordinator.Response],
       ctx: ActorContext[Request]

src/main/scala/edu/ie3/osmogrid/guardian/run/run.scala

@@ -58,7 +58,7 @@ sealed trait Response
 final case class Done(runId: UUID) extends Response
 
 private final case class ChildReferences(
-    inputDataProvider: ActorRef[InputDataProvider.Request],
+    inputDataProvider: ActorRef[InputDataProvider.InputDataEvent],
     resultListener: Option[ActorRef[ResultListener.ResultEvent]],
     additionalResultListeners: Seq[ActorRef[ResultListener.ResultEvent]],
     lvCoordinator: Option[ActorRef[coordinator.Request]]