Skip to navigation

holoscan::OperatorHandle

Beta
View as Markdown
template <std::derived_from< OperatorBase > Op>

Hold copyable Graph declaration identity for one Operator type.

#include <holoscan/graph.hpp>

Template parameters

Op
std::derived_from< OperatorBase >

Constructors

OperatorHandle

const void *operator_type_token,
std::weak_ptr<detail::GraphState> state,
std::size_t index,
std::shared_ptr<const void> handle_identity
) noexcept

Methods

operator->

PortAccess holoscan::OperatorHandle<Op>::operator->() const noexcept

Return restricted const prototype access for typed port wiring.

set_params

void holoscan::OperatorHandle<Op>::set_params(
Params params
)

Replace the complete generation-zero parameter aggregate.

Throws: RuntimeError if validation/reconstruction fails or this handle is stale.

Parameters

params
Params

Valid candidate aggregate copied into replayable factory state.

name

std::string_view holoscan::OperatorHandle<Op>::name() const noexcept

Return the owned local declaration name.

graph_valid

bool holoscan::OperatorHandle<Op>::graph_valid() const noexcept

Return whether the source Graph still owns the exact typed declaration.

operator bool

holoscan::OperatorHandle<Op>::operator bool() const noexcept

Return whether this handle names a live Graph declaration.

ref

OperatorRef holoscan::OperatorHandle<Op>::ref() const noexcept

Return the compiled operator reference when one exists.

Returns: Invalid zero reference in HSDK5-006; HSDK5-009 binds plan identity.

id

OperatorInstanceId holoscan::OperatorHandle<Op>::id() const noexcept

Return the compiled operator identity when one exists.

Returns: Zero in HSDK5-006 because authoring handles never fabricate plan IDs.

plan_generation

PlanGenerationId holoscan::OperatorHandle<Op>::plan_generation() const noexcept

Return the immutable compiled-plan generation when one exists.

Returns: Zero until HSDK5-009 freezes this declaration into a plan.

plan_bound

bool holoscan::OperatorHandle<Op>::plan_bound() const noexcept

Return whether this handle is bound to an immutable compiled plan.

Returns: Always false for the HSDK5-006 authoring-only handle.


Types

Typedefs

NameDefinitionDescription
graph_authoring_handle_tagvoidOpt this authoring handle out of replayable Graph captures.
OperatorOpName the exact concrete Operator type represented by this handle.
Paramstypename Op::ParamsName the complete generation-zero parameter aggregate for Operator.
PortAccessOperatorPortProxy< Op >Name the restricted dynamic prototype accessor used for typed port wiring.

Member variables

NameTypeDescription
operator_type_token_const void *
state_std::weak_ptr< detail::GraphState >
index_std::size_t
handle_identity_std::shared_ptr< const void >