ICF 3.1.1.10
Technical documentation of ICF Libraries
istd::COptMemory Class Reference

Memory block with optional deleting function used during destruction. More...

#include <COptMemory.h>

Collaboration diagram for istd::COptMemory:

Public Types

typedef std::function< void(void *)> ReleaseFn
 

Public Member Functions

 COptMemory (const COptMemory &ptr)=delete
 
 COptMemory (void *ptr=nullptr, ReleaseFn releaseFn=nullptr)
 Construct and init this pointer.
 
 COptMemory (void *ptr, bool releaseFlag)
 Construct and init this pointer.
 
 COptMemory (COptMemory &&ptr) noexcept
 Move constructor.
 
 COptMemory (std::unique_ptr< void > &&ptr)
 Construct and init this pointer using unique pointer.
 
 ~COptMemory ()
 Destructor.
 
bool IsToRelase () const
 Get state of release flag.
 
void Reset ()
 Remove object pointed by internal pointer and set this pointer to nullptr.
 
void * get () const
 Get value of internal pointer.
 
bool IsValid () const
 Check if internal pointer not nullptr.
 
void * release ()
 Reset internal pointer value without deleting instance and return previos value.
 
void SetPtr (void *ptr, ReleaseFn releaseFn=nullptr)
 Set new value of internal pointer.
 
COptMemory & operator= (const COptMemory &ptr)
 Assign operator.
 
COptMemory & operator= (COptMemory &&ptr)
 Assign move operator.
 
COptMemory & operator= (std::unique_ptr< void > &&ptr)
 Assign operator.
 
COptMemory & operator= (void *ptr)
 Assign operator.
 

Protected Member Functions

void Detach ()
 Remove referenced data.
 

Static Protected Member Functions

static void SimpleDeleter (void *ptr)
 

Detailed Description

Memory block with optional deleting function used during destruction.

Definition at line 20 of file COptMemory.h.

Member Typedef Documentation

◆ ReleaseFn

std::function<void (void*)> istd::COptMemory::ReleaseFn

Definition at line 23 of file COptMemory.h.

Constructor & Destructor Documentation

◆ COptMemory() [1/5]

istd::COptMemory::COptMemory ( const COptMemory & ptr)
delete

◆ COptMemory() [2/5]

istd::COptMemory::COptMemory ( void * ptr = nullptr,
ReleaseFn releaseFn = nullptr )
inline

Construct and init this pointer.

Parameters
ptrpointer to object.
releaseFnif set, pointed object will be automatically released by this function.

Definition at line 134 of file COptMemory.h.

◆ COptMemory() [3/5]

istd::COptMemory::COptMemory ( void * ptr,
bool releaseFlag )

Construct and init this pointer.

Parameters
ptrpointer to object.
releaseFlagif set, pointed object will be automatically deleted.

◆ COptMemory() [4/5]

istd::COptMemory::COptMemory ( COptMemory && ptr)
inlinenoexcept

Move constructor.

Definition at line 140 of file COptMemory.h.

◆ COptMemory() [5/5]

istd::COptMemory::COptMemory ( std::unique_ptr< void > && ptr)
inline

Construct and init this pointer using unique pointer.

Parameters
ptrpointer to object, responsibility will be overtaken.

Definition at line 147 of file COptMemory.h.

◆ ~COptMemory()

istd::COptMemory::~COptMemory ( )
inline

Destructor.

It calls Reset() to delete pointed object.

Definition at line 153 of file COptMemory.h.

References Detach().

Member Function Documentation

◆ Detach()

void istd::COptMemory::Detach ( )
protected

Remove referenced data.

Warning: internal pointer will be not changed.

Referenced by SetPtr(), and ~COptMemory().

◆ get()

void * istd::COptMemory::get ( ) const
inline

◆ IsToRelase()

bool istd::COptMemory::IsToRelase ( ) const
inline

Get state of release flag.

If this flag is true, pointed object will be automatically removed from memory. If this pointer isn't valid, returned value has no meaning.

Definition at line 165 of file COptMemory.h.

◆ IsValid()

bool istd::COptMemory::IsValid ( ) const
inline

Check if internal pointer not nullptr.

Returns
true, if internal pointer not nullptr and can be used to access pointed members.

Definition at line 177 of file COptMemory.h.

◆ operator=() [1/4]

COptMemory & istd::COptMemory::operator= ( const COptMemory & ptr)

Assign operator.

This implementation has no function and is provided only for compatibility with STL. The source pointer must be invalid (nullptr).

◆ operator=() [2/4]

COptMemory & istd::COptMemory::operator= ( COptMemory && ptr)

Assign move operator.

The source pointer must be invalid (nullptr) is it takes responsibility over the object life cycle.

◆ operator=() [3/4]

COptMemory & istd::COptMemory::operator= ( std::unique_ptr< void > && ptr)

Assign operator.

Move assignement of unique pointer.

◆ operator=() [4/4]

COptMemory & istd::COptMemory::operator= ( void * ptr)

Assign operator.

It removes refererenced object before new is assigned.

Parameters
ptrpointer to object.

◆ release()

void * istd::COptMemory::release ( )
inline

Reset internal pointer value without deleting instance and return previos value.

Definition at line 183 of file COptMemory.h.

◆ Reset()

void istd::COptMemory::Reset ( )
inline

Remove object pointed by internal pointer and set this pointer to nullptr.

Definition at line 159 of file COptMemory.h.

References SetPtr().

◆ SetPtr()

void istd::COptMemory::SetPtr ( void * ptr,
ReleaseFn releaseFn = nullptr )
inline

Set new value of internal pointer.

If internal pointer wasn't nullptr, it will be deleted.

Parameters
ptrpointer to object.
releaseFnif set, pointed object will be automatically released by this function.

Definition at line 194 of file COptMemory.h.

References Detach().

Referenced by Reset().

◆ SimpleDeleter()

static void istd::COptMemory::SimpleDeleter ( void * ptr)
staticprotected

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

© Witold Gantzke and Kirill Lepskiy