For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • Introduction
    • Overview
    • Relevant Technologies
    • Getting Started
  • Setup
    • SDK Installation
    • Additional Setup
    • Third Party Hardware Setup
  • Using the SDK
    • Holoscan Core
    • GPU Resident Execution
    • Holoscan by Example
    • Create an Application
    • Create a Distributed Application
    • Create an Operator
    • Create an Operator via Decorator
    • Create a Condition
    • Dynamic Flow Control
    • CUDA Stream Handling
    • Logging
    • Data Logging
    • Debugging
    • Python Operator Bindings
  • Operators
    • Operators and Extensions
    • Visualization
    • Inference
    • Testing
    • Video I/O Vendor Implementation Guide
  • Components
    • Schedulers
    • Conditions
    • Resources
    • Analytics
  • AI Skills
    • Ai Skills
  • API reference
              • Clock
              • ComponentInfo
              • CudaObjectHandler
              • Endpoint
              • Entity
              • EntityGroup
              • GXFComponent
              • GXFCondition
              • GXFExecutionContext
              • GXFExecutor
              • GXFExtensionManager
              • GXFExtensionRegistrar
              • GXFInputContext
              • GXFLogger
              • GXFNetworkContext
              • GXFOutputContext
              • GXFParameterAdaptor
              • GXFResource
              • GXFScheduler
              • GXFSchedulingTermWrapper
              • GXFSystemResourceBase
              • GXFWrapper
  • Performance
    • Performance Considerations
    • Flow Tracking
    • GXF Job Statistics
    • Nsight Profiling
  • HoloHub
    • HoloHub Overview
  • FAQ
    • FAQ
NVIDIANVIDIA
Developer-friendly docs for your API
Privacy Policy | Your Privacy Choices | Terms of Service | Accessibility | Corporate Policies | Product Security | Contact

Copyright © 2026, NVIDIA Corporation.

LogoLogoDocumentation
On this page
  • Constructors
  • GXFComponent
  • Destructor
  • ~GXFComponent
  • Methods
  • gxf_typename
  • gxf_context
  • gxf_eid
  • gxf_tid
  • gxf_cid
  • gxf_cname
  • gxf_graph_entity
  • gxf_entity_group_name
  • gxf_entity_group_id
  • gxf_cptr
  • gxf_component
  • gxf_initialize
  • set_gxf_parameter
  • reset_gxf_graph_entity
  • Member variables
API referenceC++ APIHoloscanNamespacesGxfClasses

holoscan::gxf::GXFComponent

Beta
||View as Markdown|
Previous

holoscan::gxf::EntityGroup

Next

holoscan::gxf::GXFCondition

#include <holoscan/gxf/gxf_component.hpp>

Constructors

GXFComponent

holoscan::gxf::GXFComponent::GXFComponent() = defaultholoscan::gxf::GXFComponent::GXFComponent() = default

Destructor

~GXFComponent

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

Methods

gxf_typename

virtual const char * holoscan::gxf::GXFComponent::gxf_typename() const

gxf_context

Mutable
Const
void holoscan::gxf::GXFComponent::gxf_context(
    gxf_context_t gxf_context
)

gxf_eid

Mutable
Const
void holoscan::gxf::GXFComponent::gxf_eid(
    gxf_uid_t gxf_eid
)

gxf_tid

Mutable
Const
void holoscan::gxf::GXFComponent::gxf_tid(
    gxf_tid_t gxf_tid
)

gxf_cid

Mutable
Const
void holoscan::gxf::GXFComponent::gxf_cid(
    gxf_uid_t gxf_cid
)

gxf_cname

Overload 1
Overload 2
std::string & holoscan::gxf::GXFComponent::gxf_cname()

gxf_graph_entity

Overload 1
Overload 2
std::shared_ptr<nvidia::gxf::GraphEntity> holoscan::gxf::GXFComponent::gxf_graph_entity()

gxf_entity_group_name

std::string holoscan::gxf::GXFComponent::gxf_entity_group_name()

The name of the entity group this component belongs to.

gxf_entity_group_id

gxf_uid_t holoscan::gxf::GXFComponent::gxf_entity_group_id()

The group id of the entity group this component belongs to.

gxf_cptr

void * holoscan::gxf::GXFComponent::gxf_cptr()

gxf_component

nvidia::gxf::Handle<nvidia::gxf::Component> holoscan::gxf::GXFComponent::gxf_component()nvidia::gxf::Handle<nvidia::gxf::Component> holoscan::gxf::GXFComponent::gxf_component()

gxf_initialize

void holoscan::gxf::GXFComponent::gxf_initialize()

set_gxf_parameter

void holoscan::gxf::GXFComponent::set_gxf_parameter(
    const std::string &component_name,
    const std::string &key,
    ParameterWrapper &param_wrap
)

Set a given parameter on the underlying GXF component.

reset_gxf_graph_entity

void holoscan::gxf::GXFComponent::reset_gxf_graph_entity()

Member variables

NameTypeDescription
gxf_context_gxf_context_t
gxf_eid_gxf_uid_t
gxf_tid_gxf_tid_t
gxf_cid_gxf_uid_t
gxf_graph_entity_std::shared_ptr< nvidia::gxf::GraphEntity >
gxf_cname_std::string
gxf_component_nvidia::gxf::Handle< nvidia::gxf::Component >
gxf_cptr_void *