iceoryx_posh 2.0.3
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
iox::mepoo::MemoryInfo Struct Reference

Stores properties of the memory to be used when we distinguish between different types of memory on e.g. different devices with different characteristics. More...

#include <iceoryx_posh/mepoo/memory_info.hpp>

Public Member Functions

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

Public Attributes

uint32_t deviceId {DEFAULT_DEVICE_ID}
 
uint32_t memoryType {DEFAULT_MEMORY_TYPE}
 

Static Public Attributes

static constexpr uint32_t DEFAULT_DEVICE_ID {0U}
 
static constexpr uint32_t DEFAULT_MEMORY_TYPE {0U}
 

Detailed Description

Stores properties of the memory to be used when we distinguish between different types of memory on e.g. different devices with different characteristics.

Constructor & Destructor Documentation

◆ MemoryInfo()

iox::mepoo::MemoryInfo::MemoryInfo ( uint32_t  deviceId = DEFAULT_DEVICE_ID,
uint32_t  memoryType = DEFAULT_MEMORY_TYPE 
)
explicitnoexcept

creates a MemoryInfo object

Parameters
[in]deviceIdspecifies the device where the memory is located
[in]memoryTypeencodes additional information about the memory

Member Function Documentation

◆ operator==()

bool iox::mepoo::MemoryInfo::operator== ( const MemoryInfo rhs) const
noexcept

comparison operator

Parameters
[in]rhsthe right hand side of the comparison

The documentation for this struct was generated from the following file: