Skip to navigation
API referenceC++ APINamespacesParamsFunctions

holoscan::params::load_and_set_params

Beta
View as Markdown
HOLOSCAN_PARAMS_IO_EXPORT ParamRebindResult<ParamRebindProvenance> holoscan::params::load_and_set_params(
    Graph &graph,
    const std::filesystem::path &path,
    const ParamRebindTargetScope &target_scope = ParamRebindTargetScope::whole_graph(),
    ParamRebindOptions options = {}
)

Load one snapshot archive and attach it as a graph-owned parameter transaction.

This cold operation allocates, blocks on filesystem I/O, and mutates Graph authoring state. Do not call it concurrently with Graph mutation. Configuration and snapshot attachment share one transaction slot, including across embedded Graphs.

This is not a non-mutating compatibility preflight. Compile a disposable Graph when validation must not alter the intended destination.

Returns: Owning conversion provenance or one typed load or attachment failure.

Parameters

graph
Graph &

Destination Graph that owns the pending transaction.

path
const std::filesystem::path &

Existing archive path.

target_scope
const ParamRebindTargetScope &Defaults to ParamRebindTargetScope::whole_graph()

Exact destination authority.

options
ParamRebindOptionsDefaults to {}

Coverage mode and borrowed directed conversion tables.