property_helper.h File Reference

#include <adtfbase/property_intf.h>
#include <adtfucom3/adtf_ucom3.h>
#include <adtfbase/properties_v2.h>
#include <adtfbase/property.h>
#include <type_traits>

Include dependency graph for property_helper.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	adtf
	Namespace for all functionality provided by ADTF and its SDKs.
namespace	adtf::base
	Namespace for the ADTF Base SDK.
namespace	adtf::base::spider
	Namespace for all functionality of the ADTF Base SDK provided since v3.18.
namespace	adtf::base::ant
	Namespace for all functionality of the ADTF Base SDK provided since v3.0.
namespace	adtf::base::hollow
	Namespace for all functionality of the ADTF Base SDK provided since v3.7.
namespace	adtf::base::elasto
	Namespace for all functionality of the ADTF Base SDK provided since v3.4.

Typedefs
using	adtf::base::lucky::tPropertyVisitorCallback = std::function<void(const ant::IProperty& oProperty)>
using	adtf::base::spider::tPropertyVisitorCallback

Functions
tResult	adtf::base::spider::visit_property (const ant::IProperties &oProperties, const char *strPropertyName, const std::function< tResult(const IProperty &oProperty)> &fnCallback)
tResult	adtf::base::spider::visit_property_by_path (const ant::IProperties &oProperties, const char *strPropertyPathAndName, const std::function< tResult(const IProperty &oProperty)> &fnCallback)
template<typename VALUETYPE>
tResult	adtf::base::ant::set_property (IProperties &oProperties, const char *strNameOfValue, VALUETYPE oValue)
tResult	adtf::base::ant::set_property (IProperties &oProperties, const char *strNameOfValue, const char *poValue)
template<typename T>
T	adtf::base::ant::get_property (const IProperties &oProperties, const char *strNameOfValue, const T &oDefaultValue)
template<typename VALUETYPE>
VALUETYPE	adtf::base::ant::get_property (const IProperties &oProperties, const char *strNameOfValue)
tResult	adtf::base::hollow::get_property_object_by_path (const IProperties &oProperties, const char *strPropertyPathAndName, ant::IProperty &oProperty)
template<typename VALUETYPE>
tResult	adtf::base::catwo::set_property_by_path (IProperties &oProperties, const char *strPathAndName, VALUETYPE oValue)
template<typename T>
T	adtf::base::catwo::get_property_by_path (const IProperties &oProperties, const char *strPathAndName, const T &oDefaultValue)
template<typename VALUETYPE>
VALUETYPE	adtf::base::catwo::get_property_by_path (const IProperties &oProperties, const char *strPathAndName)
std::pair< std::string, std::string >	adtf::base::elasto::split_parents_and_leaf (const char *strPropertyPathAndName)
tResult	adtf::base::elasto::create_property_tree (ant::IProperties &oProperties, const char *strPath)
template<typename PropertyType>
void	adtf::base::lucky::detail::call_callback (const ant::IProperty &oProperty, const std::function< void(const char *, PropertyType)> &fnCallback)
void	adtf::base::lucky::visit_properties (const ant::IProperties &oProperties, tPropertyVisitorCallback fnCallback)
template<typename SubPropertyType>
void	adtf::base::lucky::visit_properties (const ant::IProperties &oProperties, std::function< void(const char *, SubPropertyType)> fnCallback)
void	adtf::base::lucky::visit_sub_properties (const ant::IProperty &oProperty, tPropertyVisitorCallback fnCallback)
template<typename SubPropertyType>
void	adtf::base::lucky::visit_sub_properties (const ant::IProperty &oProperty, std::function< void(const char *, SubPropertyType)> fnCallback)
void	adtf::base::lucky::visit_sub_properties (const ant::IProperties &oProperties, const char *strPropertyName, tPropertyVisitorCallback fnCallback)
template<typename SubPropertyType>
void	adtf::base::lucky::visit_sub_properties (const ant::IProperties &oProperties, const char *strPropertyName, std::function< void(const char *, SubPropertyType)> fnCallback)
void	adtf::base::spider::visit_properties (const ant::IProperties &oProperties, const tPropertyVisitorCallback &fnCallback)
template<typename SubPropertyType>
void	adtf::base::spider::visit_properties (const ant::IProperties &oProperties, const std::function< void(const char *, SubPropertyType)> &fnCallback)
void	adtf::base::spider::visit_sub_properties (const ant::IProperty &oProperty, const tPropertyVisitorCallback &fnCallback)
template<typename SubPropertyType>
void	adtf::base::spider::visit_sub_properties (const ant::IProperty &oProperty, const std::function< void(const char *, SubPropertyType)> &fnCallback)
void	adtf::base::spider::visit_sub_properties (const ant::IProperties &oProperties, const char *strPropertyName, const tPropertyVisitorCallback &fnCallback)
template<typename SubPropertyType>
void	adtf::base::spider::visit_sub_properties (const ant::IProperties &oProperties, const char *strPropertyName, const std::function< void(const char *, SubPropertyType)> &fnCallback)
template<typename VALUETYPE>
tResult	adtf::base::set_property (IConfiguration &oConfiguration, const char *strNameOfValue, VALUETYPE oValue)
	Set the property.
