Skip to navigation

holoscan::ExecutionGraphView

Beta
View as MarkdownOpen in Claude

Inspect the immutable canonical Graph stored by one execution plan.

This view has a deliberately distinct type from GraphView. GraphView preserves authored order and snapshot-local identities that correspond to authoring handles, whereas this view exposes compiler-canonical order and dense plan-local identities that join directly to other ExecutionPlan records. Copies retain the immutable plan snapshot and remain valid after the source Graph or the ExecutionPlan that produced the view is destroyed. Concurrent reads of separate copies are safe.

#include <holoscan/execution_plan.hpp>

Constructors

ExecutionGraphView

holoscan::ExecutionGraphView::ExecutionGraphView() = default

Create an empty canonical plan view.


Methods

generation

GraphGeneration holoscan::ExecutionGraphView::generation() const noexcept

Return the frozen source Graph authoring generation.

Returns: Zero for an empty view; otherwise the frozen generation.

identity

GraphAuthoringIdentity holoscan::ExecutionGraphView::identity() const noexcept

Return the retained source Graph authoring identity.

Returns: Zero-initialized identity for an empty view.

graphs

std::span<const GraphRecord> holoscan::ExecutionGraphView::graphs() const noexcept

Return canonical Graph records.

Returns: Records whose IDs share the ExecutionPlan identity domain.

vertices

std::span<const VertexRecord> holoscan::ExecutionGraphView::vertices() const noexcept

Return canonical logical vertex records.

Returns: Records whose IDs join directly to plan vertex records.

ports

std::span<const PortRecord> holoscan::ExecutionGraphView::ports() const noexcept

Return canonical pointer-free port records.

Returns: Records whose IDs join directly to plan port records.

edges

std::span<const EdgeRecord> holoscan::ExecutionGraphView::edges() const noexcept

Return canonical typed queue-edge records.

Returns: Records whose IDs join directly to plan edge records.

interface_bindings

std::span<const InterfaceBindingRecord> holoscan::ExecutionGraphView::interface_bindings() const noexcept

Return canonical same-direction interface aliases.

Returns: Immutable interface-binding records.

external_topics

std::span<const ExternalTopicRecord> holoscan::ExecutionGraphView::external_topics() const noexcept

Return canonical intrinsic external topic records.

Returns: Immutable external-topic records.

readiness_sources

std::span<const ReadinessSourceDeclarationRecord> holoscan::ExecutionGraphView::readiness_sources() const noexcept

Return canonical readiness-source declarations.

Returns: Immutable logical readiness declarations.

regions

std::span<const RegionRecord> holoscan::ExecutionGraphView::regions() const noexcept

Return canonical region declarations.

Returns: Immutable region records.

clocks

std::span<const ClockDeclarationRecord> holoscan::ExecutionGraphView::clocks() const noexcept

Return canonical clock declarations.

Returns: Immutable cold clock declarations.

clock_imports

std::span<const ClockImportAuthoringRecord> holoscan::ExecutionGraphView::clock_imports() const noexcept

Return canonical reusable-Graph clock imports.

Returns: Immutable scoped clock dependencies.

clock_bindings

std::span<const EmbeddedClockBindingAuthoringRecord> holoscan::ExecutionGraphView::clock_bindings() const noexcept

Return canonical exact embedded clock bindings.

Returns: Immutable parent-to-child clock bindings.

clock_conversions

std::span<const ClockConversionAuthoringRecord> holoscan::ExecutionGraphView::clock_conversions() const noexcept

Return canonical directed clock-conversion declarations.

Returns: Immutable authored conversion records.

lifecycle_dependencies

std::span<const LifecycleDependencyAuthoringRecord> holoscan::ExecutionGraphView::lifecycle_dependencies() const noexcept

Return canonical same-stage lifecycle dependencies.

Returns: Immutable authored lifecycle dependency records.

lifecycle_restart_permissions

std::span<const LifecycleRestartPermissionAuthoringRecord> holoscan::ExecutionGraphView::lifecycle_restart_permissions() const noexcept

Return canonical deny-by-default restart permissions.

Returns: Immutable authored restart-permission records.


Member variables

NameTypeDescription
view_GraphView