Keys Class Reference

This is a bucket class for KeyValues. More...

#include <Keys.h>

List of all members.

Public Member Functions

 Keys (TableImplPtr table)
 Constructs a KeyValue bucket for the specified table.
 Keys (TableImplPtr table, cstring initstring)
 Constructs a KeyValue bucket for the specified table, tries to initialize with values from the specified string.
 ~Keys ()
 Destructor, a noop.
TableImplPtr getTable () const
 Returns the table this KeyValue bucket belongs to.
void addKey (KeyValuePtr key)
 Add a key to the bucket.
void addKey (KeyImplPtr key, value_type value)
 Add a key to the bucket from the specified field with the specified value.
std::string toString () const
 Returns a string representation of the keys in the bucket.
Strings getDiff (KeysPtr orig) const
 Returns a vector of strings representing the difference between the other Keys bucket with one entry for each different field.
size_t size () const
 Returns the size of the keys in the bucket.
KeyValuePtr first () const
 Returns the first KeyValue in the bucket.
KeyImplMap::const_iterator begin () const
 Returns an iterator to the first key in the bucket.
KeyImplMap::const_iterator end () const
 Returns the 'end' iterator of the keys in the bucket.
KeyImplMap::const_iterator find (KeyImplPtr key) const
 Returns an iterator to the result of 'find' with this specific key as argument.
KeyValuePtr getKey (KeyImplPtr key) const
 Returns a KeyValue for this field, asserted not to be the 'end' iterator.
void setDirty (KeysPtr oldKeys)
 Determines which keys have changed compared to the other set and marks them as dirty.


Detailed Description

This is a bucket class for KeyValues.

See also:
KeyValue

Definition at line 36 of file Keys.h.


Constructor & Destructor Documentation

Keys::Keys ( TableImplPtr  table  ) 

Constructs a KeyValue bucket for the specified table.

Keys::Keys ( TableImplPtr  table,
cstring  initstring 
)

Constructs a KeyValue bucket for the specified table, tries to initialize with values from the specified string.

Keys::~Keys (  ) 

Destructor, a noop.


Member Function Documentation

TableImplPtr Keys::getTable (  )  const

Returns the table this KeyValue bucket belongs to.

void Keys::addKey ( KeyValuePtr  key  ) 

Add a key to the bucket.

void Keys::addKey ( KeyImplPtr  key,
value_type  value 
)

Add a key to the bucket from the specified field with the specified value.

std::string Keys::toString (  )  const

Returns a string representation of the keys in the bucket.

Strings Keys::getDiff ( KeysPtr  orig  )  const

Returns a vector of strings representing the difference between the other Keys bucket with one entry for each different field.

size_t Keys::size (  )  const

Returns the size of the keys in the bucket.

KeyValuePtr Keys::first (  )  const

Returns the first KeyValue in the bucket.

KeyImplMap::const_iterator Keys::begin (  )  const

Returns an iterator to the first key in the bucket.

KeyImplMap::const_iterator Keys::end (  )  const

Returns the 'end' iterator of the keys in the bucket.

KeyImplMap::const_iterator Keys::find ( KeyImplPtr  key  )  const

Returns an iterator to the result of 'find' with this specific key as argument.

KeyValuePtr Keys::getKey ( KeyImplPtr  key  )  const

Returns a KeyValue for this field, asserted not to be the 'end' iterator.

void Keys::setDirty ( KeysPtr  oldKeys  ) 

Determines which keys have changed compared to the other set and marks them as dirty.


Generated for UnsignedByte by  doxygen 1.5.3
SourceForge.net Logo