mace::KeyRange Class Reference

#include <KeyRange.h>

Inheritance diagram for mace::KeyRange:

Inheritance graph
[legend]
Collaboration diagram for mace::KeyRange:

Collaboration graph
[legend]

List of all members.


Detailed Description

A pair of MaceKey which represent an inclusive start, exclusive end circulur key range for hash addresses.

Definition at line 46 of file KeyRange.h.


Public Member Functions

bool containsKey (const MaceKey &k) const
 returns true if the range includes the key k

Static Public Member Functions

static bool containsKey (const MaceKey &id, const MaceKey &start, const MaceKey &end)
 determines if id is between start and end

Static Public Attributes

static const KeyRange null = mace::KeyRange()
 convenience object for the null KeyRange

Member Function Documentation

static bool mace::KeyRange::containsKey ( const MaceKey id,
const MaceKey start,
const MaceKey end 
) [inline, static]

determines if id is between start and end

If either address is null, the return is false. If the address families don't match, an exception is thrown. $ start = end \Rightarrow id \in range $

Parameters:
id the key to test
start inclusive start to the key range
end exclusive end to the key range

Definition at line 64 of file KeyRange.h.

References mace::MaceKey::addressFamily(), and mace::MaceKey::isNullAddress().


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

Generated on Sat Oct 4 21:30:38 2008 for Mace Library by  doxygen 1.5.5