keyvalue Namespace Reference

All functionalities of KeyValue library are inside this namespace. More...

Namespaces
namespace	key
	All key functionalities, including key::Key, key::Traits, key mappings are inside this namespace.
namespace	frontend
	All classes and functions needed by frontends belong to this namespace.
namespace	util
	Utility classes and functions are member of this namespace.
namespace	value
	All KeyValue containers belong to this namespace.
namespace	tag
	All Processor tags are member of this namespace.
namespace	pattern
	Key-value pattern recognition class are members of this namespace.
namespace	exception
	All exception functionalities are inside this namespace.
namespace	logger
	All logger functionalities are inside this namespace.
Classes
class	Bridge
	Bridge's specific data. More...
class	AbstractBuilder
	Abstract base class of all Builders. More...
class	Builder
	Concrete Builder. More...
class	BuilderFrom
	A (possible) base template class of Builder<ObjectType>. More...
class	BuilderFrom< ObjectType, value::Variant >
	Specialisation of template BuilderFrom for InputType value::Variant. More...
class	Calculator
	Concrete Calculator. More...
class	Command
	Command interface. More...
class	DataSet
	A named map from keys to values. More...
class	Processor
	Protocol class which defines Processor interface. More...
class	ProcessorInstantiator
	Instantiate a processor given its Tag. More...
class	ProcessorMngr
	The processor manager. More...
class	Repository
	The Repository of DataSets. More...
class	Message
	Abstract class which defines the interface for all types of message. More...
class	MessageImpl
	Implementation of class Message. More...
Typedefs
typedef MessageImpl< 0 >	Error
typedef MessageImpl< 1 >	Logic
typedef MessageImpl< 2 >	Info
typedef MessageImpl< 3 >	Warning
typedef MessageImpl< 4 >	Report
typedef MessageImpl< 5 >	Debug
Functions
value::Value	process (frontend::Queue &data)
	Processes a frontend::Queue.
value::Value	process (shared_ptr< DataSet > data)
	Processes a DataSet.
::std::ostream &	operator<< (::std::ostream &os, const Message &message)
	ostream operator<<() for Message.

---

Detailed Description

All functionalities of KeyValue library are inside this namespace.

This class implements a standard Logger.

---

Function Documentation

value::Value keyvalue::process

(

frontend::Queue &

data

)

Processes a frontend::Queue.

This function creates a DataSet from a frontend::Queue. The DataSet gets the frontend::Queue's name after leading and trailing white spaces are removed. Key-value patterns are parsed at this stage.

Then the DataSet is sent to process(shared_ptr<DataSet>).

Parameters:

data

: the original frontend::Queue.

Returns:

The DataSet's name or the result of DataSet processing.

value::Value keyvalue::process

(

shared_ptr< DataSet >

data

)

Processes a DataSet.

This function adds a DataSet to the Repository and, if requested, process it.

By default, the DataSet is not processed, unless its name is empty or key 'ProcessNow' is 'TRUE'.

Parameters:

data

: The DataSet to be added to the Repository;

Returns:

When the DataSet is processed, the result of this processing is returned. Otherwise DataSet's name is returned.

::std::ostream& keyvalue::operator<<	(	::std::ostream &	os,
		const Message &	message
	)

ostream operator<<() for Message.