> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/holoscan/sdk-user-guide/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/holoscan/sdk-user-guide/_mcp/server.

# holoscan::gxf::ComponentInfo

> A class that encapsulates the information about a GXF component.

A class that encapsulates the information about a GXF component.

This class provides methods to access various properties of a GXF component, such as its receiver and transmitter TIDs, parameter keys, parameter infos, etc.

```cpp showLineNumbers={false}
#include <holoscan/gxf/gxf_component_info.hpp>
```

---

## Constructors

### ComponentInfo \[#componentinfo]

```cpp showLineNumbers={false}
holoscan::gxf::ComponentInfo::ComponentInfo(
    gxf_context_t context,
    gxf_tid_t tid
)
```

Construct a new component info object.

**Parameters**

**`context`** `gxf_context_t`

The GXF context.

---

**`tid`** `gxf_tid_t`

The TID of the component.

---

### Destructor \[#destructor]

### \~ComponentInfo

```cpp showLineNumbers={false}
holoscan::gxf::ComponentInfo::~ComponentInfo()
```

Destroy the component info object.

---

## Methods

### receiver\_tid \[#receivertid]

```cpp showLineNumbers={false}
gxf_tid_t holoscan::gxf::ComponentInfo::receiver_tid() const
```

Get the receiver TID of the component.

**Returns:** The receiver TID.

### transmitter\_tid \[#transmittertid]

```cpp showLineNumbers={false}
gxf_tid_t holoscan::gxf::ComponentInfo::transmitter_tid() const
```

Get the transmitter TID of the component.

**Returns:** The transmitter TID.

### component\_info \[#componentinfo]

```cpp showLineNumbers={false}
const gxf_component_info_t & holoscan::gxf::ComponentInfo::component_info() const
```

Get the component info.

**Returns:** The component info.

### parameter\_keys \[#parameterkeys]

```cpp showLineNumbers={false}
const std::vector<const char *> & holoscan::gxf::ComponentInfo::parameter_keys() const
```

Get the parameter keys of the component.

**Returns:** The parameter keys.

### parameter\_infos \[#parameterinfos]

```cpp showLineNumbers={false}
const std::vector<gxf_parameter_info_t> & holoscan::gxf::ComponentInfo::parameter_infos() const
```

Get the parameter infos of the component.

**Returns:** The parameter infos.

### parameter\_info\_map \[#parameterinfomap]

```cpp showLineNumbers={false}
const std::unordered_map<std::string, gxf_parameter_info_t> & holoscan::gxf::ComponentInfo::parameter_info_map() const
```

Get the parameter info map of the component.

**Returns:** The parameter info map.

### receiver\_parameters \[#receiverparameters]

```cpp showLineNumbers={false}
const std::vector<const char *> & holoscan::gxf::ComponentInfo::receiver_parameters() const
```

Get the receiver parameters of the component.

**Returns:** The receiver parameters.

### transmitter\_parameters \[#transmitterparameters]

```cpp showLineNumbers={false}
const std::vector<const char *> & holoscan::gxf::ComponentInfo::transmitter_parameters() const
```

Get the transmitter parameters of the component.

**Returns:** The transmitter parameters.

### normal\_parameters \[#normalparameters]

```cpp showLineNumbers={false}
const std::vector<const char *> & holoscan::gxf::ComponentInfo::normal_parameters() const
```

Get the normal parameters of the component.

**Returns:** The normal parameters.

---

## Static methods

### get\_arg\_type \[#getargtype]

```cpp showLineNumbers={false}
static ArgType holoscan::gxf::ComponentInfo::get_arg_type(
    const gxf_parameter_info_t &param_info
)
```

Get the arg type object.

Returns the Holoscan argument type for the given GXF parameter info.

**Returns:** The argument type of the parameter.

**Parameters**

**`param_info`** `const gxf_parameter_info_t &`

The GXF parameter info.

---

---

## Member variables

| Name                               | Type                                                      | Description                                        |
| ---------------------------------- | --------------------------------------------------------- | -------------------------------------------------- |
| `MAX_PARAM_COUNT` static constexpr | `int`                                                     | Maximum number of parameters a component can have. |
| `gxf_context_`                     | `gxf_context_t`                                           | The GXF context.                                   |
| `component_tid_`                   | `gxf_tid_t`                                               | The TID of the component.                          |
| `component_info_`                  | `gxf_component_info_t`                                    | The component info.                                |
| `parameter_keys_`                  | `std::vector< const char * >`                             | The parameter keys.                                |
| `parameter_infos_`                 | `std::vector< gxf_parameter_info_t >`                     | The parameter infos.                               |
| `parameter_info_map_`              | `std::unordered_map< std::string, gxf_parameter_info_t >` | The parameter info map.                            |
| `receiver_parameters_`             | `std::vector< const char * >`                             | The receiver parameters.                           |
| `transmitter_parameters_`          | `std::vector< const char * >`                             | The transmitter parameters.                        |
| `normal_parameters_`               | `std::vector< const char * >`                             | The normal parameters.                             |