Skip to content

confTools

Macros

Name Description
_KARABO_SCHEMA_DESCRIPTION_FUNCTION @define the name of the schema description function in Karabo

Functions

Name Description
getLastClassId @brief classId of last class - Classes must not be empty This last class must have the static method classInfo() as provided when using the macro 'KARABO_CLASSINFO' in the public section of class declaration Return : classId of the last class of the parameter pack 'Classes'
getSchemaDescriptionFunction Return a pointer to a valid schema description function `` :
getSchemaDescriptionFunction Return a NULL-Pointer if no schema description function exists `` :
splitIntoClassIdAndConfiguration Split a configuration into classId and configuration Hash rootedConfiguration : Return : a pair of class id and configuration Hash

Macro Details

_KARABO_SCHEMA_DESCRIPTION_FUNCTION

#define _KARABO_SCHEMA_DESCRIPTION_FUNCTION

@define the name of the schema description function in Karabo

Function Details

getLastClassId

template <class... Classes> std::string getLastClassId()

@brief classId of last class - Classes must not be empty

This last class must have the static method classInfo() as provided when using the macro 'KARABO_CLASSINFO' in the public section of class declaration

Return : classId of the last class of the parameter pack 'Classes'

getSchemaDescriptionFunction

template <class Class> inline PointerToSchemaDescriptionFunction getSchemaDescriptionFunction( VoidArg1FunctionExists<Class, Schema, &Class::_KARABO_SCHEMA_DESCRIPTION_FUNCTION>*)

Return a pointer to a valid schema description function

`` :

template <class Class> inline PointerToSchemaDescriptionFunction getSchemaDescriptionFunction(...)

Return a NULL-Pointer if no schema description function exists

`` :

splitIntoClassIdAndConfiguration

inline std::pair<std::string, karabo::data::Hash> splitIntoClassIdAndConfiguration( const karabo::data::Hash& rootedConfiguration)

Split a configuration into classId and configuration Hash

rootedConfiguration :

Return : a pair of class id and configuration Hash