Tekkotsu Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

ListMemBuf< T_t, MAX, idx_t > Class Template Reference

Provides some degree of dynamic allocation of a templated type from a buffer of set size. More...

#include <ListMemBuf.h>

Inheritance diagram for ListMemBuf< T_t, MAX, idx_t >:

Detailed Description

template<class T_t, unsigned int MAX, class idx_t = unsigned short>
class ListMemBuf< T_t, MAX, idx_t >

Provides some degree of dynamic allocation of a templated type from a buffer of set size.

Think of this as a self-contained mini-malloc...

This is handy for classes which inhabit a shared memory region, where it's a bad idea to have pointers to other memory. By instantiating one of these in your class, you can allocate space internally for up to MAX objects of type T_t. ListMemBuf will worry about keeping track of which ones are in use or are free.

Each time you request a entry to be created, the destructor will be called followed by the the defaul constructor before it is given to you, so the fields should be reliably 'fresh', not what was in the entry last time it was used.

Definition at line 20 of file ListMemBuf.h.

List of all members.

Classes

struct  entry_t
 holds data about an entry in the free/used lists More...

Public Types

typedef T_t T
 Allows outside access to storage type.
typedef idx_t index_t
 Allows outside access to index type.

Public Member Functions

 ListMemBuf ()
 constructor
 ~ListMemBuf ()
 destructor
index_t size () const
 returns the current number of objects in use
index_t countf () const
 for debugging, should equal size
index_t countb () const
 for debugging, should equal size
bool empty () const
 returns true if no objects are in use
Toperator[] (unsigned int x)
 allows direct access to elements - be careful, can access 'free' elements this way
const Toperator[] (unsigned int x) const
 allows direct access to elements - be careful, can access 'free' elements this way
index_t begin () const
 returns index of first used entry
Tfront ()
 returns reference to first used entry
const Tfront () const
 returns const reference to first used entry
index_t end () const
 returns the one-past-end index
Tback ()
 returns reference to last used entry
const Tback () const
 returns const reference to last used entry
index_t new_front ()
 pushes a 'blank' entry on the front of the used list
index_t push_front (const T &data)
 pushes an entry on the front of the used chain and assigns data to it
void pop_front ()
 pops the front of the used chain
void pop_front (T &ret)
 pops the front of the chain into ret
index_t new_back ()
 pushes a 'blank' entry on the back of the used list
index_t push_back (const T &data)
 pushes an entry on the back of the used chain and assigns data to it
void pop_back ()
 pops the last of the used chain
void pop_back (T &ret)
 pops the last of the used chain into ret
index_t new_before (index_t x)
 inserts a 'blank' entry before element x in the used chain
index_t push_before (index_t x, const T &data)
 inserts a 'blank' entry before element x in the used chain and assigns data to it
index_t new_after (index_t x)
 inserts a 'blank' entry after element x in the used chain
index_t push_after (index_t x, const T &data)
 inserts a 'blank' entry after element x in the used chain and assigns data to it
void erase (index_t x)
 removes element x from the used chain
void clear ()
 frees all used entries
void swap (index_t a, index_t b)
 swaps the two entries' position in the list
index_t next (index_t x) const
 returns the next used element following x
index_t prev (index_t x) const
 returns the preceeding used element following x

Static Public Member Functions

static index_t getMaxCapacity ()
 returns the maximum number of objects which can be used at any given time

Static Public Attributes

static const unsigned int MAX_ENTRIES = MAX
 Allows outside access to number of entries.

Protected Member Functions

index_t pop_free ()
 removes an element from the front of the free list, returns its index
void push_free (index_t x)
 pushes x onto the back of the free list

Protected Attributes

entry_t entries [MAX_ENTRIES==0?1:MAX_ENTRIES]
 the main block of data; must have at least 1 element due to limitation of older compilers
index_t activeBegin
 beginning of used chain
index_t activeBack
 end of used chain
index_t freeBegin
 beginning of free chain
index_t freeBack
 end of free chain
index_t cursize
 current number of used elements

Member Typedef Documentation

template<class T_t, unsigned int MAX, class idx_t = unsigned short>
typedef idx_t ListMemBuf< T_t, MAX, idx_t >::index_t

