Package de.toem.flux

Class Flx.Trace

  • Enclosing class:
    Flx
    public static class Flx.Trace
extends Flx.TraceItem
    Trace class contains the main API for generatinf traces.

    • Constructor Summary

      Constructors 
      Constructor Description
      Trace​(int traceId, int maxItemId, int maxEntrySize, boolean multiOpen, Flx.Buffer buffer)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int addHead​(java.lang.String name, java.lang.String description)
      Writes a head entry.
      int addHeadDerived​(java.lang.String format4, java.lang.String name, java.lang.String description)
      Writes a head entry for a derived format.
      int addModeHead​(java.lang.String name, java.lang.String description, byte mode)
      Writes a head entry.
      int addScatteredSignal​(int itemId, int parentId, java.lang.String name, java.lang.String description, int signalType, java.lang.String signalDescriptor, int scatteredFrom, int scatteredTo)
      Writes an item entry for scattered signals.
      int addScatteredSignalReference​(int referenceId, int parentId, java.lang.String name, java.lang.String description, int scatteredFrom, int scatteredTo)
      Writes an item entry for a scattered signal reference.
      int addScope​(int itemId, int parentId, java.lang.String name, java.lang.String description)
      Writes an item entry for a scope.
      int addSignal​(int itemId, int parentId, java.lang.String name, java.lang.String description, int signalType, java.lang.String signalDescriptor)
      Writes a signal item entry.
      int addSignalReference​(int referenceId, int parentId, java.lang.String name, java.lang.String description)
      Writes an item entry for a signal reference.
      int addSignals​(int itemIdFrom, int itemIdTo, int parentId, java.lang.String name, java.lang.String description, int signalType, java.lang.String signalDescriptor)
      Writes an item entry for multiple signals.
      int close​(int itemId, long end)
      Closes a sequence.
      Flx.MemberValue createMember​(int memberId, java.lang.String label, int memberType, java.lang.String memberDescriptor)  
      Flx.MemberValue[] createMembers​(int count)  
      Flx.MemberValue createSubMember​(int memberId, int parentId, java.lang.String label, int memberType, java.lang.String memberDescriptor)  
      int flush()  
      long getCurrent​(int itemId)
      Returns the currentdomain position.
      boolean isOpen​(int itemId)
      Checks the open state of an item.
      boolean isScope​(int itemId)
      Tests the item type.
      boolean isSignal​(int itemId)
      Tests the item type.
      int open​(int itemId, java.lang.String domainBase, long start, long rate)
      Opens a new sequence.
      int setBuffer​(Flx.Buffer buffer)  
      int setDefaultOpenDomain​(java.lang.String domainBase)
      Sets the default domain.
      int writeArrayDef​(int itemId, int index, java.lang.String label, java.lang.String memberDescriptor)
      Writes an entry for an array definition.
      int writeBinaryAt​(int itemId, int tag, long domainPosition, boolean isDelta, byte[] value)
      Writes a binary sample.
      int writeCurrent​(int itemId, long domainPosition)
      Sets the current domain position.
      int writeEnumDef​(int itemId, int enumeration, java.lang.String label, int value)
      Writes an entry for a enumeration.
      int writeEventArrayAt​(int itemId, int tag, long domainPosition, boolean isDelta, int[] value, boolean dynamicSize)
      Writes an event array sample.
      int writeEventAt​(int itemId, int tag, long domainPosition, boolean isDelta, int value)
      Writes an event sample.
      int writeFloatArrayAt​(int itemId, int tag, long domainPosition, boolean isDelta, java.lang.Object value, boolean dynamicSize)
      Writes a float array sample.
      int writeFloatAt​(int itemId, int tag, long domainPosition, boolean isDelta, java.lang.Number value)
      Writes a float sample.
      int writeIntArrayAt​(int itemId, int tag, long domainPosition, boolean isDelta, java.lang.Object value, boolean dynamicSize)
      Writes an integer array sample.
      int writeIntAt​(int itemId, int tag, long domainPosition, boolean isDelta, java.lang.Number value)
      Writes an integer sample.
      int writeLabel​(int itemId, int style)
      Writes a label entry.
      int writeLogicStatesAt​(int itemId, int tag, long domainPosition, boolean isDelta, int precedingStates, byte[] value, int totalBitWidth)
      Writes a logic sample using an array of states.
      int writeLogicTextAt​(int itemId, int tag, long domainPosition, boolean isDelta, int precedingStates, java.lang.String value, int totalBitWidth)
      Writes a logic sample using a text.
      int writeMemberDef​(int itemId, int memberId, int parentId, java.lang.String label, int memberType, java.lang.String memberDescriptor)
      Writes an entry for a member definition.
      int writeMemberDefs​(int itemId, Flx.MemberValue[] members)
      Writes multiple entries for member definition.
      int writeMembersAt​(int itemId, int tag, long domainPosition, boolean isDelta, Flx.MemberValue[] value)
      Writes a struct sample.
      int writeNoneAt​(int itemId, int tag, long domainPosition, boolean isDelta)
      Writes a 'none' samples.
      int writeRelation​(int itemId, int type, int target, int style, long ldeltaOrPosition, int targetBase)
      Writes an relation entry.
      int writeTextArrayAt​(int itemId, int tag, long domainPosition, boolean isDelta, java.lang.String[] value, boolean dynamicSize)
      Writes an text array sample.
      int writeTextAt​(int itemId, int tag, long domainPosition, boolean isDelta, java.lang.String value)
      Writes a text sample.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Trace

        public Trace​(int traceId,
             int maxItemId,
             int maxEntrySize,
             boolean multiOpen,
             Flx.Buffer buffer)

    • Method Detail

      • setBuffer

        public int setBuffer​(Flx.Buffer buffer)

      • addHead

        public int addHead​(java.lang.String name,
                   java.lang.String description)
        Writes a head entry. The head entry contains information data about the trace and is also used as file identification.
        Parameters:
        name - : The name of the item
        description - : Descriptive text for this item or 0
        Returns:
        Returns Flx.OK is succeeded, or Flx.ERROR_ in the error case

      • addModeHead

        public int addModeHead​(java.lang.String name,
                       java.lang.String description,
                       byte mode)
        Writes a head entry. The head entry contains information data about the trace and is also used as file identification.
        Parameters:
        name - : The name of the item
        description - : Descriptive text for this item or 0
        mode - : Mode parameter 0:normal 1: sync
        Returns:
        Returns Flx.OK is succeeded, or Flx.ERROR_ in the error case

      • addHeadDerived

        public int addHeadDerived​(java.lang.String format4,
                          java.lang.String name,
                          java.lang.String description)
        Writes a head entry for a derived format. The head entry contains information data about the trace and is also used as file identification.
        Parameters:
        format4 - : Format identification (4 characters)
        name - : The name of the item
        description - : Descriptive text for this item or 0
        Returns:
        Returns Flx.OK is succeeded, or Flx.ERROR_ in the error case

      • addScope

        public int addScope​(int itemId,
                    int parentId,
                    java.lang.String name,
                    java.lang.String description)
        Writes an item entry for a scope.
        Parameters:
        itemId - : The item id for this new item. The id must be unique for this trace and in the range of 1..maxItemId
        parentId - : Defines the parent of this new item (or 0 for the root item)
        name - : The name of the item
        description - : Descriptive text for this item or 0
        Returns:
        Returns Flx.OK is succeeded, or Flx.ERROR_ in the error case

      • addSignal

        public int addSignal​(int itemId,
                     int parentId,
                     java.lang.String name,
                     java.lang.String description,
                     int signalType,
                     java.lang.String signalDescriptor)
        Writes a signal item entry.
        Parameters:
        itemId - : The item id for this new item. The id must be unique for this trace and in the range of 1..maxItemId
        parentId - : Defines the parent of this new item (or 0 for the root item) : Defines the parent of this new item (or 0 for the root item)
        name - : The name of the item
        description - : Descriptive text for this item or 0
        signalType - : The type of this new signal (Flx.TYPE_...)
        signalDescriptor - : Extended definition of the signal type, usually set to 0 for default
        Returns:
        Returns Flx.OK is succeeded, or Flx.ERROR_ in the error case

      • addSignals

        public int addSignals​(int itemIdFrom,
                      int itemIdTo,
                      int parentId,
                      java.lang.String name,
                      java.lang.String description,
                      int signalType,
                      java.lang.String signalDescriptor)
        Writes an item entry for multiple signals.
        Parameters:
        itemIdFrom - : The first item id for this new item set. The id must be unique for this trace and in the range of 1..maxItemId
        itemIdTo - : The last item id for this new item set. The id must be unique for this trace and in the range of 1..maxItemId
        parentId - : Defines the parent of this new item (or 0 for the root item)
        name - : The name of the item
        description - : Descriptive text for this item or 0
        signalType - : The type of this new signal (Flx.TYPE_...)
        signalDescriptor - : Extended definition of the signal type, usually set to 0 for default
        Returns:
        Returns Flx.OK is succeeded, or Flx.ERROR_ in the error case

      • addSignalReference

        public int addSignalReference​(int referenceId,
                              int parentId,
                              java.lang.String name,
                              java.lang.String description)
        Writes an item entry for a signal reference.
        Parameters:
        referenceId -
        parentId - : Defines the parent of this new item (or 0 for the root item)
        name - : The name of the item
        description - : Descriptive text for this item or 0
        Returns:
        Returns Flx.OK is succeeded, or Flx.ERROR_ in the error case

      • addScatteredSignal

        public int addScatteredSignal​(int itemId,
                              int parentId,
                              java.lang.String name,
                              java.lang.String description,
                              int signalType,
                              java.lang.String signalDescriptor,
                              int scatteredFrom,
                              int scatteredTo)
        Writes an item entry for scattered signals.
        Parameters:
        itemId - : The item id for this new item. The id must be unique for this trace and in the range of 1..maxItemId
        parentId - : Defines the parent of this new item (or 0 for the root item)
        name - : The name of the item
        description - : Descriptive text for this item or 0
        signalType - : The type of this new signal (Flx.TYPE_...)
        signalDescriptor - : Extended definition of the signal type, usually set to 0 for default
        scatteredFrom - : Scattered from (e.g. bit position 0)
        scatteredTo - : Scattered to (e.g. bit position 4)
        Returns:
        Returns Flx.OK is succeeded, or Flx.ERROR_ in the error case

      • addScatteredSignalReference

        public int addScatteredSignalReference​(int referenceId,
                                       int parentId,
                                       java.lang.String name,
                                       java.lang.String description,
                                       int scatteredFrom,
                                       int scatteredTo)
        Writes an item entry for a scattered signal reference.
        Parameters:
        referenceId -
        parentId - : Defines the parent of this new item (or 0 for the root item)
        name - : The name of the item
        description - : Descriptive text for this item or 0
        scatteredFrom - : Scattered from (e.g. bit position 0)
        scatteredTo - : Scattered to (e.g. bit position 4)
        Returns:
        Returns Flx.OK is succeeded, or Flx.ERROR_ in the error case

      • isSignal

        public boolean isSignal​(int itemId)
        Tests the item type.
        Parameters:
        itemId - : The item id of the referenced item. The id must be unique for this trace and in the range of 1..maxItemId
        Returns:
        Returns true if the item is a signal

      • isScope

        public boolean isScope​(int itemId)
        Tests the item type.
        Parameters:
        itemId - : The item id of the referenced item. The id must be unique for this trace and in the range of 1..maxItemId
        Returns:
        Returns true if the item is a scope

      • createMember

        public Flx.MemberValue createMember​(int memberId,
                                    java.lang.String label,
                                    int memberType,
                                    java.lang.String memberDescriptor)

      • createSubMember

        public Flx.MemberValue createSubMember​(int memberId,
                                       int parentId,
                                       java.lang.String label,
                                       int memberType,
                                       java.lang.String memberDescriptor)

      • open

        public int open​(int itemId,
                java.lang.String domainBase,
                long start,
                long rate)
        Opens a new sequence. This opens the sequence for the references item and all items below (children,...).
        Parameters:
        itemId - : The item id of the referenced item to be opened (1..maxItemId or 0 for the root item)
        domainBase - : Domain base (e.g. ns, us, Hz,..), or 0 for default.
        start - : Domain position as a multiple of its domain base (e.g. domain base=1ms, units = 100, -> domain value = 100ms)
        rate - : Domain rate as a multiple of its domain base
        Returns:
        Returns Flx.OK is succeeded, or Flx.ERROR_ in the error case

      • close

        public int close​(int itemId,
                 long end)
        Closes a sequence. This closes the sequence for the references item and all items below (children,...).
        Parameters:
        itemId - : The item id of the referenced item to be opened (1..maxItemId or 0 for the root item)
        end - : Domain position as a multiple of its domain base (e.g. domain base=1ms , units = 100, -> domain value = 100ms).
        Returns:
        Returns Flx.OK is succeeded, or Flx.ERROR_ in the error case

      • setDefaultOpenDomain

        public int setDefaultOpenDomain​(java.lang.String domainBase)
        Sets the default domain. This is used when using the flxOpen with domain=0
        Parameters:
        domainBase - : Domain base (e.g. ns, us, Hz,..), or 0 for default.
        Returns:
        Returns Flx.OK is succeeded, or Flx.ERROR_ in the error case

      • isOpen

        public boolean isOpen​(int itemId)
        Checks the open state of an item.
        Parameters:
        itemId - : The item id of the referenced item to be opened (1..maxItemId or 0 for the root item)
        Returns:
        Returns true if a sequence has been opened for the given item.

      • getCurrent

        public long getCurrent​(int itemId)
        Returns the currentdomain position.
        Parameters:
        itemId - : The item id of the referenced item to be opened (1..maxItemId or 0 for the root item)
        Returns:
        Returns the current domain position, or 0 if not open

      • writeEnumDef

        public int writeEnumDef​(int itemId,
                        int enumeration,
                        java.lang.String label,
                        int value)
        Writes an entry for a enumeration.
        Parameters:
        itemId - : The item id of the referenced item. The id must be unique for this trace and in the range of 1..maxItemId
        enumeration - : Define the enumeration domain (e.g. Flx.ENUM_GLOBAL, Flx.ENUM_MEMBER_0, ..)
        label - : The textual representation of the enum.
        value - : The value : The integer value of the enum. This value must be unique for one enumeration domain.
        Returns:
        Returns Flx.OK is succeeded, or Flx.ERROR_ in the error case

      • writeArrayDef

        public int writeArrayDef​(int itemId,
                         int index,
                         java.lang.String label,
                         java.lang.String memberDescriptor)
        Writes an entry for an array definition.
        Parameters:
        itemId - : The item id of the referenced item. The id must be unique for this trace and in the range of 1..maxItemId
        index - : Index of the array member (0..size-1).
        label - : Label of the array member.
        memberDescriptor - : Type descriptor or 0 for default.
        Returns:
        Returns Flx.OK is succeeded, or Flx.ERROR_ in the error case

      • writeMemberDef

        public int writeMemberDef​(int itemId,
                          int memberId,
                          int parentId,
                          java.lang.String label,
                          int memberType,
                          java.lang.String memberDescriptor)
        Writes an entry for a member definition.
        Parameters:
        itemId - : The item id of the referenced item. The id must be unique for this trace and in the range of 1..maxItemId
        memberId - : Id of the member (0..N). This id need to be unique for one signal item.
        parentId - : Id of the parent member (0..N) or -1 if no parent member. Only for sub structures.
        label - : Label of the struct member.
        memberType - : Data type of this member (Flx.STRUCTTYPE_TEXT, Flx.STRUCTTYPE_ENUM,...)
        memberDescriptor - : Type descriptor or 0 for default.
        Returns:
        Returns Flx.OK is succeeded, or Flx.ERROR_ in the error case

      • writeMemberDefs

        public int writeMemberDefs​(int itemId,
                           Flx.MemberValue[] members)
        Writes multiple entries for member definition.
        Parameters:
        itemId - : The item id of the referenced item. The id must be unique for this trace and in the range of 1..maxItemId
        member - : Member structure of type flxMemberValue
        Returns:
        Returns Flx.OK is succeeded, or Flx.ERROR_ in the error case

      • writeCurrent

        public int writeCurrent​(int itemId,
                        long domainPosition)
        Sets the current domain position.
        Parameters:
        itemId - : The item id of the referenced item. The id must be unique for this trace and in the range of 1..maxItemId
        domainPosition - : Domain position as a multiple of its domain base (e.g. domain base=1ms; units = 100; -> domain value = 100ms).
        Returns:
        Returns Flx.OK is succeeded, or Flx.ERROR_ in the error case

      • writeNoneAt

        public int writeNoneAt​(int itemId,
                       int tag,
                       long domainPosition,
                       boolean isDelta)
        Writes a 'none' samples.
        Parameters:
        itemId - : The item id of the referenced item. The id must be unique for this trace and in the range of 1..maxItemId
        conflict - : Marks the new sample as a 'conflict' one. In impulse conflict samples are painted in red
        domainPosition - : Domain position as a multiple of its domain base (e.g. domain base=1ms; units = 100; -> domain value = 100ms).
        isDelta - : If set to true, domain will be taken as positive relative value (0 to keep the domain position)
        Returns:
        Returns Flx.OK is succeeded, or Flx.ERROR_ in the error case

      • writeIntAt

        public int writeIntAt​(int itemId,
                      int tag,
                      long domainPosition,
                      boolean isDelta,
                      java.lang.Number value)
        Writes an integer sample.
        Parameters:
        itemId - : The item id of the referenced item. The id must be unique for this trace and in the range of 1..maxItemId
        conflict - : Marks the new sample as a 'conflict' one. In impulse conflict samples are painted in red
        domainPosition - : Domain position as a multiple of its domain base (e.g. domain base=1ms; units = 100; -> domain value = 100ms).
        isDelta - : If set to true, domain will be taken as positive relative value (0 to keep the domain position)
        value - : The value
        Returns:
        Returns Flx.OK is succeeded, or Flx.ERROR_ in the error case

      • writeIntArrayAt

        public int writeIntArrayAt​(int itemId,
                           int tag,
                           long domainPosition,
                           boolean isDelta,
                           java.lang.Object value,
                           boolean dynamicSize)
        Writes an integer array sample.
        Parameters:
        itemId - : The item id of the referenced item. The id must be unique for this trace and in the range of 1..maxItemId
        conflict - : Marks the new sample as a 'conflict' one. In impulse conflict samples are painted in red
        domainPosition - : Domain position as a multiple of its domain base (e.g. domain base=1ms; units = 100; -> domain value = 100ms).
        isDelta - : If set to true, domain will be taken as positive relative value (0 to keep the domain position)
        value - : The value
        dynamicSize - : Set to true, if the size of the array is volatile.
        Returns:
        Returns Flx.OK is succeeded, or Flx.ERROR_ in the error case

      • writeFloatAt

        public int writeFloatAt​(int itemId,
                        int tag,
                        long domainPosition,
                        boolean isDelta,
                        java.lang.Number value)
        Writes a float sample.
        Parameters:
        itemId - : The item id of the referenced item. The id must be unique for this trace and in the range of 1..maxItemId
        domainPosition - : Marks the new sample as a 'conflict' one. In impulse conflict samples are painted in red
        current - : Domain position as a multiple of its domain base (e.g. domain base=1ms; units = 100; -> domain value = 100ms).
        isDelta - : If set to true, domain will be taken as positive relative value (0 to keep the domain position)
        value - : The value
        Returns:
        Returns Flx.OK is succeeded, or Flx.ERROR_ in the error case

      • writeFloatArrayAt

        public int writeFloatArrayAt​(int itemId,
                             int tag,
                             long domainPosition,
                             boolean isDelta,
                             java.lang.Object value,
                             boolean dynamicSize)
        Writes a float array sample.
        Parameters:
        itemId - : The item id of the referenced item. The id must be unique for this trace and in the range of 1..maxItemId
        conflict - : Marks the new sample as a 'conflict' one. In impulse conflict samples are painted in red
        domainPosition - : Domain position as a multiple of its domain base (e.g. domain base=1ms; units = 100; -> domain value = 100ms).
        isDelta - : If set to true, domain will be taken as positive relative value (0 to keep the domain position)
        value - : The value
        dynamicSize - : Set to true, if the size of the array is volatile.
        Returns:
        Returns Flx.OK is succeeded, or Flx.ERROR_ in the error case

      • writeEventAt

        public int writeEventAt​(int itemId,
                        int tag,
                        long domainPosition,
                        boolean isDelta,
                        int value)
        Writes an event sample.
        Parameters:
        itemId - : The item id of the referenced item. The id must be unique for this trace and in the range of 1..maxItemId
        conflict - : Marks the new sample as a 'conflict' one. In impulse conflict samples are painted in red
        domainPosition - : Domain position as a multiple of its domain base (e.g. domain base=1ms; units = 100; -> domain value = 100ms).
        isDelta - : If set to true, domain will be taken as positive relative value (0 to keep the domain position)
        value - : The value
        Returns:
        Returns Flx.OK is succeeded, or Flx.ERROR_ in the error case

      • writeEventArrayAt

        public int writeEventArrayAt​(int itemId,
                             int tag,
                             long domainPosition,
                             boolean isDelta,
                             int[] value,
                             boolean dynamicSize)
        Writes an event array sample.
        Parameters:
        itemId - : The item id of the referenced item. The id must be unique for this trace and in the range of 1..maxItemId
        conflict - : Marks the new sample as a 'conflict' one. In impulse conflict samples are painted in red
        domainPosition - : Domain position as a multiple of its domain base (e.g. domain base=1ms; units = 100; -> domain value = 100ms).
        isDelta - : If set to true, domain will be taken as positive relative value (0 to keep the domain position)
        value - : The value
        dynamicSize - : Set to true, if the size of the array is volatile.
        Returns:
        Returns Flx.OK is succeeded, or Flx.ERROR_ in the error case

      • writeTextAt

        public int writeTextAt​(int itemId,
                       int tag,
                       long domainPosition,
                       boolean isDelta,
                       java.lang.String value)
        Writes a text sample.
        Parameters:
        itemId - : The item id of the referenced item. The id must be unique for this trace and in the range of 1..maxItemId
        conflict - : Marks the new sample as a 'conflict' one. In impulse conflict samples are painted in red
        domainPosition - : Domain position as a multiple of its domain base (e.g. domain base=1ms; units = 100; -> domain value = 100ms).
        isDelta - : If set to true, domain will be taken as positive relative value (0 to keep the domain position)
        value - : The value
        size - : Size of the value in characters
        Returns:
        Returns Flx.OK is succeeded, or Flx.ERROR_ in the error case

      • writeTextArrayAt

        public int writeTextArrayAt​(int itemId,
                            int tag,
                            long domainPosition,
                            boolean isDelta,
                            java.lang.String[] value,
                            boolean dynamicSize)
        Writes an text array sample.
        Parameters:
        itemId - : The item id of the referenced item. The id must be unique for this trace and in the range of 1..maxItemId
        conflict - : Marks the new sample as a 'conflict' one. In impulse conflict samples are painted in red
        domainPosition - : Domain position as a multiple of its domain base (e.g. domain base=1ms; units = 100; -> domain value = 100ms).
        isDelta - : If set to true, domain will be taken as positive relative value (0 to keep the domain position)
        value - : The value
        dynamicSize - : Set to true, if the size of the array is volatile.
        Returns:
        Returns Flx.OK is succeeded, or Flx.ERROR_ in the error case

      • writeBinaryAt

        public int writeBinaryAt​(int itemId,
                         int tag,
                         long domainPosition,
                         boolean isDelta,
                         byte[] value)
        Writes a binary sample.
        Parameters:
        itemId - : The item id of the referenced item. The id must be unique for this trace and in the range of 1..maxItemId
        conflict - : Marks the new sample as a 'conflict' one. In impulse conflict samples are painted in red
        domainPosition - : Domain position as a multiple of its domain base (e.g. domain base=1ms; units = 100; -> domain value = 100ms).
        isDelta - : If set to true, domain will be taken as positive relative value (0 to keep the domain position)
        value - : The value
        Returns:
        Returns Flx.OK is succeeded, or Flx.ERROR_ in the error case

      • writeLogicStatesAt

        public int writeLogicStatesAt​(int itemId,
                              int tag,
                              long domainPosition,
                              boolean isDelta,
                              int precedingStates,
                              byte[] value,
                              int totalBitWidth)
        Writes a logic sample using an array of states.
        Parameters:
        itemId - : The item id of the referenced item. The id must be unique for this trace and in the range of 1..maxItemId
        conflict - : Marks the new sample as a 'conflict' one. In impulse conflict samples are painted in red
        domainPosition - : Domain position as a multiple of its domain base (e.g. domain base=1ms; units = 100; -> domain value = 100ms).
        isDelta - : If set to true, domain will be taken as positive relative value (0 to keep the domain position)
        precedingStates - : If the given no of bits less than the defined one, the preceding states will be filled to the left
        value - : The value
        totalBitWidth - : Total size if the logic vector
        Returns:
        Returns Flx.OK is succeeded, or Flx.ERROR_ in the error case

      • writeLogicTextAt

        public int writeLogicTextAt​(int itemId,
                            int tag,
                            long domainPosition,
                            boolean isDelta,
                            int precedingStates,
                            java.lang.String value,
                            int totalBitWidth)
        Writes a logic sample using a text.
        Parameters:
        trace - : The trace object
        itemId - : The item id of the referenced item. The id must be unique for this trace and in the range of 1..maxItemId
        conflict - : Marks the new sample as a 'conflict' one. In impulse conflict samples are painted in red
        domainPosition - : Domain position as a multiple of its domain base (e.g. domain base=1ms; units = 100; -> domain value = 100ms).
        isDelta - : If set to true, domain will be taken as positive relative value (0 to keep the domain position)
        precedingStates - : If the given no of bits less than the defined one, the preceding states will be filled to the left
        value - : The value
        totalBitWidth - : Total size if the logic vector
        Returns:
        Returns Flx.OK is succeeded, or Flx.ERROR_ in the error case

      • writeMembersAt

        public int writeMembersAt​(int itemId,
                          int tag,
                          long domainPosition,
                          boolean isDelta,
                          Flx.MemberValue[] value)
        Writes a struct sample.
        Parameters:
        itemId - : The item id of the referenced item. The id must be unique for this trace and in the range of 1..maxItemId
        conflict - : Marks the new sample as a 'conflict' one. In impulse conflict samples are painted in red
        domainPosition - : Domain position as a multiple of its domain base (e.g. domain base=1ms; units = 100; -> domain value = 100ms).
        isDelta - : If set to true, domain will be taken as positive relative value (0 to keep the domain position)
        value - : The value
        Returns:
        Returns Flx.OK is succeeded, or Flx.ERROR_ in the error case

      • writeRelation

        public int writeRelation​(int itemId,
                         int type,
                         int target,
                         int style,
                         long ldeltaOrPosition,
                         int targetBase)
        Writes an relation entry. An relation connects the previously written sample with any other item (path of the item) at a relative position.
        Parameters:
        itemId - : The item id of the referenced item. The id must be unique for this trace and in the range of 1..maxItemId
        type - : Relation type.
        target - : Path to the target signal (e.g. "\\scope\\signal")
        style - : Enumeration id of the style description.
        deltaOrPosition - : Delta position
        targetBase - : Target domain base
        Returns:
        Returns Flx.OK is succeeded, or Flx.ERROR_ in the error case

      • writeLabel

        public int writeLabel​(int itemId,
                      int style)
        Writes a label entry. The label is added to the previously written sample.
        Parameters:
        itemId - : The item id of the referenced item. The id must be unique for this trace and in the range of 1..maxItemId
        style - : Enumeration id of the style description.
        Returns:
        Returns Flx.OK is succeeded, or Flx.ERROR_ in the error case

      • flush

        public int flush()