Serialized Form

  • Package org.sim0mq

  • Package org.sim0mq.message

    • Class org.sim0mq.message.Sim0MQMessage

      class Sim0MQMessage extends Object implements Serializable
      serialVersionUID:
      20191017L

      • Serialized Fields

        • bigEndian
          boolean bigEndian
          Indicates whether this message using little endian or big endian encoding. Big endian is encoded as true, and little endian as false.
        • federationId
          Object federationId
          the federation id can be provided in different types. Examples are two 64-bit longs indicating a UUID, or a String with a UUID number, a String with meaningful identification, or a byte, short or int with a simulation run number.
        • messageId
          Object messageId
          The unique message id is meant to be used in, e.g., a callback that the message has been received correctly. Within this implementation, the messageId is unique for the sender, so not globally within the federation.
        • messageTypeId
          Object messageTypeId
          Message type ids can be defined per type of simulation, and can be provided in different types. Examples are a String with a meaningful identification, or a short or an int with a message type number.
        • payload
          Object[] payload
          Payload as an Object array.
        • receiverId
          Object receiverId
          The receiver id can be used to check whether the message is meant for us, or should be discarded (or an error can be sent if we receive a message not meant for us).
        • senderId
          Object senderId
          The sender id can be used to send back a message to the sender at some later time.

    • Class org.sim0mq.message.Sim0MQReply

      class Sim0MQReply extends Sim0MQMessage implements Serializable
      serialVersionUID:
      20170422L

      • Serialized Fields

        • replyToId
          Object replyToId
          The unique message id (Frame 5) of the sender for which this is the reply.

  • Package org.sim0mq.message.federatestarter

  • Package org.sim0mq.message.federationmanager

    • Class org.sim0mq.message.federationmanager.FM1StartFederateMessage

      class FM1StartFederateMessage extends Sim0MQMessage implements Serializable
      serialVersionUID:
      20170422L

      • Serialized Fields

        • argsAfter
          String argsAfter
          Arguments that the software or the model needs, after the model file path and name; e.g. arguments for the model itself to run like a data file or a data location . This String can be empty (0 characters), but usually we would want to send the port number(s) or a location where the model can find it as well as the name under which the model was registered.
        • argsBefore
          String argsBefore
          Arguments that the software needs, before the model file path and name; e.g. "–Xmx2G -jar" in case of a Java model. This String can be empty (0 characters).
        • deleteStderr
          boolean deleteStderr
          Whether to delete the redirected stderr after running or not (in case it is stored in a different place than the working directory).
        • deleteStdout
          boolean deleteStdout
          Whether to delete the redirected stdout after running or not (in case it is stored in a different place than the working directory).
        • deleteWorkingDirectory
          boolean deleteWorkingDirectory
          Whether to delete the working directory after the run of the model or not.
        • instanceId
          Object instanceId
          Id to identify the callback to know which model instance has been started, e.g. "IDVV.14". The model instance will use this as its sender id.
        • modelPath
          String modelPath
          The actual path on the target computer where the model resides, including the model that needs to be run. This String cannot be empty.
        • redirectStderr
          String redirectStderr
          Place to send the error messages to that the model normally displays on the console. If this is not redirected, the memory buffer for the stderr might get full, and the model might stop as a result. On Linux systems, this often redirected to /dev/null. On Windows systems, this can e.g., be redirected to a file "err.txt" in the current working directory. For now, it has to be a path name (including /dev/null as being acceptable). If no full path is given, the filename is relative to the working directory.
        • redirectStdin
          String redirectStdin
          Place to get user input from in case a model asks for it (it shouldn't, by the way).
        • redirectStdout
          String redirectStdout
          Place to send the output to that the model normally displays on the console. If this is not redirected, the memory buffer for the stdout might get full, and the model might stop as a result. On Linux systems, this often redirected to /dev/null. On Windows systems, this can e.g., be redirected to a file "out.txt" in the current working directory. For now, it has to be a path name (including /dev/null as being acceptable). If no full path is given, the filename is relative to the working directory.
        • softwareCode
          String softwareCode
          Code for the software to run, will be looked up in a table on the local computer to determine the path to start the software on that computer. Example: "java". If the softwarePath is defined, softwareCode can be an empty String (0 characters).
        • workingDirectory
          String workingDirectory
          Full path on the target computer that will be used as the working directory. Some files may be temporarily stored there. If the working directory does not exist yet, it will be created.

    • Class org.sim0mq.message.federationmanager.FM2SimRunControlMessage

      class FM2SimRunControlMessage extends Sim0MQMessage implements Serializable
      serialVersionUID:
      20170424L

      • Serialized Fields

        • numberRandomStreams
          int numberRandomStreams
          Number of random streams that follow.
        • numberReplications
          int numberReplications
          Number of replications for stochastic uncertainties in the model.
        • offsetTime
          NumberTime offsetTime
          Offset of the time (e.g., a model time of 0 is the year 2016, or 1-1-2015). The type is any numeric type (1-5) or Float or Double with Unit (25, 26) of type Time (26).
        • runDuration
          NumberDuration runDuration
          Duration of the run of a single replication, including the warmup duration, if present. The type is any numeric type (1-5) or Float or Double with Unit (25, 26) of type Duration (25).
        • speed
          double speed
          Speed as the number of times real-time the model should run; Double.INFINITY means as fast as possible.
        • streamMap
          Map<Object,Long> streamMap
          Random streams and seeds.
        • warmupDuration
          NumberDuration warmupDuration
          Warmup duration of the model in durationunits that the model uses. The type is any numeric type (1-5) or Float or Double with Unit (25, 26) of type Duration (25).

    • Class org.sim0mq.message.federationmanager.FM3SetParameterMessage

      class FM3SetParameterMessage extends Sim0MQMessage implements Serializable
      serialVersionUID:
      20190712L

      • Serialized Fields

        • parameterName
          String parameterName
          Name of the parameter to be set. Links to a parameter name in the model.
        • parameterValue
          Object parameterValue
          Value of the parameter to be set; can be any of the legal types in djutils-serialization.

    • Class org.sim0mq.message.federationmanager.FM4SimStartMessage

      class FM4SimStartMessage extends Sim0MQMessage implements Serializable
      serialVersionUID:
      20190712L

    • Class org.sim0mq.message.federationmanager.FM5RequestStatus

      class FM5RequestStatus extends Sim0MQMessage implements Serializable
      serialVersionUID:
      20190712L

    • Class org.sim0mq.message.federationmanager.FM6RequestStatisticsMessage

      class FM6RequestStatisticsMessage extends Sim0MQMessage implements Serializable
      serialVersionUID:
      20190712L

      • Serialized Fields

        • variableName
          String variableName
          The name of the output variable whose value is requested. That should match with the name in the model. For a tallied variable, several statistics are possible, e.g., average, variance, minimum, maximum, time series, etc. The name should clearly indicate what the Model Controller expects and what the model should produce.

    • Class org.sim0mq.message.federationmanager.FM7SimResetMessage

      class FM7SimResetMessage extends Sim0MQMessage implements Serializable
      serialVersionUID:
      20190712L

    • Class org.sim0mq.message.federationmanager.FM8KillFederateMessage

      class FM8KillFederateMessage extends Sim0MQMessage implements Serializable
      serialVersionUID:
      20190712L

      • Serialized Fields

        • instanceId
          Object instanceId
          Id to identify the federate instance that has to be killed.

    • Class org.sim0mq.message.federationmanager.FM9KillAllMessage

      class FM9KillAllMessage extends Sim0MQMessage implements Serializable
      serialVersionUID:
      20190712L

  • Package org.sim0mq.message.heartbeat

  • Package org.sim0mq.message.modelcontroller

    • Class org.sim0mq.message.modelcontroller.MC1StatusMessage

      class MC1StatusMessage extends Sim0MQReply implements Serializable
      serialVersionUID:
      20170422L

      • Serialized Fields

        • error
          String error
          Optional. If there is an error, the error message is sent as well. Otherwise this field is an empty string.
        • status
          String status
          A string that refers to the model status. Four options: "started", "running", "ended", "error".

    • Class org.sim0mq.message.modelcontroller.MC2AckNakMessage

      class MC2AckNakMessage extends Sim0MQReply implements Serializable
      serialVersionUID:
      20190712L

      • Serialized Fields

        • error
          String error
          Optional. If there is an error, the error message is sent as well. Otherwise this field is an empty string.
        • status
          boolean status
          A string that refers to the model status. Four options: "started", "running", "ended", "error".

    • Class org.sim0mq.message.modelcontroller.MC3StatisticsMessage

      class MC3StatisticsMessage extends Sim0MQMessage implements Serializable
      serialVersionUID:
      20170422L

      • Serialized Fields

        • variableName
          String variableName
          The name of the output variable whose value is requested. That should match with the name in the model.
        • variableValue
          Object variableValue
          If variableType is scalar, the data type is e.g., an integer, float etc. and the value generated in the model. If variableType is time series, the data type is an ‘array’ (type 11-16 or 27/28) or a time series (type 31/32).

    • Class org.sim0mq.message.modelcontroller.MC4StatisticsErrorMessage

      class MC4StatisticsErrorMessage extends Sim0MQMessage implements Serializable
      serialVersionUID:
      20190712L

      • Serialized Fields

        • error
          String error
          Error retrieving the model output value.
        • variableName
          String variableName
          The name of the output variable whose value is requested. That should match with the name in the model.

  • Package org.sim0mq.message.types