Allows outside access to index type.

Definition at line 31 of file ListMemBuf.h.

template<class T_t, unsigned int MAX, class idx_t = unsigned short>
typedef T_t ListMemBuf< T_t, MAX, idx_t >::T

Allows outside access to storage type.

Definition at line 27 of file ListMemBuf.h.


Constructor & Destructor Documentation

template<class T , unsigned int MAX, class index_t >
ListMemBuf< T, MAX, index_t >::ListMemBuf (  ) 

constructor

Definition at line 98 of file ListMemBuf.h.

template<class T , unsigned int MAX, class index_t >
ListMemBuf< T, MAX, index_t >::~ListMemBuf (  ) 

destructor

Definition at line 109 of file ListMemBuf.h.


Member Function Documentation

template<class T_t, unsigned int MAX, class idx_t = unsigned short>
const T& ListMemBuf< T_t, MAX, idx_t >::back (  )  const

returns const reference to last used entry

Definition at line 51 of file ListMemBuf.h.

template<class T_t, unsigned int MAX, class idx_t = unsigned short>
T& ListMemBuf< T_t, MAX, idx_t >::back (  ) 

returns reference to last used entry

Definition at line 50 of file ListMemBuf.h.

Referenced by MotionSequenceMC< MAXMOVE >::clear(), ListMemBuf< Move, MAXMOVE, Move_idx_t >::pop_back(), and SoundManager::selectChannels().

template<class T , unsigned int MAX, class index_t >
void ListMemBuf< T, MAX, index_t >::clear (  ) 
template<class T , unsigned int MAX, class index_t >
index_t ListMemBuf< T, MAX, index_t >::countb (  )  const

for debugging, should equal size

Definition at line 124 of file ListMemBuf.h.

template<class T , unsigned int MAX, class index_t >
index_t ListMemBuf< T, MAX, index_t >::countf (  )  const

for debugging, should equal size

Definition at line 115 of file ListMemBuf.h.

template<class T_t, unsigned int MAX, class idx_t = unsigned short>
bool ListMemBuf< T_t, MAX, idx_t >::empty (  )  const
template<class T_t, unsigned int MAX, class idx_t = unsigned short>
index_t ListMemBuf< T_t, MAX, idx_t >::end (  )  const

returns the one-past-end index

Definition at line 49 of file ListMemBuf.h.

Referenced by MessageQueue< MAX_UNREAD, MAX_RECEIVERS, MAX_SENDERS >::addReadStatusListener(), MessageQueue< MAX_UNREAD, MAX_RECEIVERS, MAX_SENDERS >::addReceiver(), ListMemBuf< T_t, MAX, idx_t >::clear(), ListMemBuf< T_t, MAX, idx_t >::countb(), ListMemBuf< T_t, MAX, idx_t >::countf(), MotionManager::doAddMotion(), RegionRegistry< MAX_REGIONS, NAME_LEN >::end(), MotionManager::end(), RegionRegistry< MAX_REGIONS, NAME_LEN >::findRegion(), MotionManager::getOutputs(), SemaphoreManager::getSemaphore(), SemaphoreManager::init(), SemaphoreManager::invalid(), MessageQueue< MAX_UNREAD, MAX_RECEIVERS, MAX_SENDERS >::isEnd(), ListMemBuf< T_t, MAX, idx_t >::ListMemBuf(), SoundManager::lookupPath(), MessageQueue< MAX_UNREAD, MAX_RECEIVERS, MAX_SENDERS >::lookupReceiver(), MessageQueue< MAX_UNREAD, MAX_RECEIVERS, MAX_SENDERS >::markRead(), MotionManager::motionReport(), ListMemBuf< T_t, MAX, idx_t >::new_back(), ListMemBuf< T_t, MAX, idx_t >::new_before(), ListMemBuf< T_t, MAX, idx_t >::new_front(), MessageQueue< MAX_UNREAD, MAX_RECEIVERS, MAX_SENDERS >::newest(), ListMemBuf< Move, MAXMOVE, Move_idx_t >::next(), SemaphoreManager::operator=(), SoundManager::pausePlay(), ListMemBuf< T_t, MAX, idx_t >::pop_back(), ListMemBuf< T_t, MAX, idx_t >::pop_free(), ListMemBuf< T_t, MAX, idx_t >::pop_front(), ListMemBuf< Move, MAXMOVE, Move_idx_t >::prev(), SoundManager::ProcessMsg(), ListMemBuf< Move, MAXMOVE, Move_idx_t >::push_after(), ListMemBuf< Move, MAXMOVE, Move_idx_t >::push_back(), ListMemBuf< Move, MAXMOVE, Move_idx_t >::push_before(), ListMemBuf< T_t, MAX, idx_t >::push_free(), ListMemBuf< Move, MAXMOVE, Move_idx_t >::push_front(), MessageQueue< MAX_UNREAD, MAX_RECEIVERS, MAX_SENDERS >::readMessage(), MotionManager::RemoveAccess(), MessageQueue< MAX_UNREAD, MAX_RECEIVERS, MAX_SENDERS >::removeReadStatusListener(), MessageQueue< MAX_UNREAD, MAX_RECEIVERS, MAX_SENDERS >::removeReceiver(), SoundManager::resumePlay(), SoundManager::selectChannels(), MessageQueue< MAX_UNREAD, MAX_RECEIVERS, MAX_SENDERS >::sendMessage(), MotionManager::setOutput(), MotionManager::setPID(), MotionManager::skip_ahead(), SoundManager::stopPlay(), ListMemBuf< T_t, MAX, idx_t >::swap(), and SoundManager::updateChannels().

