exa.common.api.proto_serialization.setting_node.pack

Contents

exa.common.api.proto_serialization.setting_node.pack#

pack(node, minimal)#

Convert a SettingNode into protobuf representation.

Silently coerces some datatypes to be compatible with the proto definition of Datum: - Numpy arrays of 32-bit ints are converted to 64-bits (Windows only). - Singular numpy types are converted into corresponding native types.

Parameters:

  • node (SettingNode) – SettingNode to pack, recursively.

  • minimal (bool) – Iff True, only the Parameter.name of each Setting is preserved along with the setting value. Otherwise the the whole Setting is packed. Set to True only when transmitting Settings from clients to Station Control, in the other direction we need all the data.

Returns:

Protobuf instance that represents node.

Return type:

iqm.data_definitions.common.v1.setting_pb2.SettingNode

Contents