holoscan::NetworkContext

Beta

Base class for all network contexts.

This class is the base class for all network contexts (e.g. holoscan::UcxContext). It is used to define the common interface for all network contexts.

#include <holoscan/network_context.hpp>

Inherits from: holoscan::Component (public)

Constructors

NetworkContext

Default

Move

Move (with arg and args)

holoscan::NetworkContext::NetworkContext() = defaultholoscan::NetworkContext::NetworkContext() = default

Destructor

~NetworkContext

holoscan::NetworkContext::~NetworkContext() override = defaultholoscan::NetworkContext::~NetworkContext() override = default

Methods

id

Mutable

Const

NetworkContext & holoscan::NetworkContext::id(NetworkContext & holoscan::NetworkContext::id(
    int64_t id
)

Set the NetworkContext ID.

Returns: The reference to this network context.

Parameters

int64_t

The ID of the network context.

name

Set the name of the network context (1)

Set the name of the network context (2)

Const

NetworkContext & holoscan::NetworkContext::name(NetworkContext & holoscan::NetworkContext::name(
    const std::string &name
) &

Set the name of the network context.

Returns: The reference to the network context.

Parameters

name

const std::string &

The name of the network context.

fragment

Set the fragment of the network context

Get a pointer to Fragment object

Const

NetworkContext & holoscan::NetworkContext::fragment(NetworkContext & holoscan::NetworkContext::fragment(
    Fragment *fragment
)

Set the fragment of the network context.

Returns: The reference to the network context.

Parameters

fragment

Fragment *

The pointer to the fragment of the network context.

spec

Overload 1

Overload 2

NetworkContext & holoscan::NetworkContext::spec(NetworkContext & holoscan::NetworkContext::spec(
    const std::shared_ptr<ComponentSpec> &spec
)

Set the component specification to the network context.

Returns: The reference to the network context.

Parameters

spec

const std::shared_ptr<ComponentSpec> &

The component specification.

spec_shared

std::shared_ptr<ComponentSpec> holoscan::NetworkContext::spec_shared()std::shared_ptr<ComponentSpec> holoscan::NetworkContext::spec_shared()

Get the shared pointer to the component spec.

Returns: The shared pointer to the component spec.

add_arg

Add a resource to the network context (1)

Add a resource to the network context (2)

Add an argument to the component (1)

Add an argument to the component (2)

Add a list of arguments to the component (1)

Add a list of arguments to the component (2)

void holoscan::NetworkContext::add_arg(
    const std::shared_ptr<Resource> &arg
)

Add a resource to the network context.

Parameters

arg

const std::shared_ptr<Resource> &

The resource to add.

resources

std::unordered_map<std::string, std::shared_ptr<Resource>> & holoscan::NetworkContext::resources()std::unordered_map<std::string, std::shared_ptr<Resource>> & holoscan::NetworkContext::resources()

Get the resources of the network context.

Returns: The resources of the network context.

clock

virtual std::shared_ptr<Clock> holoscan::NetworkContext::clock()virtual std::shared_ptr<Clock> holoscan::NetworkContext::clock()

Get the Clock used by the network context.

Returns: The Clock used by the network context, or nullptr if not applicable.

setup

virtual void holoscan::NetworkContext::setup(
    ComponentSpec &spec
)

Define the network context specification.

Parameters

spec

ComponentSpec &

The reference to the component specification.

initialize

void holoscan::NetworkContext::initialize() override

Initialize the network context.

This function is called after the network context is created by holoscan::Fragment::make_network_context().

to_yaml_node

YAML::Node holoscan::NetworkContext::to_yaml_node() const override

Get a YAML representation of the network context.

Returns: YAML node including the base component properties, component spec and resources.

reset_backend_objects

void holoscan::NetworkContext::reset_backend_objects() override

Reset any backend-specific objects.

set_parameters

virtual void holoscan::NetworkContext::set_parameters()

Set the parameters based on defaults (sets GXF parameters for GXF operators).

args

std::vector<Arg> & holoscan::ComponentBase::args()std::vector<Arg> & holoscan::ComponentBase::args()

Get the list of arguments.

Returns: The vector of arguments.

description

std::string holoscan::ComponentBase::description() const

Get a description of the component.

Returns: YAML string.

See also: to_yaml_node()

service

template <typename ServiceT = DefaultFragmentService>
std::shared_ptr<ServiceT> holoscan::ComponentBase::service(
    std::string_view id = ""
) const

Retrieve a registered fragment service or resource.

Retrieves a previously registered fragment service or resource by its type and optional identifier. Returns nullptr if no service/resource is found with the specified type and identifier.

Note that any changes to the service retrieval logic in this method should be synchronized with the implementation in Fragment::service() method to maintain consistency.

Returns: The shared pointer to the service/resource, or nullptr if not found or if type casting fails.

Template parameters

ServiceT

typename

The type of the service/resource to retrieve. Must inherit from either Resource or FragmentService. Defaults to DefaultFragmentService if not specified.

Parameters

std::string_viewDefaults to ""

The identifier of the service/resource. If empty, retrieves by type only.

get_service_by_type_info

std::shared_ptr<FragmentService> holoscan::ComponentBase::get_service_by_type_info(std::shared_ptr<FragmentService> holoscan::ComponentBase::get_service_by_type_info(
    const std::type_info &service_type,
    std::string_view id = ""
) const

Retrieve a registered fragment service or resource for Python bindings.

This is a helper method for Python bindings to retrieve a service by its C++ type info.

Returns: The shared pointer to the base service, or nullptr if not found.

Parameters

service_type

const std::type_info &

The type info of the service/resource to retrieve.

std::string_viewDefaults to ""

The identifier of the service/resource. If empty, retrieves by type only.

update_params_from_args

Update parameters based on the specified arguments

Update parameters based on the specified arguments (with params)

void holoscan::NetworkContext::update_params_from_args()

Update parameters based on the specified arguments.

service_provider

void holoscan::ComponentBase::service_provider(
    FragmentServiceProvider *provider
)

Set the service provider that owns this component.

Static methods

register_converter

template <typename typeT>
static void holoscan::ComponentBase::register_converter()

If an operator or resource has an argument with a custom type, the argument setter must be registered using this method.

The argument setter is used to set the value of the argument from the YAML configuration.

This method can be called in the initialization phase of the operator/resource (e.g., initialize()). The example below shows how to register the argument setter for the custom type (Vec3):

It is assumed that YAML::convert<T>::encode and YAML::convert<T>::decode are implemented for the given type. You need to specialize the YAML::convert<> template class.

For example, suppose that you had a Vec3 class with the following members:

You can define the YAML::convert<Vec3> as follows in a ‘.cpp’ file:

Please refer to the yaml-cpp documentation for more details.

Template parameters

typeT

typename

The type of the argument to register.

Example

void MyOp::initialize() {
  register_converter<Vec3>();
}

Example

struct Vec3 {
  // make sure you have overloaded operator==() for the comparison
  double x, y, z;
};

Example

namespace YAML {
template<>
struct convert<Vec3> {
  static Node encode(const Vec3& rhs) {
    Node node;
    node.push_back(rhs.x);
    node.push_back(rhs.y);
    node.push_back(rhs.z);
    return node;
  }
  static bool decode(const Node& node, Vec3& rhs) {
    if(!node.IsSequence() || node.size() != 3) {
      return false;
    }
    rhs.x = node[0].as<double>();
    rhs.y = node[1].as<double>();
    rhs.z = node[2].as<double>();
    return true;
  }
};
}

register_argument_setter

template <typename typeT>
void holoscan::ComponentBase::register_argument_setter()

Please refer to the documentation of register_converter() for more details.

Template parameters

typeT

typename

The type of the argument to register.

Member variables

Name	Type	Description
`resources_`	`std::unordered_map< std::string, std::shared_ptr< Resource > >`	The resources used by the network context.
`spec_`	`std::shared_ptr< ComponentSpec >`	The component specification.
`id_`	`int64_t`	The ID of the component.
`name_`	`std::string`	Name of the component.
`fragment_`	`Fragment *`	Pointer to the fragment that owns this component.
`args_`	`std::vector< Arg >`	List of arguments.
`service_provider_`	`FragmentServiceProvider *`	Pointer to the service provider.