SDK/MLReference/mlMemoryBlockHandle_8h_source.html

/*************************************************************************************

**

** Copyright 2008, MeVis Medical Solutions AG

**

** The user may use this file in accordance with the license agreement provided with

** the Software or, alternatively, in accordance with the terms contained in a

** written agreement between the user and MeVis Medical Solutions AG.

**

** For further information use the contact form at https://www.mevislab.de/contact

**

**************************************************************************************/


#ifndef ML_MEMORY_BLOCK_HANDLE_H

#define ML_MEMORY_BLOCK_HANDLE_H


#ifdef _MSC_VER

// Disable all system header warnings.

#pragma warning( push,0 )

#endif

#include <cstddef>

#ifdef _MSC_VER

#pragma warning( pop )

#endif


#include "../mlMemoryManagerDllExport.h"


class MLMemoryBlock;

class MLWeakMemoryBlockHandle;


class MLMEMORYMANAGER_EXPORT MLMemoryBlockHandle

{

public:

  MLMemoryBlockHandle();

  MLMemoryBlockHandle(const MLMemoryBlockHandle& memoryBlockHandle);

  MLMemoryBlockHandle(const MLWeakMemoryBlockHandle& weakMemoryBlockHandle);


  ~MLMemoryBlockHandle();


  bool isNull() const;


  void* data() const;


  size_t size() const;


  void clear();


  MLMemoryBlockHandle& operator=(const MLMemoryBlockHandle& memoryBlockHandle);


  MLMemoryBlockHandle& operator=(const MLWeakMemoryBlockHandle& weakMemoryBlockHandle);


 // End of group ThreadSafe


#ifndef DOXYGEN_SHOULD_SKIP_THIS


private:

  void setMemoryBlockFromStrongHandle(const MLMemoryBlockHandle& memoryBlockHandle);

  void setMemoryBlockFromWeakHandle(const MLWeakMemoryBlockHandle& weakMemoryBlockHandle);


private:

  MLMemoryBlock* _memoryBlock;


  friend class MLMemoryBlock;

  friend class MLMemoryManager;

  friend class MLWeakMemoryBlockHandle;

#endif

};


#endif // MLMEMORYBLOCKHandle_H_INCLUDED

MLMemoryBlockHandle
The strong handle of a MLMemoryBlock.
Definition mlMemoryBlockHandle.h:39

MLMemoryBlockHandle::MLMemoryBlockHandle
MLMemoryBlockHandle()
Creates a memory block handle that is null.

MLMemoryBlockHandle::MLMemoryBlockHandle
MLMemoryBlockHandle(const MLWeakMemoryBlockHandle &weakMemoryBlockHandle)
Creates an memory block handle to the memory block of weakMemoryBlockHandle.

MLMemoryBlockHandle::~MLMemoryBlockHandle
~MLMemoryBlockHandle()
If only weak handles to the memory block exist, then the memory block is added to the cache list.

MLMemoryBlockHandle::size
size_t size() const
Returns the size of the data. If this handle is null, then 0 is returned.

MLMemoryBlockHandle::isNull
bool isNull() const
Returns true if the handle does not reference a valid memory block.

MLMemoryBlockHandle::clear
void clear()
Releases the reference to the memory block.

MLMemoryBlockHandle::MLMemoryBlockHandle
MLMemoryBlockHandle(const MLMemoryBlockHandle &memoryBlockHandle)
Creates an additional memory block handle to the memory block of memoryBlockHandle.

MLMemoryBlockHandle::data
void * data() const
Returns the data of the memory block. If this handle is null, then NULL is returned.

MLMemoryManager
The memory manager.
Definition mlMemoryManager.h:87

MLWeakMemoryBlockHandle
The weak handle of a MLMemoryBlock.
Definition mlWeakMemoryBlockHandle.h:27

MLMemoryBlockHandle::operator=
MLMemoryBlockHandle & operator=(const MLWeakMemoryBlockHandle &weakMemoryBlockHandle)
Creates a memory block handle from the weak memory block handle.

MLMemoryBlockHandle::operator=
MLMemoryBlockHandle & operator=(const MLMemoryBlockHandle &memoryBlockHandle)
Creates a memory block handle from the memory block handle.