Gray C++ Libraries  0.0.2
A set of C++ libraries for MSVC, GNU on Windows, WinCE, Linux
Gray::cThreadLockArrayValue< TYPE, _TYPE_KEY > Class Template Reference

#include <cThreadArray.h>

Inheritance diagram for Gray::cThreadLockArrayValue< TYPE, _TYPE_KEY >:
Gray::cArraySortValue< TYPE, ITERATE_t > Gray::cArraySortRef< TYPE, TYPE_KEY > Gray::cArraySortFacade< cRefPtr< TYPE >, TYPE *, TYPE_KEY > Gray::cArraySorted< TYPE, TYPE_ARG, TYPE_KEY > Gray::cArrayTyped< TYPE, TYPE_ARG > Gray::CArray< TYPE, ARG_TYPE > Gray::CObject

Public Member Functions

 cThreadLockArrayValue ()
 
 ~cThreadLockArrayValue ()
 
ITERATE_t GetSize () const
 
cRefPtr< TYPEGetAtCheck (ITERATE_t nIndex) const
 
ITERATE_t Add (TYPE *pObj)
 
ITERATE_t AddAfter (TYPE *pObj)
 
cRefPtr< TYPEPopHead ()
 
cRefPtr< TYPEPopTail ()
 
bool RemoveArg (TYPE *pObj)
 
void RemoveAll ()
 
void DisposeAll ()
 
cRefPtr< TYPEFindArgForKey (_TYPE_KEY index) const
 

Public Attributes

cThreadLockCount m_Lock
 

Additional Inherited Members

- Protected Types inherited from Gray::cArraySortValue< TYPE, ITERATE_t >
typedef cArraySortRef< TYPE, ITERATE_tSUPER_t
 
typedef SUPER_t::REF_t REF_t
 
typedef SUPER_t::KEY_t KEY_t
 
- Protected Types inherited from Gray::cArraySortFacade< cRefPtr< TYPE >, TYPE *, TYPE_KEY >
typedef cArraySorted< cRefPtr< TYPE >, TYPE *, TYPE_KEY > SUPER_t
 
typedef SUPER_t::REF_t REF_t
 
typedef SUPER_t::ELEM_t ELEM_t
 
- Protected Types inherited from Gray::cArraySorted< TYPE, TYPE_ARG, TYPE_KEY >
typedef cArrayTyped< TYPE, TYPE_ARG > SUPER_t
 
typedef TYPE_KEY KEY_t
 
typedef SUPER_t::REF_t REF_t
 
- Protected Types inherited from Gray::cArrayTyped< TYPE, TYPE_ARG >
typedef CArray< TYPE, TYPE_ARG > SUPER_t
 
typedef cArrayTyped< TYPE, TYPE_ARG > THIS_t
 
typedef ITERATE_t iterator
 
typedef ITERATE_t const_iterator
 
typedef TYPE ELEM_t
 What type is stored. More...
 
typedef TYPE_ARG REF_t
 How to refer to this? value or ref or pointer? More...
 
- Protected Member Functions inherited from Gray::cArraySortValue< TYPE, ITERATE_t >
virtual COMPARE_t CompareData (REF_t pData1, REF_t pData2) const noexcept override
 
virtual COMPARE_t CompareKey (KEY_t key1, REF_t pBase) const override
 
virtual ~cArraySortValue ()
 
ITERATE_t FindIForAK (const TYPE *pBase) const
 
bool RemoveArgKey (TYPE *pBase)
 
ITERATE_t AddAfter (TYPE *pBase)
 
- Protected Member Functions inherited from Gray::cArraySortRef< TYPE, TYPE_KEY >
void DisposeAll ()
 
virtual ~cArraySortFacade ()
 
bool IsValidIndex (ITERATE_t i) const noexcept
 
REF_t GetAt (ITERATE_t index) const noexcept
 
REF_t GetAtCheck (ITERATE_t nIndex) const
 
TYPEFindArgForKey (TYPE_KEY key1) const noexcept
 
ITERATE_t FindIForAC_BRUTEFORCE (const TYPE * pData) const
 
ELEM_t PopHead ()
 
ELEM_t PopTail ()
 
void DeleteAll ()
 
- Protected Member Functions inherited from Gray::cArraySorted< TYPE, TYPE_ARG, TYPE_KEY >
virtual COMPARE_t CompareKey (KEY_t key1, REF_t Data2) const
 
bool RemoveArgKey (REF_t pObj, KEY_t key)
 
virtual ~cArraySorted ()
 
ITERATE_t FindINear (REF_t pNew, COMPARE_t &iCompareRes) const
 
