Skip to content

← formatting package

RenameStreams

Rename streams in the given data.

This node can flexibly rename streams. Note that such renaming is rarely necessary since almost all nodes identify the streams to act on by their properties rather than name. However, in some settings, such as when multiple streams are merged using the MergeStreams node, or when data is handed off to external applications, renaming streams can be helpful. Version 1.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

name_changes

Name changes to apply. This is formatted as in {'myoldname1': 'mynewname1', 'myoldname2': 'mynewname2', ...}. Streams that are not mentioned in this mapping keep their name. Special case: You may use '*' for the original name if the stream name is not known, which will match the first stream found (depending on the 'wildcard stream filter'). This can be combined with other name changes.

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

wildcard_stream_filter

If a namechange uses the '*' wildcard, you can select either the first matching stream ('any stream'), the first event stream ('event stream only'), or the first non-event stream ('non event stream only'). Alternatively you can select patternmatch and include * and ? wildcards in the name pattern.

  • verbose name: Wildcard Stream Filter
  • default value: any stream
  • port type: EnumPort
  • value type: str (can be None)

drop_others

Drop all streams that are not mentioned in the name changes.

  • verbose name: Drop Other Streams
  • default value: False
  • port type: BoolPort
  • value type: bool (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)