diff --git a/CHANGELOG.md b/CHANGELOG.md index f588d40713..44290c1dd2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -143,6 +143,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Fix some minor issues and findings from inspections [#1019](https://github.com/ie3-institute/simona/issues/1019) - Fix initialisation freezing on empty primary data [#981](https://github.com/ie3-institute/simona/issues/981) - Shallow fetch in CI [#1041](https://github.com/ie3-institute/simona/issues/1041) +- Correct wrong use of term "wall clock time" [#727](https://github.com/ie3-institute/simona/issues/727) ## [3.0.0] - 2023-08-07 diff --git a/src/main/scala/edu/ie3/simona/agent/grid/GridAgentController.scala b/src/main/scala/edu/ie3/simona/agent/grid/GridAgentController.scala index ad0d6c3b07..8d615ec3af 100644 --- a/src/main/scala/edu/ie3/simona/agent/grid/GridAgentController.scala +++ b/src/main/scala/edu/ie3/simona/agent/grid/GridAgentController.scala @@ -455,9 +455,9 @@ class GridAgentController( * @param primaryServiceProxy * Reference to the primary data service proxy * @param simulationStartDate - * First wall clock time in simulation + * The simulation time at which the simulation starts * @param simulationEndDate - * Last wall clock time in simulation + * The simulation time at which the simulation ends * @param resolution * Frequency of power flow calculations * @param requestVoltageDeviationThreshold @@ -512,9 +512,9 @@ class GridAgentController( * @param primaryServiceProxy * Reference to the primary data service proxy * @param simulationStartDate - * First wall clock time in simulation + * The simulation time at which the simulation starts * @param simulationEndDate - * Last wall clock time in simulation + * The simulation time at which the simulation ends * @param resolution * Frequency of power flow calculations * @param requestVoltageDeviationThreshold @@ -571,9 +571,9 @@ class GridAgentController( * @param weatherService * Reference to the weather service actor * @param simulationStartDate - * First wall clock time in simulation + * The simulation time at which the simulation starts * @param simulationEndDate - * Last wall clock time in simulation + * The simulation time at which the simulation ends * @param resolution * Frequency of power flow calculations * @param requestVoltageDeviationThreshold @@ -631,9 +631,9 @@ class GridAgentController( * @param evMovementsService * Reference to the ev movements service actor * @param simulationStartDate - * First wall clock time in simulation + * The simulation time at which the simulation starts * @param simulationEndDate - * Last wall clock time in simulation + * The simulation time at which the simulation ends * @param resolution * Frequency of power flow calculations * @param requestVoltageDeviationThreshold @@ -749,9 +749,9 @@ class GridAgentController( * @param weatherService * Reference to the weather service actor * @param simulationStartDate - * First wall clock time in simulation + * The simulation time at which the simulation starts * @param simulationEndDate - * Last wall clock time in simulation + * The simulation time at which the simulation ends * @param resolution * Frequency of power flow calculations * @param requestVoltageDeviationThreshold @@ -807,9 +807,9 @@ class GridAgentController( * @param primaryServiceProxy * Reference to the primary data service proxy * @param simulationStartDate - * First wall clock time in simulation + * The simulation time at which the simulation starts * @param simulationEndDate - * Last wall clock time in simulation + * The simulation time at which the simulation ends * @param resolution * Frequency of power flow calculations * @param requestVoltageDeviationThreshold diff --git a/src/main/scala/edu/ie3/simona/agent/grid/GridResultsSupport.scala b/src/main/scala/edu/ie3/simona/agent/grid/GridResultsSupport.scala index 59f0248f81..6b8b6520ff 100644 --- a/src/main/scala/edu/ie3/simona/agent/grid/GridResultsSupport.scala +++ b/src/main/scala/edu/ie3/simona/agent/grid/GridResultsSupport.scala @@ -617,7 +617,7 @@ object GridResultsSupport { /** Partial result for the port at the high voltage side * * @param time - * Wall clock time, the result does belong to + * Simulation time of the result * @param input * Unique identifier of the input model * @param currentMagnitude @@ -638,7 +638,7 @@ object GridResultsSupport { /** Partial result for the port at the medium voltage side * * @param time - * Wall clock time, the result does belong to + * Simulation time of the result * @param input * Unique identifier of the input model * @param currentMagnitude @@ -656,7 +656,7 @@ object GridResultsSupport { /** Partial result for the port at the low voltage side * * @param time - * Wall clock time, the result does belong to + * Simulation time of the result * @param input * Unique identifier of the input model * @param currentMagnitude diff --git a/src/main/scala/edu/ie3/simona/agent/participant/ParticipantAgentFundamentals.scala b/src/main/scala/edu/ie3/simona/agent/participant/ParticipantAgentFundamentals.scala index 12b0e9657c..a505696943 100644 --- a/src/main/scala/edu/ie3/simona/agent/participant/ParticipantAgentFundamentals.scala +++ b/src/main/scala/edu/ie3/simona/agent/participant/ParticipantAgentFundamentals.scala @@ -214,9 +214,9 @@ protected trait ParticipantAgentFundamentals[ * @param modelConfig * Configuration for the model * @param simulationStartDate - * Wall clock time of first instant in simulation + * Simulation time of first instant in simulation * @param simulationEndDate - * Wall clock time of last instant in simulation + * Simulation time of last instant in simulation * @return */ def buildModel( diff --git a/src/main/scala/edu/ie3/simona/agent/participant/hp/HpAgentFundamentals.scala b/src/main/scala/edu/ie3/simona/agent/participant/hp/HpAgentFundamentals.scala index 6a9d80cf58..534126b986 100644 --- a/src/main/scala/edu/ie3/simona/agent/participant/hp/HpAgentFundamentals.scala +++ b/src/main/scala/edu/ie3/simona/agent/participant/hp/HpAgentFundamentals.scala @@ -440,9 +440,9 @@ trait HpAgentFundamentals * @param modelConfig * Configuration for the model * @param simulationStartDate - * Wall clock time of first instant in simulation + * Simulation time of first instant in simulation * @param simulationEndDate - * Wall clock time of last instant in simulation + * Simulation time of last instant in simulation * @return */ override def buildModel( diff --git a/src/main/scala/edu/ie3/simona/agent/participant/statedata/BaseStateData.scala b/src/main/scala/edu/ie3/simona/agent/participant/statedata/BaseStateData.scala index b6ebd99841..04650f4763 100644 --- a/src/main/scala/edu/ie3/simona/agent/participant/statedata/BaseStateData.scala +++ b/src/main/scala/edu/ie3/simona/agent/participant/statedata/BaseStateData.scala @@ -43,7 +43,7 @@ trait BaseStateData[+PD <: PrimaryDataWithApparentPower[PD]] */ val startDate: ZonedDateTime - /** The wall clock date, at which the simulation ends + /** The simulation time at which the simulation ends */ val endDate: ZonedDateTime @@ -132,7 +132,7 @@ object BaseStateData { * @param startDate * The date, that fits the tick 0 * @param endDate - * The wall clock date, at which the simulation ends + * The simulation time at which the simulation ends * @param outputConfig * Determines the output behaviour of this model * @param additionalActivationTicks @@ -179,7 +179,7 @@ object BaseStateData { * @param startDate * The date, that fits the tick 0 * @param endDate - * The wall clock date, at which the simulation ends + * The simulation time at which the simulation ends * @param model * Physical model of the load * @param services diff --git a/src/main/scala/edu/ie3/simona/service/primary/PrimaryServiceProxy.scala b/src/main/scala/edu/ie3/simona/service/primary/PrimaryServiceProxy.scala index 838608a514..45de3bae63 100644 --- a/src/main/scala/edu/ie3/simona/service/primary/PrimaryServiceProxy.scala +++ b/src/main/scala/edu/ie3/simona/service/primary/PrimaryServiceProxy.scala @@ -79,7 +79,7 @@ import scala.util.{Failure, Success, Try} * @param scheduler * Reference to the scheduler of the simulation * @param startDateTime - * Wall clock time of the first instant in simulation + * Simulation time of the first instant in simulation */ case class PrimaryServiceProxy( scheduler: ActorRef, @@ -132,7 +132,7 @@ case class PrimaryServiceProxy( * @param primaryConfig * Configuration for the primary source * @param simulationStart - * Wall clock time of first instant in simulation + * Simulation time of first instant in simulation * @return * State data, containing the known model and time series identifiers */ @@ -505,7 +505,7 @@ object PrimaryServiceProxy { * @param primaryConfig * Configuration for the primary source * @param simulationStart - * Wall clock time of the first instant in simulation + * Simulation time of the first instant in simulation */ final case class InitPrimaryServiceProxyStateData( primaryConfig: PrimaryConfig, @@ -519,7 +519,7 @@ object PrimaryServiceProxy { * @param timeSeriesToSourceRef * Mapping from time series identifier to [[SourceRef]] * @param simulationStart - * Wall clock time of the first instant in simulation + * Simulation time of the first instant in simulation * @param primaryConfig * The configuration for the sources * @param mappingSource diff --git a/src/main/scala/edu/ie3/simona/service/primary/PrimaryServiceWorker.scala b/src/main/scala/edu/ie3/simona/service/primary/PrimaryServiceWorker.scala index b20fdd834c..f61974392d 100644 --- a/src/main/scala/edu/ie3/simona/service/primary/PrimaryServiceWorker.scala +++ b/src/main/scala/edu/ie3/simona/service/primary/PrimaryServiceWorker.scala @@ -228,8 +228,8 @@ final case class PrimaryServiceWorker[V <: Value]( Option[Long], ) = { /* Get the information to distribute */ - val wallClockTime = tick.toDateTime(serviceBaseStateData.startDateTime) - serviceBaseStateData.source.getValue(wallClockTime).toScala match { + val simulationTime = tick.toDateTime(serviceBaseStateData.startDateTime) + serviceBaseStateData.source.getValue(simulationTime).toScala match { case Some(value) => processDataAndAnnounce(tick, value, serviceBaseStateData) case None => @@ -237,7 +237,7 @@ final case class PrimaryServiceWorker[V <: Value]( log.warning( s"I expected to get data for tick '{}' ({}), but data is not available", tick, - wallClockTime, + simulationTime, ) updateStateDataAndBuildTriggerMessages(serviceBaseStateData) } @@ -371,7 +371,7 @@ object PrimaryServiceWorker { * @param timeSeriesUuid * Unique identifier of the time series to read * @param simulationStart - * Wall clock time of the beginning of simulation time + * Simulation time of the beginning of simulation time * @param csvSep * Column separation character of the csv files * @param directoryPath @@ -400,7 +400,7 @@ object PrimaryServiceWorker { * @param timeSeriesUuid * Unique identifier of the time series to read * @param simulationStart - * Wall clock time of the beginning of simulation time + * Simulation time of the beginning of simulation time * @param sqlParams * Parameters regarding SQL connection and table selection * @param databaseNamingStrategy @@ -420,7 +420,7 @@ object PrimaryServiceWorker { * @param activationTicks * Linked collection of ticks, in which data is available * @param startDateTime - * Wall clock time of the first instant in simulation + * Simulation time of the first instant in simulation * @param source * Implementation of [[TimeSeriesSource]] to use for actual acquisition of * data diff --git a/src/main/scala/edu/ie3/simona/service/weather/SampleWeatherSource.scala b/src/main/scala/edu/ie3/simona/service/weather/SampleWeatherSource.scala index 0db3ded44c..7f3a7de525 100644 --- a/src/main/scala/edu/ie3/simona/service/weather/SampleWeatherSource.scala +++ b/src/main/scala/edu/ie3/simona/service/weather/SampleWeatherSource.scala @@ -65,15 +65,15 @@ final class SampleWeatherSource( private def getWeather( tick: Long ): WeatherData = { - val wallClockTime = tick.toDateTime - val month = wallClockTime.get(MONTH_OF_YEAR) - 1 - val hour = wallClockTime.get(HOUR_OF_DAY) + val simulationTime = tick.toDateTime + val month = simulationTime.get(MONTH_OF_YEAR) - 1 + val hour = simulationTime.get(HOUR_OF_DAY) val year = if ( - wallClockTime.get(YEAR) != 2011 && !(wallClockTime + simulationTime.get(YEAR) != 2011 && !(simulationTime .get(YEAR) == 2012 && month == 0) ) 2011 - else wallClockTime.get(YEAR) + else simulationTime.get(YEAR) val index = (((year - 2011) * 288) + (month * 24) + hour) + 1 WeatherData( WattsPerSquareMeter( diff --git a/src/test/scala/edu/ie3/simona/agent/participant/ParticipantAgentMock.scala b/src/test/scala/edu/ie3/simona/agent/participant/ParticipantAgentMock.scala index c3c77e2292..3e17e76ccb 100644 --- a/src/test/scala/edu/ie3/simona/agent/participant/ParticipantAgentMock.scala +++ b/src/test/scala/edu/ie3/simona/agent/participant/ParticipantAgentMock.scala @@ -260,9 +260,9 @@ class ParticipantAgentMock( * @param modelConfig * Configuration for the model * @param simulationStartDate - * Wall clock time of first instant in simulation + * The simulation time at which the simulation starts * @param simulationEndDate - * Wall clock time of last instant in simulation + * The simulation time at which the simulation ends * @return */ override def buildModel(