template<typename VALUETYPE>
VALUETYPE	adtf::base::get_property (const IConfiguration &oConfiguration, const char *strNameOfValue, VALUETYPE oDefaultValue)
	Get the property content converted to the VALUETYPE.
template<typename VALUETYPE>
tResult	adtf::base::set_property_by_path (IConfiguration &oConfiguration, const char *strPathAndName, VALUETYPE oValue)
template<typename VALUETYPE>
VALUETYPE	adtf::base::get_property_by_path (const IConfiguration &oConfiguration, const char *strPathAndName, VALUETYPE oDefaultValue)
tResult	adtf::base::get_property_object_by_path (const ant::IConfiguration &oConfiguration, const char *strPropertyPathAndName, ant::IProperty &oProperty)
	Retrieves a property reference under the given oConfiguration by path.
std::pair< std::string, std::string >	adtf::base::split_parents_and_leaf (const char *strPropertyPathAndName)
tResult	adtf::base::create_property_tree (ant::IProperties &oProperties, const char *strPath)
void	adtf::base::visit_properties (const ant::IProperties &oProperties, const tPropertyVisitorCallback &fnCallback)
void	adtf::base::visit_sub_properties (const ant::IProperty &oProperty, const tPropertyVisitorCallback &fnCallback)
tResult	adtf::base::visit_property (const ant::IProperties &oProperties, const char *strPropertyName, const std::function< tResult(const IProperty &oProperty)> &fnCallback)
tResult	adtf::base::visit_property_by_path (const ant::IProperties &oProperties, const char *strPropertyPathAndName, const std::function< tResult(const IProperty &oProperty)> &fnCallback)

Detailed Description

Copyright © Audi Electronics Venture GmbH. All rights reserved

Function Documentation

visit_properties() [1/2]

template<typename SubPropertyType>

void adtf::base::lucky::visit_properties	(	const ant::IProperties &	oProperties,
		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.

visit_properties() [2/2]

void adtf::base::lucky::visit_properties	(	const ant::IProperties &	oProperties,
		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.

visit_sub_properties() [1/4]

template<typename SubPropertyType>

void adtf::base::lucky::visit_sub_properties	(	const ant::IProperties &	oProperties,
		const char *	strPropertyName,
		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.

visit_sub_properties() [2/4]

void adtf::base::lucky::visit_sub_properties	(	const ant::IProperties &	oProperties,
		const char *	strPropertyName,
		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]

template<typename SubPropertyType>

void adtf::base::lucky::visit_sub_properties	(	const ant::IProperty &	oProperty,
		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.

visit_sub_properties() [4/4]

void adtf::base::lucky::visit_sub_properties	(	const ant::IProperty &	oProperty,
		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.