ucommon::ObjectPager Class Reference

Inheritance diagram for ucommon::ObjectPager:

Inheritance graph
[legend]
Collaboration diagram for ucommon::ObjectPager:

Collaboration graph
[legend]

Public Types

typedef linked_pointer< ObjectPager::memberiterator
 Convenience typedef for iterative pointer.

Public Member Functions

ObjectPager::memberbegin (void)
 Get root of pager list.
void clear (void)
 Purge all members and release pager member.
unsigned count (void)
 Get the number of items in the pager string list.
 operator bool ()
bool operator! ()
unsigned pages (void)
 Get the number of pages that have been allocated from the real heap.
size_t size (void)
 Get the size of a memory page.

Protected Member Functions

void * add (void)
 Add object to list.
void * get (unsigned item)
 Get object from list.
void * invalid (void)
 Invalid object.
void ** list (void)
 Gather index list.
 ObjectPager (size_t objsize, size_t pagesize=256)
void * pop (void)
 Remove element from back of list.
void * pull (void)
 Remove element from front of list.
void * push (void)

Data Structures

class  member

Detailed Description

Definition at line 243 of file memory.h.


Member Function Documentation

void* ucommon::ObjectPager::add ( void   )  [protected]

Add object to list.

Parameters:
object to add.

ObjectPager::member* ucommon::ObjectPager::begin ( void   )  [inline]

Get root of pager list.

This is useful for externally enumerating the list of strings.

Returns:
first member of list or NULL if empty.

Definition at line 324 of file memory.h.

void ucommon::ObjectPager::clear ( void   ) 

Purge all members and release pager member.

The list can then be added to again.

unsigned ucommon::ObjectPager::count ( void   )  [inline]

Get the number of items in the pager string list.

Returns:
number of items stored.

Definition at line 337 of file memory.h.

void* ucommon::ObjectPager::get ( unsigned  item  )  [protected]

Get object from list.

This is useful when objectpager is passed as a pointer and hence inconvenient for the [] operator.

Parameters:
item to access.
Returns:
pointer to text for item, or NULL if out of range.

void* ucommon::ObjectPager::invalid ( void   )  [protected]

Invalid object.

..

Returns:
typically NULL.

void** ucommon::ObjectPager::list ( void   )  [protected]

Gather index list.

Returns:
index.

Reimplemented in ucommon::listof< T, P >.

unsigned ucommon::ObjectPager::pages ( void   )  [inline]

Get the number of pages that have been allocated from the real heap.

Returns:
pages allocated from heap.

Reimplemented from ucommon::memalloc.

Definition at line 348 of file memory.h.

void* ucommon::ObjectPager::pop ( void   )  [protected]

Remove element from back of list.

Does not release memory.

Returns:
object removed.

Reimplemented in ucommon::listof< T, P >.

void* ucommon::ObjectPager::pull ( void   )  [protected]

Remove element from front of list.

Does not release memory.

Returns:
object removed.

Reimplemented in ucommon::listof< T, P >.

size_t ucommon::ObjectPager::size ( void   )  [inline]

Get the size of a memory page.

Returns:
size of each pager heap allocation.

Reimplemented from ucommon::memalloc.

Definition at line 345 of file memory.h.


The documentation for this class was generated from the following file:
Generated on 14 Aug 2013 for UCommon by  doxygen 1.4.7