Class GXFResource

• Defined in File gxf_resource.hpp

Base Types

• public holoscan::Resource (Class Resource)

• public holoscan::gxf::GXFComponent (Class GXFComponent)

Derived Types

• public holoscan::Allocator (Class Allocator)

• public holoscan::CPUThread (Class CPUThread)

• public holoscan::Clock (Class Clock)

• public holoscan::ConditionCombiner (Class ConditionCombiner)

• public holoscan::GXFComponentResource (Class GXFComponentResource)

• public holoscan::Receiver (Class Receiver)

• public holoscan::SerializationBuffer (Class SerializationBuffer)

• public holoscan::StdComponentSerializer (Class StdComponentSerializer)

• public holoscan::StdEntitySerializer (Class StdEntitySerializer)

• public holoscan::Transmitter (Class Transmitter)

• public holoscan::UcxComponentSerializer (Class UcxComponentSerializer)

• public holoscan::UcxEntitySerializer (Class UcxEntitySerializer)

• public holoscan::UcxHoloscanComponentSerializer (Class UcxHoloscanComponentSerializer)

• public holoscan::UcxSerializationBuffer (Class UcxSerializationBuffer)

• public holoscan::gxf::GXFSystemResourceBase (Class GXFSystemResourceBase)

class GXFResource : public holoscan::Resource, public holoscan::gxf::GXFComponent

Subclassed by holoscan::Allocator, holoscan::CPUThread, holoscan::Clock, holoscan::ConditionCombiner, holoscan::GXFComponentResource, holoscan::Receiver, holoscan::SerializationBuffer, holoscan::StdComponentSerializer, holoscan::StdEntitySerializer, holoscan::Transmitter, holoscan::UcxComponentSerializer, holoscan::UcxEntitySerializer, holoscan::UcxHoloscanComponentSerializer, holoscan::UcxSerializationBuffer, holoscan::gxf::GXFSystemResourceBase

Public Functions

template<typename ArgT, typename ...ArgsT, typename = std::enable_if_t<!std::is_base_of_v<::holoscan::Resource, std::decay_t<ArgT>> && (std::is_same_v<::holoscan::Arg, std::decay_t<ArgT>> || std::is_same_v<::holoscan::ArgList, std::decay_t<ArgT>>)>>
inline explicit GXFResource(ArgT &&arg, ArgsT&&... args)

GXFResource() = default

GXFResource(const std::string &name, nvidia::gxf::Component *component)

virtual void initialize() override

Initialize the component.

This method is called only once when the component is created for the first time, and use of light-weight initialization.

Protected Functions

virtual void add_to_graph_entity(Operator *op)

void add_to_graph_entity(Fragment *fragment, std::shared_ptr<nvidia::gxf::GraphEntity> graph_entity)

virtual YAML::Node to_yaml_node() const override

Get a YAML representation of the resource.

Returns

YAML node including type and specs of the resource in addition to the base component properties.

virtual void set_parameters() override

This method is invoked by GXFResource::initialize(). By overriding this method, we can modify how GXF Codelet’s parameters are set from the arguments.

bool handle_dev_id(std::optional<int32_t> &dev_id_value)

Protected Attributes

std::string gxf_typename_ = "unknown_gxf_typename"

The GXF type name (used for GXFComponentResource)

Friends

friend class holoscan::gxf::GXFExecutor

friend class holoscan::Operator

friend class holoscan::Fragment