API referenceC++ APIHoloscanNamespacesGxfClasses

holoscan::gxf::GXFSchedulingTermWrapper

Beta
View as Markdown

Class to wrap a native Condition into a GXF SchedulingTerm.

#include <holoscan/gxf/gxf_scheduling_term_wrapper.hpp>

Inherits from: nvidia::gxf::SchedulingTerm (public)

Constructors

Destructor

~GXFSchedulingTermWrapper

virtual holoscan::gxf::GXFSchedulingTermWrapper::~GXFSchedulingTermWrapper() = defaultvirtual holoscan::gxf::GXFSchedulingTermWrapper::~GXFSchedulingTermWrapper() = default

Methods

initialize

gxf_result_t holoscan::gxf::GXFSchedulingTermWrapper::initialize() override

deinitialize

gxf_result_t holoscan::gxf::GXFSchedulingTermWrapper::deinitialize() override

registerInterface

gxf_result_t holoscan::gxf::GXFSchedulingTermWrapper::registerInterface(
    nvidia::gxf::Registrar *registrar
) override

check_abi

gxf_result_t holoscan::gxf::GXFSchedulingTermWrapper::check_abi(
    int64_t timestamp,
    nvidia::gxf::SchedulingConditionType *status_type,
    int64_t *target_timestamp
) const override

Get the condition on which the scheduling waits before allowing execution.

If the term is waiting for a time event ‘target_timestamp’ will contain the target timestamp.

Parameters

timestamp
int64_t

The current timestamp

status_type
nvidia::gxf::SchedulingConditionType *

The status of the scheduling condition

target_timestamp
int64_t *

The target timestamp (used if the term is waiting for a time event).

onExecute_abi

gxf_result_t holoscan::gxf::GXFSchedulingTermWrapper::onExecute_abi(
    int64_t timestamp
) override

Called each time after the entity of this term was executed.

Parameters

timestamp
int64_t

The current timestamp

update_state_abi

gxf_result_t holoscan::gxf::GXFSchedulingTermWrapper::update_state_abi(
    int64_t timestamp
) override

Checks if the state of the scheduling term can be updated and updates it.

Parameters

timestamp
int64_t

The current timestamp

set_condition

void holoscan::gxf::GXFSchedulingTermWrapper::set_condition(
    std::shared_ptr<Condition> condition
)

Set the Condition object to be wrapped.

Parameters

condition
std::shared_ptr<Condition>

The pointer to the native Condition object.

store_exception

void holoscan::gxf::GXFSchedulingTermWrapper::store_exception() const

Member variables

NameTypeDescription
condition_std::shared_ptr< Condition >