Package org.sensorhub.api.command

Interface ICommandStreamInfo

All Superinterfaces:
IResource
All Known Implementing Classes:
CommandStreamInfo
public interface ICommandStreamInfo extends IResource

Interface for command stream descriptors

  • Method Details

    • getSystemID

      FeatureId getSystemID()
      Returns:
      The identifier of the system that exposes this command stream

    • getControlInputName

      String getControlInputName()
      Returns:
      The name of the system control input that receives commands from this stream

    • getRecordStructure

      DataComponent getRecordStructure()
      Returns:
      The structure of the command parameters

    • getRecordEncoding

      default DataEncoding getRecordEncoding()
      Returns:
      The recommended encoding for the command parameters

    • getValidTime

      TimeExtent getValidTime()
      Returns:
      The time of validity of this command stream. This corresponds to the time during which the corresponding control input actually existed.

    • getIssueTimeRange

      TimeExtent getIssueTimeRange()
      Returns:
      The range of issue times of commands that are part of this command stream, or null if no commands have been recorded yet.

    • getExecutionTimeRange

      TimeExtent getExecutionTimeRange()
      Returns:
      The range of actuation times of commands that are part of this command stream, or null if no commands have been recorded yet.

    • hasResult

      boolean hasResult()
      Returns:
      True if this command channel generates command results, false otherwise. Note that this returns true whether results are generated inline or not.

    • hasInlineResult

      default boolean hasInlineResult()
      Returns:
      True if this command channel generates inline command results, false otherwise

    • getResultStructure

      DataComponent getResultStructure()
      Returns:
      The structure of the inline command result data, or null if no inline result is generated by this command channel.

    • getResultEncoding

      DataEncoding getResultEncoding()
      Returns:
      The recommended encoding for the inline command result data, or null if no inline result is generated by this command channel.

    • getFullName

      default String getFullName()
      Returns:
      The full name of the controlstream combining the system UID and the input name