ITERATE_t FindINearKey (KEY_t key, COMPARE_t &iCompareRes) const
 
ITERATE_t FindIForKey (KEY_t key) const
 
ITERATE_t FindIFirstForKey (TYPE_KEY nKey) const
 
ITERATE_t FindILastForKey (TYPE_KEY nKey) const
 
ITERATE_t AddPresorted (ITERATE_t index, COMPARE_t iCompareRes, TYPE_ARG pNew)
 
bool RemoveKey (TYPE_KEY key)
 
ITERATE_t Add (TYPE_ARG pNew)
 
void AddArray (const SUPER_t &a)
 
- Protected Member Functions inherited from Gray::cArrayTyped< TYPE, TYPE_ARG >
ITERATE_t QSortPartition (ITERATE_t iLeft, ITERATE_t iRight)
 
void QSort (ITERATE_t iLeft, ITERATE_t iRight)
 
void QSort ()
 
 cArrayTyped () noexcept
 
 cArrayTyped (const THIS_t &rArray)
 
 cArrayTyped (ITERATE_t iSize)
 
virtual ~cArrayTyped ()
 
bool isValidCheck () const noexcept
 < memory allocation and structure definitions are valid. More...
 
bool IsValidIndex (ITERATE_t i) const noexcept
 
ITERATE_t ClampValidIndex (ITERATE_t i) const noexcept
 
size_t GetHeapStats (OUT ITERATE_t &iAllocCount) const noexcept
 
void AssertValidIndex (ITERATE_t nIndex) const
 
const TYPEGetAtSecure (ITERATE_t nIndex) const
 
TYPEElementAtSecure (ITERATE_t nIndex)
 
REF_t ConstElementAt (ITERATE_t nIndex) const
 
TYPEoperator[] (ITERATE_t nIndex)
 
const TYPEoperator[] (ITERATE_t nIndex) const
 
TYPEHead ()
 
TYPETail ()
 
TYPEElementAtHead ()
 
TYPEElementAtTail ()
 
REF_t ConstHead () const
 
REF_t ConstTail () const
 
REF_t GetAtTail ()
 
void UnLinkIndex (ITERATE_t nIndex)
 
void Swap (ITERATE_t i, ITERATE_t j)
 
void SetCopy (const cArrayTyped< TYPE, TYPE_ARG > &aValues)
 
const cArrayTyped< TYPE, TYPE_ARG > & operator= (const cArrayTyped< TYPE, TYPE_ARG > &aValues)
 
ITERATE_t FindIFor (TYPE_ARG arg) const
 
bool HasArg (TYPE_ARG arg) const
 
void RemoveLast ()
 
ELEM_t PopHead ()
 
ELEM_t PopTail ()
 
bool RemoveArg (TYPE_ARG arg)
 
void UnLinkArg (TYPE_ARG arg)
 
ITERATE_t AddTail (TYPE_ARG newElement)
 
ITERATE_t PushTail (TYPE_ARG newElement)
 
void AddHead (TYPE_ARG newElement)
 
TYPEget_DataWork () const
 
void AddArray (const SUPER_t &src)
 
bool IsEqualArray (const SUPER_t &aValues) const
 
bool isArraySorted () const
 
bool isArraySortedND () const
 
- Protected Member Functions inherited from Gray::CArray< TYPE, ARG_TYPE >
bool IsValidIndex (ITERATE_t i) const noexcept
 
 CArray () noexcept
 
 CArray (THIS_t &&ref) noexcept
 
virtual ~CArray ()
 
bool IsValidMallocSize () const noexcept
 
ITERATE_t GetSize () const noexcept
 
ITERATE_t GetUpperBound () const noexcept
 
bool IsEmpty () const noexcept
 
void SetSize (ITERATE_t nNewSize)
 
ITERATE_t GetMallocSize () const noexcept
 
void RemoveAll ()
 Clean up. More...
 
const TYPEGetAt (ITERATE_t nIndex) const
 
TYPEElementAt (ITERATE_t nIndex)
 
void SetAt (ITERATE_t nIndex, ARG_TYPE newElement)
 
const TYPEGetData () const
 
TYPEGetData ()
 
void SetDataArrayPtr (TYPE *pData, ITERATE_t nSize)
 
void SetAtGrow (ITERATE_t nIndex, ARG_TYPE newElement)
 
ITERATE_t Add (ARG_TYPE newElement)
 
void Copy (const CArray &src)
 
TYPEoperator[] (ITERATE_t nIndex)
 
const TYPEoperator[] (ITERATE_t nIndex) const
 
