holoscan::params::RequiredParamSchemaCodec

template <typename ParamsT>
struct RequiredParamSchemaCodec

Derive an object codec that requires every field in a complete parameter schema.

Specialize config::ConfigCodec for ParamsT by inheriting this type when every schema key must be present during whole-value decode. This is useful for nested parameter objects that field-local binding replaces as one value. Other behavior matches DefaultedParamSchemaCodec. Sensitive and transient schema fields are still encoded. The author-asserted completeness warning on DefaultedParamSchemaCodec also applies here.

#include <holoscan/params/config.hpp>

Template parameters

Inherits from: holoscan::params::detail::ParamSchemaCodecBase< ParamsT, true > (public)

Static methods

decode

static ConfigResult<ParamsT> holoscan::config::ObjectCodec<ParamsT>::decode(
    ConfigView view,
    const DecodeOptions &options,
    DecodeContext &context
)

Decode declared object fields through their member codecs.

encode

static ConfigResult<ConfigValue> holoscan::config::ObjectCodec<ParamsT>::encode(
    const ParamsT &value,
    const EncodeOptions &options,
    EncodeContext &context
)

Encode every declared object field through its member codec.