HiCR::backend::lpf::LocalMemorySlot Class Reference

#include <localMemorySlot.hpp>

Inheritance diagram for HiCR::backend::lpf::LocalMemorySlot:

Public Member Functions
	LocalMemorySlot (lpf_memslot_t lpfMemSlot, void *const pointer, const size_t size, std::shared_ptr< HiCR::MemorySpace > memorySpace)
	~LocalMemorySlot () override=default
lpf_memslot_t	getLPFSlot () const
void	setLPFSlot (lpf_memslot_t lpfMemSlot)
__INLINE__ void *	getLPFSwapPointer ()
Public Member Functions inherited from HiCR::LocalMemorySlot
	LocalMemorySlot (void *const pointer, const size_t size, std::shared_ptr< HiCR::MemorySpace > memorySpace=nullptr)
__INLINE__ void *&	getPointer () noexcept
__INLINE__ size_t	getSize () const noexcept
__INLINE__ std::shared_ptr< HiCR::MemorySpace >	getMemorySpace () const noexcept
__INLINE__ size_t	getMessagesRecv () const noexcept
__INLINE__ size_t	getMessagesSent () const noexcept

Detailed Description

This class is the definition for a Memory Slot resource for the LPF backend

Constructor & Destructor Documentation

LocalMemorySlot()

HiCR::backend::lpf::LocalMemorySlot::LocalMemorySlot ( lpf_memslot_t  lpfMemSlot, void *const  pointer, const size_t  size, std::shared_ptr< HiCR::MemorySpace >  memorySpace  )

inline

Constructor for a MemorySlot class for the LPF backend

Parameters

[in]	lpfMemSlot	LPF slot this HiCR slot is associated with
[in]	pointer	Pointer to the memory address associated with this HiCR slot
[in]	size	Comm size
[in]	memorySpace	The memory space from whence this memory slot was created

~LocalMemorySlot()

HiCR::backend::lpf::LocalMemorySlot::~LocalMemorySlot ( )

overridevirtualdefault

Default destructor

Reimplemented from HiCR::LocalMemorySlot.

Member Function Documentation

getLPFSlot()

lpf_memslot_t HiCR::backend::lpf::LocalMemorySlot::getLPFSlot ( ) const

inline

Get internal LPF slot (lpf_memslot_t) associated with this HiCR slot

Returns

LPF slot

getLPFSwapPointer()

__INLINE__ void * HiCR::backend::lpf::LocalMemorySlot::getLPFSwapPointer ( )

inline

Getter function for the memory slot's swap value pointer

Returns

The memory slot's swap value internal pointer

setLPFSlot()

void HiCR::backend::lpf::LocalMemorySlot::setLPFSlot ( lpf_memslot_t  lpfMemSlot )

inline

Parameters

[in]

lpfMemSlot

The LPF memory slot Set internal LPF slot (lpf_memslot_t) associated with this HiCR slot

---

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

• /home/runner/work/HiCR/HiCR/include/hicr/backends/lpf/localMemorySlot.hpp