Package org.yamcs.xtce

Class SequenceContainer

java.lang.Object
org.yamcs.xtce.NameDescription
org.yamcs.xtce.Container
org.yamcs.xtce.SequenceContainer
All Implemented Interfaces:
Serializable
public class SequenceContainer extends Container
A list of raw parameters, parameter segments, stream segments, containers, or container segments. Sequence containers may inherit from other sequence containers; when they do, the sequence in the parent SequenceContainer is 'inherited' and if the location of entries in the child sequence is not specified, it is assumed to start where the parent sequence ended. Parent sequence containers may be marked as "abstract". The idle pattern is part of any unallocated space in the Container.
See Also:

  • Constructor Details

    • SequenceContainer

      public SequenceContainer(String name)

  • Method Details

    • addAncillaryData

      public void addAncillaryData(AncillaryData data)
      Description copied from class: NameDescription
      Stores the given ancillary data. If an entry already existed for the applicable name, that entry will be overridden.
      Overrides:
      addAncillaryData in class NameDescription

    • setAncillaryData

      public void setAncillaryData(List<AncillaryData> ancillaryData)
      Overrides:
      setAncillaryData in class NameDescription

    • getBaseContainer

      public SequenceContainer getBaseContainer()
      Overrides:
      getBaseContainer in class Container

    • setBaseContainer

      public void setBaseContainer(Container baseContainer)
      Overrides:
      setBaseContainer in class Container

    • getRestrictionCriteria

      public MatchCriteria getRestrictionCriteria()
      Description copied from class: Container
      restriction criteria related to inheritance from the base container
      Overrides:
      getRestrictionCriteria in class Container
      Returns:

    • addEntry

      public void addEntry(SequenceEntry entry)
      Add single entry to list of entries
      Specified by:
      addEntry in class Container
      Parameters:
      entry - Entry to be added

    • insertEntry

      public void insertEntry(int idx, SequenceEntry entry)
      Insert the given entry in position idx. Shift all the subsequent entries to the right.
      Parameters:
      idx -
      entry -

    • setEntryList

      public void setEntryList(List<SequenceEntry> entryList)

    • getEntryList

      public List<SequenceEntry> getEntryList()
      Returns the list of the entries in the sequence container. The list is unmodifiable.
      Specified by:
      getEntryList in class Container

    • useAsArchivePartition

      public boolean useAsArchivePartition()

    • useAsArchivePartition

      public void useAsArchivePartition(boolean useAsArchivePartition)
      If set to true, the XtceTmRecorder will set the qualified name of this container as the "pname" (packet name) column in the tm table. The packet will be then visible in the front page of Yamcs web as well as in the Archive overview.

      If the container has a child that matches the packet, and the child also has this flag set, then the name of the child will be used instead (e.g. the name of the most specific packet will be used).

      If no container having this flag matches a packet, the name of the root container will be used (even if it does not have the flag set).

      Parameters:
      useAsArchivePartition -

    • print

      public void print(PrintStream out)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • isAutoPartition

      public boolean isAutoPartition()

    • setAutoPartition

      public void setAutoPartition(boolean autoPartition)