property_helper.h File Reference

Copyright © Audi Electronics Venture GmbH. More...

Go to the source code of this file.

Namespaces
namespace	adtf
	Namespace for entire ADTF SDK.
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::catwo
	Namespace for all functionality of the ADTF Base SDK provided since v3.2.
namespace	adtf::base::elasto
	Namespace for all functionality of the ADTF Base SDK provided since v3.4.
namespace	adtf::base::lucky
	Namespace for all functionality of the ADTF Base SDK provided since v3.11.
namespace	adtf::base::lucky::detail
	Namespace for all internally used functionality implemented.

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

Functions
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)
template<typename VALUETYPE>
tResult	set_property (IProperties &oProperties, const char *strNameOfValue, VALUETYPE oValue)
	Sets a property of the value type VALUETYPE to a IProperties implementation.
tResult	set_property (IProperties &oProperties, const char *strNameOfValue, const char *poValue)
	Sets a property of the value type const char* to a IProperties implementation.
template<typename T>
T	get_property (const IProperties &oProperties, const char *strNameOfValue, const T &oDefaultValue)
	Gets a property value of the value type VALUETYPE from a IProperties implementation.
template<typename VALUETYPE>
VALUETYPE	get_property (const IProperties &oProperties, const char *strNameOfValue)
	Gets a property value of the value type VALUETYPE from a IProperties implementation.
tResult	get_property_object_by_path (const IProperties &oProperties, const char *strPropertyPathAndName, ant::IProperty &oProperty)
	gets a property by path.
template<typename VALUETYPE>
tResult	set_property_by_path (IProperties &oProperties, const char *strPathAndName, VALUETYPE oValue)
template<typename T>
T	get_property_by_path (const IProperties &oProperties, const char *strPathAndName, const T &oDefaultValue)
template<typename VALUETYPE>
VALUETYPE	get_property_by_path (const IProperties &oProperties, const char *strPathAndName)
std::pair< std::string, std::string >	split_parents_and_leaf (const char *strPropertyPathAndName)
	Splits a property path into the parent path and the property name.
tResult	create_property_tree (ant::IProperties &oProperties, const char *strPath)
	Creates a property tree structure.
template<typename PropertyType>
void	call_callback (const ant::IProperty &oProperty, const std::function< void(const char *, PropertyType)> &fnCallback)
void	visit_properties (const ant::IProperties &oProperties, tPropertyVisitorCallback fnCallback)
	Utility function to visit all properties of a properties object.
template<typename SubPropertyType>
void	visit_properties (const ant::IProperties &oProperties, std::function< void(const char *, SubPropertyType)> fnCallback)
	Utility function to visit all properties of a properties object.
void	visit_sub_properties (const ant::IProperty &oProperty, tPropertyVisitorCallback fnCallback)
	Utility function to visit all sub-properties of a given property.
template<typename SubPropertyType>
void	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.
void	visit_sub_properties (const ant::IProperties &oProperties, const char *strPropertyName, tPropertyVisitorCallback fnCallback)
	Utility function to visit all sub-properties of a given property.
template<typename SubPropertyType>
void	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.
void	visit_properties (const ant::IProperties &oProperties, const tPropertyVisitorCallback &fnCallback)
	Utility function to visit all properties of a properties object.
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.
void	visit_sub_properties (const ant::IProperty &oProperty, const tPropertyVisitorCallback &fnCallback)
	Utility function to visit all sub-properties of a given property.
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.
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.
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.
template<typename VALUETYPE>
tResult	set_property (IConfiguration &oConfiguration, const char *strNameOfValue, VALUETYPE oValue)
	Set the property.
template<typename VALUETYPE>
VALUETYPE	get_property (const IConfiguration &oConfiguration, const char *strNameOfValue, VALUETYPE oDefaultValue)
	Get the property content converted to the VALUETYPE.
template<typename VALUETYPE>
tResult	set_property_by_path (IConfiguration &oConfiguration, const char *strPathAndName, VALUETYPE oValue)
template<typename VALUETYPE>
VALUETYPE	get_property_by_path (const IConfiguration &oConfiguration, const char *strPathAndName, VALUETYPE oDefaultValue)
tResult	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 >	split_parents_and_leaf (const char *strPropertyPathAndName)
	Splits a property path into the parent path and the property name.
tResult	create_property_tree (ant::IProperties &oProperties, const char *strPath)
	Creates a property tree structure.
void	visit_properties (const ant::IProperties &oProperties, const tPropertyVisitorCallback &fnCallback)
	Utility function to visit all properties of a properties object.
void	visit_sub_properties (const ant::IProperty &oProperty, const tPropertyVisitorCallback &fnCallback)
	Utility function to visit all sub-properties of a given property.
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)

Detailed Description

Copyright © Audi Electronics Venture GmbH.

All rights reserved

Definition in file property_helper.h.