base Namespace Reference

Classes
class	Array
	Array of X where X is a scalar type (or struct of scalars without constructor or destructor. More...
class	array_t
	This defines a simple array template that will work on scalar types only. More...
union	bitptr_u
	Cast in a nutshell Conversion int <-> ptr with a union. More...
class	bitptr_t
	Encapsulation of lower bit manipulation of a pointer. More...
class	Bit
	Bit reference wrapper -- it is better to use directly the previous functions when it is possible but this may be useful. More...
class	BitString
	Encapsulation of a bitstring. More...
class	DataAllocator
	Fast chunk allocator. More...
class	LinkableEnumerator
	Generic enumerator for linkables: enumerate on a table of linkables. More...
class	Enumerator
	Template for typed enumerators: assume T is a kind of SingleLinkable_t. More...
class	FatalException
	Fatal exception: something fatal (and forbidden) has happened. More...
class	ItemAllocator
	Simple (and fast) item allocator. More...
struct	SingleLinkable_t
	Generic untyped structure for generic manipulation. More...
struct	DoubleLinkable_t
	Generic untyped structure for generic manipulation. More...
struct	SingleLinkable
	Template for typed manipulation. More...
struct	DoubleLinkable
	Template for typed manipulation. More...
class	MZRan13
class	Object
	Base class to derive from if you want to use Pointer<of something>. More...
class	Pointer
	Pointer<of something> allows automatic reference counting and automatic deallocation when the reference drops to 0. More...
class	pointer_t
	A simple reference with maximal capacity for access checks. More...
class	BasePriorityQueue
	This class is here only to protect a variable. More...
class	PriorityQueue
	Fast, leak free, and controlled priority queue. More...
class	Sortable
	Wrapper for large types: wrap a pointer. More...
class	SimpleQueue
	Simple queue for linkable objects, no allocation, very simple. More...
class	Timer
	A simple timer to measure CPU time. More...
class	xorptr_t
	xorptr_t encapsulate "safely" the concept of swapping between 2 pointers with a xor operation. More...
class	SimpleLIFOQueue
class	SimpleFIFOQueue
Typedefs
typedef int const *	property_t
	Global property types.
Functions
static std::ostream &	operator<< (std::ostream &os, const BitString &bs)
static std::ostream &	operator<< (std::ostream &os, const Bit &b)
static std::ostream &	operator<< (std::ostream &os, const FatalException &x)
	Overload operator <<.
template<class O>
static std::ostream &	operator<< (std::ostream &out, const Pointer< O > &p)
	Simple overload of operator <<.
static void	DataAllocator_printMem (std::ostream &out, const char *caption, uint32_t mem)
	Utility function to print stats.
	DEF_PROPERTY (EXACT_RELATION)
	DEF_PROPERTY (FLAG)
	DEF_PROPERTY (SIZE)
Variables
property_t	EXACT_RELATION
	sets a relation flag, expects bool*
property_t	FLAG
	sets a generic flag, expects bool*
property_t	SIZE
	sets a generic size, expects uint32_t*

---

Typedef Documentation

typedef int const* base::property_t

Global property types. On a number of components there is a setProperty method used to set a particular property. If we take pipeline/components.h as an example we may have properties for different kinds of buffers, such as, PWList. Implementations are scattered in several modules so it is better to centralize all the properties in one place. Properties are expected to be used with methods setProperty(property_t, const void*): for a given property there is an expected type of data to read.

---

Function Documentation

static void base::DataAllocator_printMem (  std::ostream &  out, const char *  caption, uint32_t  mem )  [static]

Utility function to print stats.

base::DEF_PROPERTY (  SIZE   )

base::DEF_PROPERTY (  FLAG   )

base::DEF_PROPERTY (  EXACT_RELATION   )

template<class O> static std::ostream& base::operator<< (  std::ostream &  out, const Pointer< O > &  p )  [inline, static]

Simple overload of operator <<.

static std::ostream& base::operator<< (  std::ostream &  os, const FatalException &  x )  [inline, static]

Overload operator <<.

static std::ostream& base::operator<< (  std::ostream &  os, const Bit &  b )  [inline, static]

static std::ostream& base::operator<< (  std::ostream &  os, const BitString &  bs )  [inline, static]

---

Variable Documentation

property_t base::EXACT_RELATION

sets a relation flag, expects bool*

property_t base::FLAG

sets a generic flag, expects bool*

property_t base::SIZE

sets a generic size, expects uint32_t*

---