iox::mepoo::MemoryInfo

Stores properties of the memory to be used when we distinguish between different types of memory on e.g. different devices with different characteristics. #include <iceoryx_posh/mepoo/memory_info.hpp>

Public Functions

	Name
	MemoryInfo(const MemoryInfo & ) =default
	MemoryInfo(MemoryInfo && ) =default
MemoryInfo &	operator=(const MemoryInfo & ) =default
MemoryInfo &	operator=(MemoryInfo && ) =default
	MemoryInfo(uint32_t deviceId =DEFAULT_DEVICE_ID, uint32_t memoryType =DEFAULT_MEMORY_TYPE) creates a MemoryInfo object
bool	operator==(const MemoryInfo & rhs) const comparison operator

Public Attributes

	Name
constexpr uint32_t	DEFAULT_DEVICE_ID
constexpr uint32_t	DEFAULT_MEMORY_TYPE
uint32_t	deviceId
uint32_t	memoryType

Public Functions Documentation

function MemoryInfo

MemoryInfo(
    const MemoryInfo & 
) =default

function MemoryInfo

MemoryInfo(
    MemoryInfo && 
) =default

function operator=

MemoryInfo & operator=(
    const MemoryInfo & 
) =default

function operator=

MemoryInfo & operator=(
    MemoryInfo && 
) =default

function MemoryInfo

explicit MemoryInfo(
    uint32_t deviceId =DEFAULT_DEVICE_ID,
    uint32_t memoryType =DEFAULT_MEMORY_TYPE
)

creates a MemoryInfo object

Parameters:

• deviceId specifies the device where the memory is located
• memoryType encodes additional information about the memory

function operator==

bool operator==(
    const MemoryInfo & rhs
) const

comparison operator

Parameters:

• rhs the right hand side of the comparison

Public Attributes Documentation

variable DEFAULT_DEVICE_ID

static constexpr uint32_t DEFAULT_DEVICE_ID {0U};

variable DEFAULT_MEMORY_TYPE

static constexpr uint32_t DEFAULT_MEMORY_TYPE {0U};

variable deviceId

uint32_t deviceId {DEFAULT_DEVICE_ID};

variable memoryType

uint32_t memoryType {DEFAULT_MEMORY_TYPE};

---

Updated on 18 December 2023 at 13:11:43 CET