Class Component

• Defined in File component.hpp

Base Type

• public holoscan::ComponentBase (Class ComponentBase)

Derived Types

• public holoscan::Condition (Class Condition)

• public holoscan::NetworkContext (Class NetworkContext)

• public holoscan::Resource (Class Resource)

• public holoscan::Scheduler (Class Scheduler)

class Component : public holoscan::ComponentBase

Common class for all non-Operator components.

This class is the base class for all non-Operator components including holoscan::Condition, holoscan::Resource, holoscan::NetworkContext, holoscan::Scheduler It is used to define the common interface for all components.

holoscan::Operator does not inherit from this class as it uses holoscan::OperatorSpec instead of holoscan::ComponentSpec.

Subclassed by holoscan::Condition, holoscan::NetworkContext, holoscan::Resource, holoscan::Scheduler

Public Functions

inline virtual void set_parameters()

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

inline Component &spec(const std::shared_ptr<ComponentSpec> &spec)

Set the component spec.

Parameters

spec – The component spec.

Returns

The reference to this component.

inline ComponentSpec *spec()

Get a pointer to the component spec.

Returns

The pointer to the component spec.

inline std::shared_ptr<ComponentSpec> spec_shared()

Get a shared pointer to the component spec.

Returns

The shared pointer to the component spec.

Protected Functions

void update_params_from_args()

Update parameters based on the specified arguments.

void update_params_from_args(std::unordered_map<std::string, ParameterWrapper> &params)

Update parameters based on the specified arguments.

Protected Attributes

std::shared_ptr<ComponentSpec> spec_

The component specification.