Package org.sensorhub.api.command

Class CommandStreamInfo

java.lang.Object
org.sensorhub.api.command.CommandStreamInfo
All Implemented Interfaces:
ICommandStreamInfo, IResource
public class CommandStreamInfo extends Object implements ICommandStreamInfo

Immutable object containing information about a command stream/interface.

  • Field Details

  • Constructor Details

    • CommandStreamInfo

      public CommandStreamInfo()

  • Method Details

    • getSystemID

      public FeatureId getSystemID()
      Specified by:
      getSystemID in interface ICommandStreamInfo
      Returns:
      The identifier of the system that exposes this command stream

    • getControlInputName

      public String getControlInputName()
      Specified by:
      getControlInputName in interface ICommandStreamInfo
      Returns:
      The name of the system control input that receives commands from this stream

    • getName

      public String getName()
      Specified by:
      getName in interface IResource
      Returns:
      The resource name

    • getDescription

      public String getDescription()
      Specified by:
      getDescription in interface IResource
      Returns:
      A short description of the resource

    • getRecordStructure

      public DataComponent getRecordStructure()
      Specified by:
      getRecordStructure in interface ICommandStreamInfo
      Returns:
      The structure of the command parameters

    • getRecordEncoding

      public DataEncoding getRecordEncoding()
      Specified by:
      getRecordEncoding in interface ICommandStreamInfo
      Returns:
      The recommended encoding for the command parameters

    • getValidTime

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

    • getExecutionTimeRange

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

    • getIssueTimeRange

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

    • getResultStructure

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

    • getResultEncoding

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

    • hasResult

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