DefaultKeyValuePort Class Reference

#include <DefaultKeyValuePort.h>

List of all members.

Public Member Functions

 DefaultKeyValuePort (::ccafeopq::TypeMap_shared tm)
void setMap (::ccafeopq::TypeMap_shared tm)
virtual const ::std::string getValue (const ::std::string &key)
virtual void setValue (const ::std::string &key, const ::std::string &value)
virtual const ::std::string remove (const ::std::string &key)
virtual ::std::vector
< ::std::string > 
getKeys ()

Private Attributes

::ccafeopq::TypeMap_shared tm


Detailed Description

A keyvalue port implementation. In a reasonable framework, each component will just be automatically decorated with one of these if that framework exposes the component to external agents.

The keys may not contain whitespace or =. The values may be anything in a CONST char * .

The const variants of functions exist to shut up solaris. shut up the Solaris compilers.


Member Function Documentation

virtual const ::std::string DefaultKeyValuePort::getValue ( const ::std::string &  key  )  [virtual]

Return the value of the requested key. If key unknown, returns NULL.

virtual void DefaultKeyValuePort::setValue ( const ::std::string &  key,
const ::std::string &  value 
) [virtual]

Store the value for the given key, possibly replacing previous. Keys cannot contain the whitespace or '='. Returns nonzero on bogus input or other error.

virtual const ::std::string DefaultKeyValuePort::remove ( const ::std::string &  key  )  [virtual]

Delete a key and associated value. The deleted value is returned. Returns NULL if key not defined.

virtual ::std::vector< ::std::string > DefaultKeyValuePort::getKeys (  ) 

Return all known keys. May be the empty list.


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

Generated on Tue Apr 28 03:12:55 2009 for CCAFFEINE by  doxygen 1.5.5