value_channel_json.hpp

Go to the documentation of this file.

// value_channel_json.hpp - one serializer for a processor's value channels.
//
// Two consumers describe the same channels: the scripted-UI bridge
// (`listValueChannels()`) and the inspector (`State.getValueChannels`). They
// share this rather than hand-rolling a payload each, for the same reason
// param_json exists — a second implementation drifts the day either side gains
// a field, and a UI built against one shape then silently mis-reads the other.
 
#pragma once
 
#include <pulp/dataplane/value_channel_set.hpp>
 
#include <choc/containers/choc_Value.h>
 
#include <span>
 
namespace pulp::dataplane {

const char* value_channel_shape_name(ValueChannelShape shape) noexcept;

choc::value::Value value_channel_to_value(const ValueChannelInfo& info);

choc::value::Value value_channels_to_value(const ValueChannelSet* channels);

choc::value::Value value_channels_to_value(std::span<const ValueChannelInfo> channels);
 
} // namespace pulp::dataplane