adtf::base::elasto Namespace Reference

Namespace for all functionality of the ADTF Base SDK provided since v3.4. More...

Classes
class	cErrorHandler
class	IErrorHandling
struct	tree_node_property_type

Functions
ucom::ant::object_ptr< IErrorHandling::IErrorHandler >	create_error_handler (const char *strErrorSource, const char *strErrorCategory, IErrorHandling::tAction eDefaultAction)
void	handle_error (const char *strErrorSource, const char *strErrorCategory, IErrorHandling::tAction eDefaultAction, tResult oError)
std::pair< std::string, std::string >	split_parents_and_leaf (const char *strPropertyPathAndName)
tResult	create_property_tree (ant::IProperties &oProperties, const char *strPath)

Detailed Description

Namespace for all functionality of the ADTF Base SDK provided since v3.4.

Function Documentation

create_error_handler()

ucom::ant::object_ptr< IErrorHandling::IErrorHandler > adtf::base::elasto::create_error_handler	(	const char *	strErrorSource,
		const char *	strErrorCategory,
		IErrorHandling::tAction	eDefaultAction )

Creates a new error handler. This works both if an error handling service is available or not.

Parameters

[in]	strErrorSource	The name of the error source.
[in]	strErrorCategory	The name of the error category.
[in]	eDefaultAction	The default action that should be taken if an error occurs.

Returns

pHandler The new handler.

create_property_tree()

tResult adtf::base::elasto::create_property_tree	(	ant::IProperties &	oProperties,
		const char *	strPath )

Creates a property tree structure. It creates new intermediate properties if they do not exist already.

Parameters

[in,out]	oProperties	The property container to manipulate
[in]	strPath	The path of the properties, elements separated by slashes.

Returns

Standard result.

handle_error()

void adtf::base::elasto::handle_error	(	const char *	strErrorSource,
		const char *	strErrorCategory,
		IErrorHandling::tAction	eDefaultAction,
		tResult	oError )

Convenience method to report an error for short lived objects.

Parameters

[in]	strErrorSource	The name of the error source.
[in]	strErrorCategory	The name of the error category.
[in]	eDefaultAction	The default action that should be taken if an error occurs.
[in]	oError	The error result.

split_parents_and_leaf()

std::pair< std::string, std::string > adtf::base::elasto::split_parents_and_leaf

(

const char *

strPropertyPathAndName

)

Splits a property path into the parent path and the property name.

Parameters

[in]

strPropertyPathAndName

Path separated by slashes.

Returns

parent path and property name.