Skip to content

← markers package

ExtractMarkers

Extract (select) event markers that match one or more patterns, dropping all others.

The markers to keep can be specified as verbatim marker strings, as wildcard patterns, or as regular expressions (see the match mode). The selection can also be inverted to keep everything except the matching markers, and can be narrowed to only the first, last, or n-th matching marker. The marker stream is modified in place; if you need to keep the original stream, split this off and then use MergeStreams to re-combine with the original stream. If using this node to extract a marker that will be used to trigger an If/Else node, follow it with a HoldLastPacket node to continuously trigger the condition. Version 0.1.0

Ports/Properties

data

Data to process.

  • verbose name: Data
  • default value: None
  • port type: DataPort
  • value type: Packet (can be None)
  • data direction: INOUT

markers

Marker string(s) or pattern(s) to extract. Markers whose value matches any of these entries are retained and all others are dropped (unless inverse is enabled, which flips the selection). Depending on match_mode the entries are interpreted as verbatim marker strings, as wildcard patterns (using * and ?), or as regular expressions. If left empty, the node passes the data through unchanged.

  • verbose name: Marker(S) To Extract
  • default value: ['mymarker']
  • port type: ListPort
  • value type: list (can be None)

match_mode

How to interpret the entries in markers. If set to literal, an entry must equal a marker string verbatim to match. If set to wildcards, the special character * matches any number of characters (including none) and ? matches any single character. If set to regex, each entry is treated as a regular expression (matched against the whole marker string).

  • verbose name: Match Mode
  • default value: literal
  • port type: EnumPort
  • value type: str (can be None)

inverse

Invert the selection. If enabled, the markers that do not match any of the patterns are retained, and the matching ones are dropped.

  • verbose name: Inverse
  • default value: False
  • port type: BoolPort
  • value type: bool (can be None)

occurrence

Which of the matching markers to keep. all keeps every matching marker, while first and last keep only the first or last matching marker (in stream order). You can also type an integer index to keep only the n-th matching marker; this is zero-based (0 is the first) and negative values count from the end (-1 is the last). If the index is out of range, no marker is kept. This is evaluated separately per marker stream, and applies after inverse.

  • verbose name: Occurrence
  • default value: all
  • port type: ComboPort
  • value type: object (can be None)

stream

Name of the marker stream(s) to process. Wildcards are supported, so mystream* will process all streams whose name starts with mystream. If left blank, all marker streams in the packet are processed. Streams that are not selected are passed through unchanged.

  • verbose name: Stream
  • default value: None
  • port type: StringPort
  • value type: str (can be None)

set_breakpoint

Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.

  • verbose name: Set Breakpoint (Debug Only)
  • default value: False
  • port type: BoolPort
  • value type: bool (can be None)

metadata

User-definable meta-data associated with the node. Usually reserved for technical purposes.

  • verbose name: Metadata
  • default value: {}
  • port type: DictPort
  • value type: dict (can be None)