Package org.eclipse.tracecompass.incubator.callstack.core.base

Interface ICallStackElement

All Superinterfaces:
ITree
All Known Implementing Classes:
CallStackElement
public interface ICallStackElement extends ITree
Interface that classes representing a single element in the callstack hierarchy must implement. Typically, a ICallStackElement will be associated with a ICallStackGroupDescriptor. It will have children that will correspond to the next group in the hierarchy. The actual data of the various available analyses containing those elements will be available only at the leaf elements.
Author:
Geneviève Bastien

  • Method Details

    • getChildrenElements

      Collection<ICallStackElement> getChildrenElements()
      Get the elements at the next level of the callstack hierarchy from this element FIXME: Can this method be completely replace by ITree.getChildren()?
      Returns:
      The list of children elements in the hierarchy

    • getGroup

      IWeightedTreeGroupDescriptor getGroup()
      Get the corresponding group descriptor FIXME: Remove this method?
      Returns:
      The group descriptor of this element

    • getNextGroup

      @Nullable IWeightedTreeGroupDescriptor getNextGroup()
      Get the next group descriptor FIXME: Remove this method?
      Returns:
      The next group descriptor, or null if this is a leaf element

    • getSymbolKeyAt

      int getSymbolKeyAt(long time)
      Get the key for symbol resolution at a given time
      Parameters:
      time - The time at which to get the symbol key
      Returns:
      The symbol key at time

    • setSymbolKeyElement

      void setSymbolKeyElement(ICallStackElement element)
      Set the symbol key element to use for this hierarchy
      Parameters:
      element - The symbol key element

    • isSymbolKeyElement

      boolean isSymbolKeyElement()
      Return whether this element is the symbol key element
      Returns:
      Whether the element is the symbol key

    • getParentElement

      @Nullable ICallStackElement getParentElement()
      Get the parent element, or null if this element corresponds to the first group of the hierarchy FIXME: Can this method be completely replace by ITree.getParent()?
      Returns:
      The parent element

    • isLeaf

      boolean isLeaf()
      Get whether this element is a leaf element in the callstack hierarchy. Leaf elements are expected to contain the proper analysis data.
      Returns:
      Whether this element is a leaf, ie contains analysis data or not