pcdsdevices.signal.AggregateSignal

class pcdsdevices.signal.AggregateSignal(*, name, **kwargs)

Signal that is composed of a number of other signals.

This class exists to handle the group subscriptions without repeatedly getting the values of all the subsignals at all times.

_cache

Mapping from signal to last known value.

_sub_signals

Signals that contribute to this signal.

Methods

describe()

Provide schema and meta-data for read()

This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

This provides schema related information, (ex shape, dtype), the source (ex PV name), and if available, units, limits, precision etc.

Returns: data_keys (OrderedDict) – The keys must be strings and the values must be dict-like with the event_model.event_descriptor.data_key schema.

read()

Put the status of the signal into a simple dictionary format for data acquisition

read_configuration(): Dictionary mapping names to value dicts with keys: value, timestamp

set(value, *, timeout=None, settle_time=None)

Set is like put, but is here for bluesky compatibility

Returns: st (Status) – This status object will be finished upon return in the case of basic soft Signals

Attributes

connected: Is the signal connected to its associated hardware, and ready to use?

metadata_keys: Metadata keys that will be passed along on value subscriptions