Struct PortConfigInfo

Defined in File port_config_info.hpp

Struct Documentation

struct PortConfigInfo

Stores information necessary to create the right type of port on RouDi side. Different types of ports are required if e.g. different types of shared memory are used (e.g. on GPU).

Public Functions

PortConfigInfo(const PortConfigInfo&) noexcept = default

PortConfigInfo(PortConfigInfo&&) noexcept = default

PortConfigInfo &operator=(const PortConfigInfo&) noexcept = default

PortConfigInfo &operator=(PortConfigInfo&&) noexcept = default

PortConfigInfo(uint32_t portType = DEFAULT_PORT_TYPE, uint32_t deviceId = DEFAULT_DEVICE_ID, uint32_t memoryType = DEFAULT_MEMORY_TYPE) noexcept

creates a PortConfigInfo object

Parameters:

portType – [in] specifies the type of port to be created
deviceId – [in] specifies the device the port operates on (CPU, GPUx etc.)
memoryType – [in] encodes additional information about the memory used by the port

PortConfigInfo(const cxx::Serialization &serialization) noexcept

creates a PortConfigInfo object from its serialization

Parameters:: serialization – [in] specifies the serialization from which the port is created

operator cxx::Serialization() const noexcept: creates a serilaization of the PortConfigInfo

bool operator==(const PortConfigInfo &rhs) const noexcept

comparison operator

Parameters:: rhs – [in] the right hand side of the comparison

Public Members

uint32_t portType = {DEFAULT_PORT_TYPE}

iox::mepoo::MemoryInfo memoryInfo

Public Static Attributes

static constexpr uint32_t DEFAULT_PORT_TYPE = {0U}

static constexpr uint32_t DEFAULT_DEVICE_ID = {0U}

static constexpr uint32_t DEFAULT_MEMORY_TYPE = {0U}