holoscan::InterfacePort

Beta

Interface port that maps external subgraph port name to internal operator port(s).

For most ports, there is a single mapping. However, input interface ports can have multiple mappings, allowing a single external interface port to broadcast to multiple internal operators.

#include <holoscan/subgraph.hpp>

Methods

size

size_t holoscan::InterfacePort::size() const

Get number of mappings.

empty

bool holoscan::InterfacePort::empty() const

Check if empty.

add_mapping

void holoscan::InterfacePort::add_mapping(
    std::shared_ptr<Operator> op,
    std::string port_name
)

Add a mapping.

Types

PortType

Type of interface port.

Name	Value	Description
`kData`		Regular data port (for data flow).
`kExecution`		Execution control port (for control flow).

Member variables

Name	Type	Description
`mappings`	`std::vector< Mapping >`	List of internal operator/port mappings.
`is_input`	`bool`	Whether this is an input port (vs output).
`port_type`	`PortType`	Port type (data or execution).

Inner classes

Mapping

struct holoscan::InterfacePort::Mapping

A single mapping from external interface port to internal operator port.

Name	Type	Description
`internal_operator`	`std::shared_ptr< Operator >`	Internal operator that owns the port.
`internal_port_name`	`std::string`	Port name on the internal operator.