Skip to navigation

holoscan::HostedParameterSnapshot

Beta
View as Markdown

Own an immutable parameter schema and generation-zero value without language callbacks.

Copies share immutable storage. Descriptor strings, field records, and scalar values therefore remain stable for as long as a Graph factory, compiled Plan, or session-owned Operator retains a snapshot. Reading the snapshot never invokes a foreign runtime or acquires a language lock.

#include <holoscan/hosted_parameter_snapshot.hpp>

Methods

operator bool

holoscan::HostedParameterSnapshot::operator bool() const noexcept

Return whether this snapshot carries a declared parameter schema.

type

const ParamTypeDescriptor & holoscan::HostedParameterSnapshot::type() const noexcept

Return the exact process-local aggregate descriptor.

schema

const ParamSchemaDescriptor * holoscan::HostedParameterSnapshot::schema() const noexcept

Return the owned immutable schema, or null for an empty snapshot.

read_scalar

bool holoscan::HostedParameterSnapshot::read_scalar(
const ParamFieldDescriptor &field,
) const noexcept

Read one scalar field by descriptor.

Returns: true only for a present exact scalar value.

read_scalar_sequence

std::span<const ParamScalarValue> holoscan::HostedParameterSnapshot::read_scalar_sequence(
const ParamFieldDescriptor &field
) const noexcept

Read one bounded scalar sequence by descriptor.

Returns: Empty for a foreign or non-sequence field; an authored empty sequence is valid.


Member variables

NameTypeDescription
statestd::shared_ptr< const detail::HostedParameterSnapshotState >Immutable owned storage.