holoscan::ParamFieldDocument

Beta

Describe one field without carrying process-local member or function pointers.

#include <holoscan/parameter_schema.hpp>

Member variables

Name	Type	Description
`id`	`ParamFieldId`	Big-endian 64-bit projection of `full_id`.
`full_id`	`ParamSchemaHash`	Complete canonical field SHA-256 identity.
`canonical_name`	`std::string_view`	Static canonical structured path.
`logical_type`	`ParamLogicalType`	Portable value family.
`type_shape`	`ParamFieldTypeShape`	Canonical structural type and decoding shape.
`mutability`	`ParamMutability`	Application boundary.
`earliest_invalidated_stage`	`LifecycleStage`	Restart stage.
`persistence`	`ParamPersistence`	Durable-projection policy.
`string_encoding`	`ParamStringEncoding`	String semantics.
`element_string_encoding`	`ParamStringEncoding`	`vector<string>` element semantics.
`visibility`	`ParamVisibility`	Ordinary discovery policy.
`external_access`	`ParamExternalAccess`	External eligibility.
`sensitivity`	`ParamSensitivity`	Redaction classification.
`policy_evidence`	`ParamFieldPolicyEvidence`	Explicit-vs-inferred qualification facts.
`required_on_load`	`bool`	Whether complete import requires an archived value.
`nested`	`bool`	Whether nested schema identity is present.
`nested_schema_id`	`std::string_view`	Nested stable ID, or empty.
`nested_schema_version`	`ParamSchemaVersion`	Nested version, or zero.
`nested_structural_hash`	`ParamSchemaHash`	Nested decoding-shape identity.
`nested_contract_hash`	`ParamSchemaHash`	Nested policy identity.
`alias`	`std::string_view`	Prior canonical migration input name.
`description`	`std::string_view`	Descriptive UTF-8 metadata.
`unit`	`std::string_view`	Descriptive unit metadata.
`validator_id`	`std::string_view`	Stable validator identity without a callable.
`constraints`	`ParamConstraints`	Portable bounds and choices.
`enum_choices`	`ParamEnumChoices`	Stable authored enum label/value domain.
`storage`	`ParamStorageTraitsSummary`	Intrinsic field storage evidence.