UCommon
Public Member Functions | Static Public Member Functions | Protected Attributes
ucommon::multimap Class Reference

Embed data objects into a multipap structured memory database. More...

#include <linked.h>

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

Public Member Functions

T & get (void) const
 Return the typed value of this node.
 multimap ()
 Construct a multimap node.
multimapnext (unsigned path)
 Return next multimap typed object.
T & operator* () const
 Return typed value of this node by pointer reference.
void operator= (const T &data)
 Assign the value of our node.
void set (const T &reference)
 Set the value of a data based value tree.
void setPointer (const T pointer)
 Set the pointer of a pointer based value tree.
 ~multimap ()
 Destroy a multimap object.

Static Public Member Functions

static multimapfind (unsigned path, MultiMap **index, caddr_t key, unsigned size, unsigned keysize=0)
 Find multimap key entry.

Protected Attributes

value

Detailed Description

Embed data objects into a multipap structured memory database.

This can be used to form multi-key hash nodes. Embedded values can either be of direct types that are then stored as part of the template object, or of class types that are data pointers.

Author:
David Sugar <dyfet@gnutelephony.org>

Member Function Documentation

static multimap* ucommon::multimap::find ( unsigned  path,
MultiMap **  index,
caddr_t  key,
unsigned  size,
unsigned  keysize = 0 
) [inline, static]

Find multimap key entry.

Parameters:
pathto search through.
indexof associated keys.
keyto search for, binary or NULL terminated string.
sizeof index used.
keysizeor 0 if NULL terminated string.
Returns:
multipath typed object.

Definition at line 1516 of file linked.h.

T& ucommon::multimap::get ( void  ) const [inline]

Return the typed value of this node.

Returns:
reference to value of node.

Definition at line 1468 of file linked.h.

multimap* ucommon::multimap::next ( unsigned  path) [inline]

Return next multimap typed object.

Parameters:
pathto follow.
Returns:
multimap typed.

Definition at line 1476 of file linked.h.

T& ucommon::multimap::operator* ( ) const [inline]

Return typed value of this node by pointer reference.

Returns:
value of node.

Definition at line 1483 of file linked.h.

void ucommon::multimap::operator= ( const T &  data) [inline]

Assign the value of our node.

Parameters:
datavalue to assign.

Definition at line 1504 of file linked.h.

void ucommon::multimap::set ( const T &  reference) [inline]

Set the value of a data based value tree.

Parameters:
referenceto value to copy into node.

Definition at line 1497 of file linked.h.

void ucommon::multimap::setPointer ( const T  pointer) [inline]

Set the pointer of a pointer based value tree.

Parameters:
pointerto set.

Definition at line 1490 of file linked.h.


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