The facade for data-models.

#include <DataModel.h>

Public Member Functions
virtual void	addExtension (DataModelExtension *ext)
	Register an extension to get data into and out of the data-model. More...

virtual void	assign (const std::string &location, const Data &data, const std::map< std::string, std::string > &attr=std::map< std::string, std::string >())
	Assign a data object to a location in the data-model. More...

virtual bool	evalAsBool (const std::string &expr)
	Evaluate a given expression as a boolean. More...

virtual Data	evalAsData (const std::string &content)
	Return a string as an evaluated Data object. More...

virtual Data	getAsData (const std::string &content)
	Return a string as an unevaluated Data object. More...

virtual uint32_t	getLength (const std::string &expr)
	Evaluate the given expression as something iterable and return its length. More...

virtual std::list< std::string >	getNames ()
	Return a list of names to be matched by the `datamodel` attribute in SCXML. More...

virtual void	init (const std::string &location, const Data &data, const std::map< std::string, std::string > &attr=std::map< std::string, std::string >())
	Initialize a variable / location in the data-model with a given data object. More...

virtual bool	isDeclared (const std::string &expr)
	Determine whether a given variable / location is declared. More...

virtual bool	isValidSyntax (const std::string &expr)
	Determine whether a given string constitutes valid syntax in the data-model's language. More...

	PIMPL_OPERATORS (DataModel)

size_t	replaceExpressions (std::string &content)
	Experimental extension to have dynamic content in string literals. More...

virtual void	setEvent (const Event &event)
	Set the given event as `_event` in the data-model's global scope. More...

virtual void	setForeach (const std::string &item, const std::string &array, const std::string &index, uint32_t iteration)
	Set a given item to the object at a given index for one iteration. More...

Protected Attributes
std::shared_ptr< DataModelImpl >	_impl

Member Function Documentation

void uscxml::DataModel::addExtension ( DataModelExtension * ext )

virtual

Todo:: This is currently unsupported

void uscxml::DataModel::assign	(	const std::string &	location,
		const Data &	data,
		const std::map< std::string, std::string > &	attr = `std::map<std::string, std::string>()`
	)

virtual

There are different occurences in the SCXML IRP tests, e.g.

test147:
<data id="Var1" expr="0"/>

test150:
<data id="Var3">
[1,2,3]
</data>

test277:
<data id="Var1" expr="return"/>

Parameters

location	A variable or locatio to assign to.
data	The Data object with the respective data.
attr	Additional attributes of the XML assign element.

bool uscxml::DataModel::evalAsBool ( const std::string & expr )

virtual

This function is a subset of evalAsData() but saves on creating and copying a Data object.

Parameters

expr	An expression in the data-model's language.

Returns: Whether the expression evaluates as true

Data uscxml::DataModel::evalAsData ( const std::string & content )

virtual

Parameters

content A string with a literal, eppression or compound data-structure in the data-model's language.

Returns: An evaluated structure representing the given compound or literal.

Data uscxml::DataModel::getAsData ( const std::string & content )

virtual

Parameters

content A string with a literal, eppression or compound data-structure in the data-model's language.

Returns: An unevaluated structure representing the given compound or literal.

uint32_t uscxml::DataModel::getLength ( const std::string & expr )

virtual

Parameters

expr	Anything that possibly evaluates to an enumerable object.

Returns: The number of items in the enumerable object.

std::list< std::string > uscxml::DataModel::getNames ( )

virtual

void uscxml::DataModel::init	(	const std::string &	location,
		const Data &	data,
		const std::map< std::string, std::string > &	attr = `std::map<std::string, std::string>()`
	)

virtual

This is, semantically, very close to assign() but does not assume the location to be declared first.

Parameters

location	A variable or locatio to assign to.
data	The Data object with the respective data.
attr	Additional attributes of the XML data element.

bool uscxml::DataModel::isDeclared ( const std::string & expr )

virtual

Parameters

expr	The variable / location to check.

Todo:: Is this still used?

bool uscxml::DataModel::isValidSyntax ( const std::string & expr )

virtual

Parameters

expr	A string, supposedly containing an expression of the data-model.

Returns: Whether expr is in L(DM).

size_t uscxml::DataModel::replaceExpressions ( std::string & content )

This function was used to replace ${foo} expressions on the data-model, e.g. in text nodes. It will eventually make a reappearance I guess.

Parameters

content The string with tokens to replace.

Returns: How many occurences where replaced.

void uscxml::DataModel::setEvent ( const Event & event )

virtual

Parameters

event The event as it was dequeued from either the internal or external queue.

void uscxml::DataModel::setForeach	(	const std::string &	item,
		const std::string &	array,
		const std::string &	index,
		uint32_t	iteration
	)

virtual

Parameters

item	A variable or location to assign the current object to.
array	An expression evalating to an enumerable object.
index	A variable or location to set the current index at.
iteration	The current iteration index.

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

plugins/DataModel.h
plugins/DataModel.cpp

Public Member Functions

Protected Attributes

Member Function Documentation