template<class T_t, unsigned int MAX, class idx_t = unsigned short>
const T& ListMemBuf< T_t, MAX, idx_t >::front (  )  const

returns const reference to first used entry

Definition at line 47 of file ListMemBuf.h.

template<class T_t, unsigned int MAX, class idx_t = unsigned short>
T& ListMemBuf< T_t, MAX, idx_t >::front (  ) 
template<class T_t, unsigned int MAX, class idx_t = unsigned short>
static index_t ListMemBuf< T_t, MAX, idx_t >::getMaxCapacity (  )  [static]

returns the maximum number of objects which can be used at any given time

Definition at line 33 of file ListMemBuf.h.

Referenced by MotionSequenceMC< MAXMOVE >::getMaxFrames(), and MessageQueue< MAX_UNREAD, MAX_RECEIVERS, MAX_SENDERS >::sendMessage().

template<class T_t, unsigned int MAX, class idx_t = unsigned short>
index_t ListMemBuf< T_t, MAX, idx_t >::new_after ( index_t  x  ) 

inserts a 'blank' entry after element x in the used chain

Definition at line 66 of file ListMemBuf.h.

Referenced by ListMemBuf< Move, MAXMOVE, Move_idx_t >::push_after().

template<class T , unsigned int MAX, class index_t >
index_t ListMemBuf< T, MAX, index_t >::new_back (  ) 
template<class T , unsigned int MAX, class index_t >
index_t ListMemBuf< T, MAX, index_t >::new_before ( index_t  x  ) 

inserts a 'blank' entry before element x in the used chain

Definition at line 165 of file ListMemBuf.h.

Referenced by ListMemBuf< Move, MAXMOVE, Move_idx_t >::new_after(), and ListMemBuf< Move, MAXMOVE, Move_idx_t >::push_before().

template<class T_t, unsigned int MAX, class idx_t = unsigned short>
const T& ListMemBuf< T_t, MAX, idx_t >::operator[] ( unsigned int  x  )  const

allows direct access to elements - be careful, can access 'free' elements this way

Definition at line 43 of file ListMemBuf.h.

template<class T_t, unsigned int MAX, class idx_t = unsigned short>
T& ListMemBuf< T_t, MAX, idx_t >::operator[] ( unsigned int  x  ) 
template<class T_t, unsigned int MAX, class idx_t = unsigned short>
void ListMemBuf< T_t, MAX, idx_t >::pop_back ( T ret  ) 

pops the last of the used chain into ret

Definition at line 61 of file ListMemBuf.h.

Referenced by ListMemBuf< Move, MAXMOVE, Move_idx_t >::pop_back().

