Package org.sensorhub.api.command

Interface ICommandData

All Known Implementing Classes:
CommandData
public interface ICommandData

Represents command data sent to a control interface or to the input of an on-demand process.

  • Method Details

    • getID

      BigId getID()
      Returns:
      The ID of the command or null if not yet assigned.

    • assignID

      void assignID(BigId id)
      Assign the command ID. This property is immutable once it is set.
      Parameters:
      id -

    • getCommandStreamID

      BigId getCommandStreamID()
      Returns:
      The ID of the command stream that this command is part of.

    • getFoiID

      BigId getFoiID()
      Returns:
      The feature of interest (can be the receiver system itself, a subsystem, or another feature) that the command will have an impact on.

    • hasFoi

      default boolean hasFoi()

    • getSenderID

      String getSenderID()
      Returns:
      The ID of the sender

    • getIssueTime

      Instant getIssueTime()
      Returns:
      Time the command was issued

    • getParams

      DataBlock getParams()
      Returns:
      The command parameters (i.e. command data)