Package energy.eddie.regionconnector.simulation.engine

Record Class SimulationContext

java.lang.Object
java.lang.Record
energy.eddie.regionconnector.simulation.engine.SimulationContext
Record Components:
documentStreams - the streams that a Step can emit to
permissionId - provided by the entity executing the test simulation
connectionId - provided by the entity executing the test simulation
dataNeedId - provided by the entity executing the test simulation, must be a valid data need ID
public record SimulationContext(DocumentStreams documentStreams, String permissionId, String connectionId, String dataNeedId) extends Record
The simulation context contains information, which is not available during the Model creation, but during the runtime phase. Can be thought of similar to command line arguments.

  • Constructor Details

    • SimulationContext

      public SimulationContext(DocumentStreams documentStreams, String permissionId, String connectionId, String dataNeedId)
      Creates an instance of a SimulationContext record class.
      Parameters:
      documentStreams - the value for the documentStreams record component
      permissionId - the value for the permissionId record component
      connectionId - the value for the connectionId record component
      dataNeedId - the value for the dataNeedId record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • documentStreams

      public DocumentStreams documentStreams()
      Returns the value of the documentStreams record component.
      Returns:
      the value of the documentStreams record component

    • permissionId

      public String permissionId()
      Returns the value of the permissionId record component.
      Returns:
      the value of the permissionId record component

    • connectionId

      public String connectionId()
      Returns the value of the connectionId record component.
      Returns:
      the value of the connectionId record component

    • dataNeedId

      public String dataNeedId()
      Returns the value of the dataNeedId record component.
      Returns:
      the value of the dataNeedId record component