holoscan::InputPortConfigurator

template <PublishedPayload T>
class InputPortConfigurator

Configure cold authoring policy for one Graph-owned input port.

A configurator is a non-owning handle. It remains usable only while the originating Graph and exact port declaration remain live. Each successful call atomically updates cold authoring state; a rejected call leaves the port and its incident edges unchanged. Configurators do not make Graph authoring thread-safe, so callers must serialize them with all other reads and mutations of the same Graph.

#include <holoscan/graph.hpp>

Template parameters

Constructors

InputPortConfigurator

holoscan::InputPortConfigurator<T>::InputPortConfigurator(
    std::weak_ptr<detail::GraphState> state,
    GraphPortId port,
    std::shared_ptr<const void> handle_identity
) noexcept

Methods

queue_depth

InputPortConfigurator & holoscan::InputPortConfigurator<T>::queue_depth(
    std::uint32_t depth
)

Override the finite input history depth.

Returns: This configurator for fluent authoring.

Throws: RuntimeError if depth is zero or the source Graph is unavailable.

Parameters

expects_tensor

InputPortConfigurator & holoscan::InputPortConfigurator<T>::expects_tensor(
    const TensorInputSpec &spec
)

Override this input with one common consumer Tensor spec.

Returns: This configurator for fluent authoring.

Parameters

diagnostic_alias

InputPortConfigurator & holoscan::InputPortConfigurator<T>::diagnostic_alias(
    std::string_view alias
)

Assign an owned diagnostic alias without changing port identity.

Returns: This configurator for fluent authoring.

Throws: RuntimeError if alias is invalid or the source Graph is unavailable.

Parameters

state

std::shared_ptr<detail::GraphState> holoscan::InputPortConfigurator<T>::state() const

apply

static void holoscan::InputPortConfigurator<T>::apply(
    expected<void, Error> result
)

Types

Typedefs

Member variables