void InsertAt (ITERATE_t nIndex, ARG_TYPE newElement)
 
void RemoveAt (ITERATE_t nIndex)
 
void RemoveAt (ITERATE_t nIndex, ITERATE_t iQty)
 
void MoveElement (ITERATE_t iFrom, ITERATE_t iTo)
 
- Protected Member Functions inherited from Gray::CObject
virtual ~CObject ()
 
virtual void AssertValid () const
 < memory allocation and structure definitions are valid. More...
 
virtual void Serialize (cArchive &a)
 
- Protected Attributes inherited from Gray::CArray< TYPE, ARG_TYPE >
TYPEm_pData
 the actual array of data More...
 
ITERATE_t m_nSize
 Number of elements (upperBound - 1) More...
 

Detailed Description

template<class TYPE, class _TYPE_KEY = ITERATE_t>
class Gray::cThreadLockArrayValue< TYPE, _TYPE_KEY >

Thread safe array TYPE must support get_SortValue() and be cRefBase does allow dupe get_SortValue but not dupe objects

Constructor & Destructor Documentation

◆ cThreadLockArrayValue()

template<class TYPE , class _TYPE_KEY = ITERATE_t>
Gray::cThreadLockArrayValue< TYPE, _TYPE_KEY >::cThreadLockArrayValue ( )
inline

◆ ~cThreadLockArrayValue()

template<class TYPE , class _TYPE_KEY = ITERATE_t>
Gray::cThreadLockArrayValue< TYPE, _TYPE_KEY >::~cThreadLockArrayValue ( )
inline

Member Function Documentation

◆ Add()

template<class TYPE , class _TYPE_KEY = ITERATE_t>
ITERATE_t Gray::cThreadLockArrayValue< TYPE, _TYPE_KEY >::Add ( TYPE pObj)
inline

◆ AddAfter()

template<class TYPE , class _TYPE_KEY = ITERATE_t>
ITERATE_t Gray::cThreadLockArrayValue< TYPE, _TYPE_KEY >::AddAfter ( TYPE pObj)
inline

◆ DisposeAll()

template<class TYPE , class _TYPE_KEY = ITERATE_t>
void Gray::cThreadLockArrayValue< TYPE, _TYPE_KEY >::DisposeAll ( void  )
inline

ASSUME TYPE supports DisposeThis(); like cXObject

◆ FindArgForKey()

template<class TYPE , class _TYPE_KEY = ITERATE_t>
cRefPtr<TYPE> Gray::cThreadLockArrayValue< TYPE, _TYPE_KEY >::FindArgForKey ( _TYPE_KEY  index) const
inline

◆ GetAtCheck()

template<class TYPE , class _TYPE_KEY = ITERATE_t>
cRefPtr<TYPE> Gray::cThreadLockArrayValue< TYPE, _TYPE_KEY >::GetAtCheck ( ITERATE_t  nIndex) const
inline
Note
Its slightly dangerous to enum a thread used list. We could read the same entry 2 times !
NEVER NEVER lock the list and the object at the same time! This could create a permanent deadlock!

◆ GetSize()

template<class TYPE , class _TYPE_KEY = ITERATE_t>
ITERATE_t Gray::cThreadLockArrayValue< TYPE, _TYPE_KEY >::GetSize ( ) const
inline

Used for statistical purposes. This may change of course.

◆ PopHead()

template<class TYPE , class _TYPE_KEY = ITERATE_t>
cRefPtr<TYPE> Gray::cThreadLockArrayValue< TYPE, _TYPE_KEY >::PopHead ( )
inline

◆ PopTail()

template<class TYPE , class _TYPE_KEY = ITERATE_t>
cRefPtr<TYPE> Gray::cThreadLockArrayValue< TYPE, _TYPE_KEY >::PopTail ( )
inline

◆ RemoveAll()

template<class TYPE , class _TYPE_KEY = ITERATE_t>
void Gray::cThreadLockArrayValue< TYPE, _TYPE_KEY >::RemoveAll ( )
inline

◆ RemoveArg()

template<class TYPE , class _TYPE_KEY = ITERATE_t>
bool Gray::cThreadLockArrayValue< TYPE, _TYPE_KEY >::RemoveArg ( TYPE pObj)
inline

Since this can have dupes we should not use RemoveArgKey()

Returns
true = removed. false = was not here.

Member Data Documentation

◆ m_Lock

template<class TYPE , class _TYPE_KEY = ITERATE_t>
cThreadLockCount Gray::cThreadLockArrayValue< TYPE, _TYPE_KEY >::m_Lock
mutable

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