Module org.yamcs.core
Package org.yamcs.container

Interface ContainerProvider

All Superinterfaces:
com.google.common.util.concurrent.Service
All Known Implementing Classes:
XtceTmProcessor
public interface ContainerProvider extends com.google.common.util.concurrent.Service
Interface implemented by all the classes that can provide containers to a ContainerListener

  • Nested Class Summary

    Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

    com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canProvideContainer(org.yamcs.protobuf.Yamcs.NamedObjectId containerId)
    Returns whether or not a given container can be provided by this provider
    org.yamcs.xtce.Container
    getContainer(org.yamcs.protobuf.Yamcs.NamedObjectId containerId)
    Returns the containerDefinition corresponding to the itemId
    void
    setContainerListener(ContainerListener containerListener)
     
    void
    startProviding(org.yamcs.xtce.SequenceContainer container)
     
    void
    startProvidingAllContainers()
    Start providing all known containers
    void
    stopProviding(org.yamcs.xtce.SequenceContainer container)
     

    Methods inherited from interface com.google.common.util.concurrent.Service

    addListener, awaitRunning, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, awaitTerminated, failureCause, isRunning, startAsync, state, stopAsync

  • Method Details

    • setContainerListener

      void setContainerListener(ContainerListener containerListener)

    • startProviding

      void startProviding(org.yamcs.xtce.SequenceContainer container)

    • stopProviding

      void stopProviding(org.yamcs.xtce.SequenceContainer container)

    • startProvidingAllContainers

      void startProvidingAllContainers()
      Start providing all known containers

    • canProvideContainer

      boolean canProvideContainer(org.yamcs.protobuf.Yamcs.NamedObjectId containerId)
      Returns whether or not a given container can be provided by this provider

    • getContainer

      org.yamcs.xtce.Container getContainer(org.yamcs.protobuf.Yamcs.NamedObjectId containerId) throws InvalidIdentification
      Returns the containerDefinition corresponding to the itemId
      Throws:
      InvalidIdentification