adtf::base::spider Namespace Reference

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

Classes
class	cADTFRuntime
class	cPropertyValue
class	cProperty
class	property
class	property< T, typename std::enable_if<!detail::is_user_defined_property_value< T >::value >::type >
class	cProperties
class	cRawMemoryRedirect
class	cStringLengthProxy
class	cStringRedirect

Functions
template<typename T >
tResult	get_property_value (const IPropertyValue &oValue, T &xValue)
template<typename T >
T	get_property_value (const IPropertyValue &oValue)
tResult	visit_property (const ant::IProperties &oProperties, const char *strPropertyName, const std::function< tResult(const IProperty &oProperty)> &fnCallback)
tResult	visit_property_by_path (const ant::IProperties &oProperties, const char *strPropertyPathAndName, const std::function< tResult(const IProperty &oProperty)> &fnCallback)
void	visit_properties (const ant::IProperties &oProperties, const tPropertyVisitorCallback &fnCallback)
	Utility function to visit all properties of a properties object. More...
template<typename SubPropertyType >
void	visit_properties (const ant::IProperties &oProperties, const std::function< void(const char *, SubPropertyType)> &fnCallback)
	Utility function to visit all properties of a properties object. More...
void	visit_sub_properties (const ant::IProperty &oProperty, const tPropertyVisitorCallback &fnCallback)
	Utility function to visit all sub-properties of a given property. More...
template<typename SubPropertyType >
void	visit_sub_properties (const ant::IProperty &oProperty, const std::function< void(const char *, SubPropertyType)> &fnCallback)
	Utility function to visit all sub-properties of a given property. More...
void	visit_sub_properties (const ant::IProperties &oProperties, const char *strPropertyName, const tPropertyVisitorCallback &fnCallback)
	Utility function to visit all sub-properties of a given property. More...
template<typename SubPropertyType >
void	visit_sub_properties (const ant::IProperties &oProperties, const char *strPropertyName, const std::function< void(const char *, SubPropertyType)> &fnCallback)
	Utility function to visit all sub-properties of a given property. More...
tResult	is_equal (const ant::IProperties &oLeftProperties, const ant::IProperties &oRightProperties)
	Check if two property sets are equal. More...
tResult	is_equal (const ant::IProperty &oLeftProperty, const ant::IProperty &oRightProperty)
	Check if two properties are equal. More...

Detailed Description

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

Function Documentation

is_equal() [1/2]

tResult adtf::base::spider::is_equal	(	const ant::IProperties &	oLeftProperties,
		const ant::IProperties &	oRightProperties
	)

Check if two property sets are equal.

Parameters

[in]	oLeftProperties	The operands for the check.
[in]	oRightProperties	The operands for the check.

Returns

Standard result.

is_equal() [2/2]

tResult adtf::base::spider::is_equal	(	const ant::IProperty &	oLeftProperty,
		const ant::IProperty &	oRightProperty
	)

Check if two properties are equal.

Parameters

[in]	oLeftProperty	The operands for the check.
[in]	oRightProperty	The operands for the check.

Returns

Standard result.

visit_properties() [1/2]

void adtf::base::spider::visit_properties	(	const ant::IProperties &	oProperties,
		const std::function< void(const char *, SubPropertyType)> &	fnCallback
	)

Utility function to visit all properties of a properties object.

Template Parameters

SubPropertyType

The value type of the sub-properties.

Parameters

[in]	oProperties	The properties object.
[out]	fnCallback	This is called for each sub-property.

Definition at line 308 of file property_helper.h.

References visit_properties().

visit_properties() [2/2]

void adtf::base::spider::visit_properties	(	const ant::IProperties &	oProperties,
		const tPropertyVisitorCallback &	fnCallback
	)

Utility function to visit all properties of a properties object.

Parameters

[in]	oProperties	The properties object.
[out]	fnCallback	This is called for each property.

Referenced by visit_properties().

visit_sub_properties() [1/4]

void adtf::base::spider::visit_sub_properties	(	const ant::IProperties &	oProperties,
		const char *	strPropertyName,
		const std::function< void(const char *, SubPropertyType)> &	fnCallback
	)

Utility function to visit all sub-properties of a given property.

Template Parameters

SubPropertyType

The value type of the sub-properties.

Parameters

[in]	oProperties	The properties object.
[in]	strPropertyName	The name of the properties of which the sub-properties should be visited.
[out]	fnCallback	This is called for each sub-property.

Definition at line 353 of file property_helper.h.

References visit_sub_properties().

visit_sub_properties() [2/4]

void adtf::base::spider::visit_sub_properties	(	const ant::IProperties &	oProperties,
		const char *	strPropertyName,
		const tPropertyVisitorCallback &	fnCallback
	)

Utility function to visit all sub-properties of a given property.

Parameters

[in]	oProperties	The properties object.
[in]	strPropertyName	The name of the properties of which the sub-properties should be visited.
[out]	fnCallback	This is called for each sub-property.

visit_sub_properties() [3/4]

void adtf::base::spider::visit_sub_properties	(	const ant::IProperty &	oProperty,
		const std::function< void(const char *, SubPropertyType)> &	fnCallback
	)

Utility function to visit all sub-properties of a given property.

Template Parameters

SubPropertyType

The value type of the sub-properties.

Parameters

[in]	oProperty	The property object.
[out]	fnCallback	This is called for each sub-property.

Definition at line 329 of file property_helper.h.

References visit_sub_properties().

visit_sub_properties() [4/4]

void adtf::base::spider::visit_sub_properties	(	const ant::IProperty &	oProperty,
		const tPropertyVisitorCallback &	fnCallback
	)

Utility function to visit all sub-properties of a given property.

Parameters

[in]	oProperty	The property object.
[out]	fnCallback	This is called for each sub-property.

Referenced by visit_sub_properties().