ADTF
adtf::base::lucky Namespace Reference

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

Namespaces

 detail
 Namespace for all internally used functionality implemented.
 

Typedefs

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

Functions

void visit_properties (const ant::IProperties &oProperties, tPropertyVisitorCallback fnCallback)
 Utility function to visit all properties of a properties object. More...
 
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. More...
 
void visit_sub_properties (const ant::IProperty &oProperty, 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, 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, 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, std::function< void(const char *, SubPropertyType)> fnCallback)
 Utility function to visit all sub-properties of a given property. More...
 

Detailed Description

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

Function Documentation

◆ visit_properties() [1/2]

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
SubPropertyTypeThe value type of the sub-properties.
Parameters
[in]oPropertiesThe properties object.
[out]fnCallbackThis is called for each sub-property.

Definition at line 232 of file property_helper.h.

References visit_properties().

◆ 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]oPropertiesThe properties object.
[out]fnCallbackThis is called for each property.

Referenced by visit_properties().

◆ visit_sub_properties() [1/4]

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
SubPropertyTypeThe value type of the sub-properties.
Parameters
[in]oPropertiesThe properties object.
[in]strPropertyNameThe name of the properties of which the sub-properties should be visited.
[out]fnCallbackThis is called for each sub-property.

Definition at line 277 of file property_helper.h.

References visit_sub_properties().

◆ 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]oPropertiesThe properties object.
[in]strPropertyNameThe name of the properties of which the sub-properties should be visited.
[out]fnCallbackThis is called for each sub-property.

◆ visit_sub_properties() [3/4]

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
SubPropertyTypeThe value type of the sub-properties.
Parameters
[in]oPropertyThe property object.
[out]fnCallbackThis is called for each sub-property.

Definition at line 253 of file property_helper.h.

References visit_sub_properties().

◆ 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]oPropertyThe property object.
[out]fnCallbackThis is called for each sub-property.

Referenced by visit_sub_properties().