Skip to navigation

holoscan::BasicSourceRef

Beta
View as Markdown
template <ReadinessSourceKind Kind>

Refer to one logical source without carrying adapter ownership.

The reference contains only a strong plan-local SourceId and private immutable plan provenance. It never contains an authoring-object address, file descriptor, CUDA event, HoloMQ handle, adapter pointer, or Runtime object. A default value is invalid. Copying does not retain a binding or source generation.

#include <holoscan/readiness_source.hpp>

Template parameters

Kind
ReadinessSourceKind

Immutable logical source kind represented by this type.


Constructors

BasicSourceRef

holoscan::BasicSourceRef<Kind>::BasicSourceRef() noexcept = default

Construct an invalid source reference.


Methods

id

SourceId holoscan::BasicSourceRef<Kind>::id() const noexcept

Return the plan-local logical source identity.

Returns: Assigned source identity, or invalid zero for an unbound value.

operator bool

holoscan::BasicSourceRef<Kind>::operator bool() const noexcept

Return whether this reference contains an assigned logical identity.

Returns: true when id is nonzero.


Static methods

kind

static constexpr ReadinessSourceKind holoscan::BasicSourceRef<Kind>::kind() noexcept

Return the immutable logical kind carried by this reference type.

Returns: Template source kind.


Member variables

NameTypeDescription
id_SourceId
plan_provenance_std::uint64_t