holoscan::gxf::EntityGroup | Holoscan SDK Documentation

GXF entity group.

Define an entity group for the underlying GXF runtime. Entity groups are used to associate components with resources inheriting from nvidia::gxf::ResourceBase. The components of this type exposed in Holoscan SDK’s API are GPUDevice and ThreadPool.

#include <holoscan/gxf/entity_group.hpp>

Constructors

EntityGroup

Overload 2

Deleted overload 1

holoscan::gxf::EntityGroup::EntityGroup(
    gxf_context_t context,
    const std::string &name
)

Methods

gxf_gid

gxf_uid_t holoscan::gxf::EntityGroup::gxf_gid() const

Get the group id of the entity group.

Returns: The GXF group id of the entity group.

gxf_context

gxf_context_t holoscan::gxf::EntityGroup::gxf_context() const

Get the GXF context of the entity group.

Returns: The GXF context of the entity group.

name

std::string holoscan::gxf::EntityGroup::name() const

Get the name of the entity group.

Returns: The name of the entity group.

add

Add a GXF entity to the entity group

Overload 2

Overload 3

void holoscan::gxf::EntityGroup::add(
    gxf_uid_t eid
)

Add a GXF entity to the entity group.

If the entity is already a member of a different entity group, it will be removed from that group and added to this one.

Will raise a runtime_error if the entity is already a member of this entity group.

Parameters

eid

gxf_uid_t

The GXF unique id corresponding to the entity.

Member variables

Name	Type	Description
`name_`	`std::string`	The name of the entity group.
`gxf_context_`	`gxf_context_t`	The GXF context.
`gxf_gid_`	`gxf_uid_t`	The GXF group id.