waveform_editor.static_waveform.StaticWaveform¶

class waveform_editor.static_waveform.StaticWaveform(value, *, yaml_str='', name='waveform', dd_version=None)¶

Bases: BaseWaveform

A waveform that assigns a single static value to a DD node.

Used for non-numeric or non-time-dependent fields, e.g. a {value: ec} constant that names an identifier. The value is written verbatim by the exporter; it is not a time series and has no analytic tendencies.

__init__(value, *, yaml_str='', name='waveform', dd_version=None)¶

Methods

__init__(value, *[, yaml_str, name, dd_version])
get_metadata(dd_version)	Parses the name of the waveform and returns the IDS metadata for this waveform.
get_value([time])
get_yaml_string()

get_metadata(dd_version)¶

Parses the name of the waveform and returns the IDS metadata for this waveform. The name must be formatted as follows: <IDS-Name>/<IDS-path>

For example: ec_launchers/beam(2)/phase/angle

Parameters:

dd_version¶

Data dictionary version to create metadata for.

Returns:

The metadata of the IDS node, or None if it could not find it.