TekArray Struct Reference

List of all members.

Public Attributes

unsigned long TekArraySize
uint8_t ** TekArrayAccessPoint
uint8_t * TekArrayMemoryLoc
unsigned long TekArrayMaxElements
unsigned long TekArrayElementSize
unsigned long TekArrayEnumLoc
unsigned int TekArrayRef
 TEKARRAY_MACRODEF

Detailed Description

This structure is used to maintain arrays in memory.

Author:
Kevin McBride

Definition at line 601 of file teklti.h.


Member Data Documentation

TEKARRAY_MACRODEF
 


TekArray Macros.


DEFINETEKARRAY(d) - Defines a TekArray element with name of d.
INITTEKARRAY(s, r, t) - Initializes an array of size s, with each element r bytes long, and returns the result in t.

GETTEKARRAYELEMENT(a, i) - Retrieves element number i from array a.

ADDTEKARRAYELEMENT(a, e) - Adds element e to array a.
REMOVETEKARRAYELEMENT(a, i, n) - Removes element number i from array a. n is a unsigned long to use for the deletion.
CLEARTEKARRAY(a) - Removes all elements from array a.

ADDREFTEKARRAY(a) - Adds a reference to a TekArray.
RELEASETEKARRAY(a) - Releases a reference from a TekArray, and if 0, the entire array is destroyed.

FOREACH_ELEMENT_IN_TEKARRAY(a, i) - Starts a "for each" block, putting next available element in i.
FOREACH_TEKSTD_IN_TEKARRAY(a, i) - Starts a "for each" block for TekStd elements in array a, putting next available element in i.
ENDFOR_TEKARRAY(a) - Ends a "for each" block.

Note: These six macros should be used with arrays containing TekStd inheriting classes.
INITTEKARRAY_TEKSTD(s, t) - Initializes an array of size s, with each element aligned for TekStd-inheriting classes, and returns the result in t.
ADDTEKARRAYELEMENT_TEKSTD(a, e) - Adds TekStd element e to array a.
REMOVETEKARRAYELEMENT_TEKSTD(a, i, n, t) - Removes TekStd element number i from a.
t is a TekStd * variable to borrow.
CLEARTEKARRAY_TEKSTD(a, n, t) - Removes all TekStd elements from array a.
n is a unsigned long to use for the releasing.
t is a TekStd * variable to borrow.
ADDREFTEKARRAY_TEKSTD(a) - Adds a reference to a TekArray.
RELEASETEKARRAY_TEKSTD(a, n, t) - Releases a reference from a TekArray, and if 0, the entire array is destroyed, and all references to held TekStd interfaces are Released.

Definition at line 674 of file teklti.h.

uint8_t** TekArrayAccessPoint
 

Holds the area to access the elements in.

Definition at line 610 of file teklti.h.

unsigned long TekArrayElementSize
 

Holds the size of each element.

Definition at line 622 of file teklti.h.

unsigned long TekArrayEnumLoc
 

Holds the item number for enumeration purposes.

Definition at line 626 of file teklti.h.

unsigned long TekArrayMaxElements
 

Holds the maximum element number allowed in the array.

Definition at line 618 of file teklti.h.

uint8_t* TekArrayMemoryLoc
 

Holds the location where the array is accessible in memory.

Definition at line 614 of file teklti.h.

unsigned int TekArrayRef
 

Holds the amount of references attatched to the array.

Definition at line 630 of file teklti.h.

unsigned long TekArraySize
 

Holds the current size of the array.

Definition at line 606 of file teklti.h.


The documentation for this struct was generated from the following file: SourceForge.net Logo  Technical Library Template Interface Project Page