template<class T , unsigned int MAX, class index_t >
void ListMemBuf< T, MAX, index_t >::pop_back (  ) 

pops the last of the used chain

Definition at line 194 of file ListMemBuf.h.

Referenced by ListMemBuf< T_t, MAX, idx_t >::erase().

template<class T , unsigned int MAX, class index_t >
index_t ListMemBuf< T, MAX, index_t >::pop_free (  )  [protected]

removes an element from the front of the free list, returns its index

free list is a queue... pop front, push back - hopefully more robust with multi-threads is purposely sloppy with unused links, a little faster

Definition at line 319 of file ListMemBuf.h.

Referenced by ListMemBuf< T_t, MAX, idx_t >::new_back(), ListMemBuf< T_t, MAX, idx_t >::new_before(), and ListMemBuf< T_t, MAX, idx_t >::new_front().

template<class T_t, unsigned int MAX, class idx_t = unsigned short>
void ListMemBuf< T_t, MAX, idx_t >::pop_front ( T ret  ) 

pops the front of the chain into ret

Definition at line 56 of file ListMemBuf.h.

Referenced by ListMemBuf< Move, MAXMOVE, Move_idx_t >::pop_front().

template<class T_t, unsigned int MAX, class idx_t = unsigned short>
index_t ListMemBuf< T_t, MAX, idx_t >::push_after ( index_t  x,
const T data 
)

inserts a 'blank' entry after element x in the used chain and assigns data to it

Definition at line 67 of file ListMemBuf.h.

template<class T_t, unsigned int MAX, class idx_t = unsigned short>
index_t ListMemBuf< T_t, MAX, idx_t >::push_back ( const T data  ) 
template<class T_t, unsigned int MAX, class idx_t = unsigned short>
index_t ListMemBuf< T_t, MAX, idx_t >::push_before ( index_t  x,
const T data 
)

inserts a 'blank' entry before element x in the used chain and assigns data to it

Definition at line 64 of file ListMemBuf.h.

template<class T , unsigned int MAX, class index_t >
void ListMemBuf< T, MAX, index_t >::push_free ( index_t  x  )  [protected]

pushes x onto the back of the free list

See also:
pop_free()

Definition at line 335 of file ListMemBuf.h.

Referenced by ListMemBuf< T_t, MAX, idx_t >::erase(), ListMemBuf< T_t, MAX, idx_t >::pop_back(), and ListMemBuf< T_t, MAX, idx_t >::pop_front().

template<class T_t, unsigned int MAX, class idx_t = unsigned short>
index_t ListMemBuf< T_t, MAX, idx_t >::push_front ( const T data  ) 

pushes an entry on the front of the used chain and assigns data to it

Definition at line 54 of file ListMemBuf.h.

Referenced by SoundManager::play(), SoundManager::resumePlay(), and MotionManager::setOutput().

template<class T , unsigned int MAX, class index_t >
void ListMemBuf< T, MAX, index_t >::swap ( index_t  a,
index_t  b 
)

swaps the two entries' position in the list

Definition at line 238 of file ListMemBuf.h.

Referenced by MotionManager::getOutputs().


Member Data Documentation

template<class T_t, unsigned int MAX, class idx_t = unsigned short>
index_t ListMemBuf< T_t, MAX, idx_t >::cursize [protected]
template<class T_t, unsigned int MAX, class idx_t = unsigned short>
index_t ListMemBuf< T_t, MAX, idx_t >::freeBack [protected]
template<class T_t, unsigned int MAX, class idx_t = unsigned short>
index_t ListMemBuf< T_t, MAX, idx_t >::freeBegin [protected]
template<class T_t, unsigned int MAX, class idx_t = unsigned short>
const unsigned int ListMemBuf< T_t, MAX, idx_t >::MAX_ENTRIES = MAX [static]

Allows outside access to number of entries.

Definition at line 29 of file ListMemBuf.h.

Referenced by ListMemBuf< Move, MAXMOVE, Move_idx_t >::getMaxCapacity(), and ListMemBuf< T_t, MAX, idx_t >::ListMemBuf().


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

Tekkotsu v5.1CVS
Generated Mon May 9 04:59:12 2016 by Doxygen 1.6.3