holoscan::gxf::GXFWrapper | Holoscan SDK Documentation

Class to wrap an Operator into a GXF Codelet.

#include <holoscan/gxf/gxf_wrapper.hpp>

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

Constructors

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

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

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

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

gxf_result_t holoscan::gxf::GXFWrapper::start() override

gxf_result_t holoscan::gxf::GXFWrapper::tick() override

gxf_result_t holoscan::gxf::GXFWrapper::stop() override

void holoscan::gxf::GXFWrapper::set_operator(
    Operator *op
)

Set the Operator object to be wrapped.

Parameters

Operator *

The pointer to the Operator object.

Operator * holoscan::gxf::GXFWrapper::op() constOperator * holoscan::gxf::GXFWrapper::op() const

Get the Operator object.

Returns: The pointer to the Operator object.

GXFExecutionContext * holoscan::gxf::GXFWrapper::execution_context() constGXFExecutionContext * holoscan::gxf::GXFWrapper::execution_context() const

Returns: The pointer to the ExecutionContext object.

InputContext * holoscan::gxf::GXFWrapper::input_context() constInputContext * holoscan::gxf::GXFWrapper::input_context() const

Get the InputContext object.

Returns: The pointer to the InputContext object.

OutputContext * holoscan::gxf::GXFWrapper::output_context() constOutputContext * holoscan::gxf::GXFWrapper::output_context() const

Get the OutputContext object.

Returns: The pointer to the OutputContext object.

void holoscan::gxf::GXFWrapper::store_exception()

void holoscan::gxf::GXFWrapper::initialize_contexts()

Initialize the local contexts (input/output/execution) for the operator.

void holoscan::gxf::GXFWrapper::create_post_compute_nvtx_range()

Create post-compute NVTX child range with frame information.

bool holoscan::gxf::GXFWrapper::is_root_operator() const

Check if the current operator is a root operator.

std::string holoscan::gxf::GXFWrapper::get_root_operator_frame_info() const

Get frame information string for root operators.

std::string holoscan::gxf::GXFWrapper::get_non_root_operator_frame_info() const

Get frame information string for non-root operators.

Name	Type	Description
`op_`	`Operator *`
`exec_context_`	`GXFExecutionContext *`	The execution context of the operator. Copied from the operator.
`op_input_`	`InputContext *`	The input context of the operator. Copied from the operator.
`op_output_`	`OutputContext *`	The output context of the operator. Copied from the operator.