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

Namespaces
namespace	detail
	Namespace for all internally used functionality implemented.

Classes
class	adtf_memory

class	adtf_memory_buffer
	Template class implementation for the IRawMemory interface. More...

class	adtf_memory_buffer< T, typename std::enable_if< std::is_const< T >::value >::type >
	Template class implementation for the IRawMemory interface for const types. More...

struct	adtf_memory_forward

struct	adtf_memory_forward< adtf_util::cMemoryBlock >

struct	adtf_memory_forward< adtf_util::cMemoryPtr >

struct	adtf_memory_forward< const ::adtf::streaming::ant::ISampleBuffer >

struct	adtf_memory_forward< const std::string >

struct	adtf_memory_forward< const std::u16string >

struct	adtf_memory_forward< const std::vector< Args... > >

struct	adtf_memory_forward< const void >

struct	adtf_memory_forward< std::string >

struct	adtf_memory_forward< std::u16string >

struct	adtf_memory_forward< std::vector< Args... > >

struct	adtf_memory_forward< void >

class	adtf_string
	Wrapping template for a rvalue reference of an IString interface for the type T. More...

struct	adtf_string_forward

struct	adtf_string_forward< adtf::util::cFilename >

struct	adtf_string_forward< adtf::util::cString >

struct	adtf_string_forward< const adtf::util::cFilename >

struct	adtf_string_forward< const adtf::util::cString >

struct	adtf_string_forward< const char >

struct	adtf_string_forward< const std::string >

struct	adtf_string_forward< const std::string_view >

struct	adtf_string_forward< std::string >

struct	adtf_string_forward< std::string_view >

struct	adtf_version_customer

struct	adtf_version_default

struct	cFilenameConversion

struct	cFilenameListConversion

class	configuration

class	cProperties

class	cPropertiesBase

class	cPropertiesHelper

class	cPropertyBase

struct	cPropertyConvert

struct	cPropertyStringConversion

class	cPropertyVariable

class	hash_value_map

class	IConfiguration

class	IHashValueMap

class	IHashValueMapValue

class	IMemberPropertyUnregister
	Interface to automatically unregister the given property variable from observed properties set. More...

class	IProperties

class	IProperty

class	IPropertyObserver

class	IPropertyValue

class	IRawMemory

class	IRawValue

class	IRunnable

class	IString

class	property

struct	property_attached_configuration_type

struct	property_type_conversion

struct	property_type_conversion_nothing

struct	property_type_default_conversion

struct	property_type_definition

struct	property_type_definition< adtf::util::cFilename >

struct	property_type_definition< adtf::util::cFilenameList >

struct	property_type_definition< adtf::util::cFilepath >

struct	property_type_definition< adtf::util::cFilepathList >

struct	property_type_definition< adtf::util::cString >

struct	property_type_definition< bool >

struct	property_type_definition< double >

struct	property_type_definition< elasto::tree_node_property_type >

struct	property_type_definition< flash::tNanoSeconds >
	property_type_definition specialization for flash::tNanoSeconds More...

struct	property_type_definition< float >

struct	property_type_definition< int16_t >

struct	property_type_definition< int32_t >

struct	property_type_definition< int64_t >

struct	property_type_definition< int8_t >

struct	property_type_definition< property_attached_configuration_type >

struct	property_type_definition< std::string >
	property_type_definition specialization for std::string More...

struct	property_type_definition< uint16_t >

struct	property_type_definition< uint32_t >

struct	property_type_definition< uint64_t >

struct	property_type_definition< uint8_t >

class	property_value

class	property_variable
	Property Variable template for the given `T`. A Property Variable will store a copy of a property value of the specified type `T`. More...

struct	std_string_helper

Typedefs
template<ant::IRunnable::tActivationType DEFAULT_ACTIVATION_TYPE = ant::IRunnable::RUN_UNSPECIFIED, typename ANT_INTERFACE = ant::IRunnable, typename CALLABLE = ant::IRunnable::tRunFunction>
using	runnable = adtf::base::runnable<DEFAULT_ACTIVATION_TYPE, ANT_INTERFACE, flash::IRunnable, CALLABLE>

Enumerations
enum	tADTFRunLevel : int8_t { RL_Shutdown = ucom::ant::IRuntime::RL_Shutdown , RL_System = 1 , RL_Session = 2 , RL_StreamingGraph = 3 , RL_FilterGraph = 4 , RL_Running = 5 , RL_Max = RL_Running , RL_Internal = ucom::ant::IRuntime::RL_Internal }

Functions
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>
VALUETYPE	get_property (const IConfiguration &oConfiguration, const char *strNameOfValue)
	Get the property converted to the `VALUETYPE`.

template<typename VALUETYPE>
tResult	set_property (IConfiguration &oConfiguration, const char *strNameOfValue, VALUETYPE oValue)
	Set the property.

tResult	set_property (IConfiguration &oConfiguration, const char strNameOfValue, const char poValue)
	Set the property of type string for a const char* parameter `poValue`.

adtf::util::cVariant	get_hash_value (const IHashValueMap &oMap, const IHashValueMap::tHashKey &oHash, const adtf::util::cVariant oDefault)

tResult	set_hash_value (IHashValueMap &oMap, const IHashValueMap::tHashKey &oHash, const adtf::util::cVariant oValue)

IHashValueMap::tHashKey	create_hash_value_key (const char *strToHash)

template<typename VALUETYPE>
tResult	set_property (IProperties &oProperties, const char *strNameOfValue, VALUETYPE oValue)

tResult	set_property (IProperties &oProperties, const char strNameOfValue, const char poValue)

template<typename T>
T	get_property (const IProperties &oProperties, const char *strNameOfValue, const T &oDefaultValue)

template<typename VALUETYPE>
VALUETYPE	get_property (const IProperties &oProperties, const char *strNameOfValue)

bool	operator== (const IProperty &oPropertyLeft, const IProperty &oPropertyRight)
	The equality operator returns true only if the given `oPropertyLeft` is the same as `oPropertyRight`. It checks the property (sub properties included) values and names for equality. Standard property types are compared by their types, user defined properties as strings. This works in both ways.

bool	operator!= (const IProperty &oPropertyLeft, const IProperty &oPropertyRight)
	The not-equality operator returns false only if the given `oPropertyLeft` is exact the same as `oPropertyRight`. It checks the property types and raw values for equality. Standard property types are compared by their types, user defined properties as strings. This works in both ways.

bool	operator== (const IProperties &oPropertiesLeft, const IProperties &oPropertiesRight)
	The equality operator returns true only if the given `oPropertiesLeft` has the same properties and property values as `oPropertiesRight`. Therefore property values, names and sub properties are compared. The property type is exactly compared for standard property types. User defined properties are compared as strings. This works in both ways.

bool	operator!= (const IProperties &oPropertiesLeft, const IProperties &oPropertiesRight)
	The not-equality operator returns false only if the given `oPropertiesLeft` has the same properties and property values as `oPropertiesRight`. Therefore property values, names and sub properties are compared. The property type is exactly compared for standard property types. User defined properties are compared as strings. This works in both ways.

Detailed Description

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

Typedef Documentation

◆ runnable

template<ant::IRunnable::tActivationType DEFAULT_ACTIVATION_TYPE = ant::IRunnable::RUN_UNSPECIFIED, typename ANT_INTERFACE = ant::IRunnable, typename CALLABLE = ant::IRunnable::tRunFunction>

using adtf::base::ant::runnable = adtf::base::runnable<DEFAULT_ACTIVATION_TYPE, ANT_INTERFACE, flash::IRunnable, CALLABLE>

Runnable template alias for detail::runnable with ANT_INTERFACE set to ant::IRunnable and FLASH_INTERFACE set to flash::IRunnable.

Template Parameters

DEFAULT_ACTIVATION_TYPE	The default activation type for the runnable, which will be used if not specified
ANT_INTERFACE	The ant::IRunnable interface to expose, ant::IRunnable or any derived type.
CALLABLE	The type of the callable to be executed on Run, must be invocable with either of the defined signatures: see detail::runnable.

Remarks: This alias template is provided for legacy reasons.

Enumeration Type Documentation

◆ tADTFRunLevel

enum adtf::base::ant::tADTFRunLevel : int8_t

The ADTF Runtime Level State are used to define a ADTF Runtime specialization for a adtf::ucom::ant::runtime.

Enumerator
RL_Shutdown	The system is shut down.
RL_System	The system level.
RL_Session	The session level.
RL_StreamingGraph	The Streaminggraph level.
RL_FilterGraph	The Filtergraph level.
RL_Running	The Running level.
RL_Max	maximum level that can be reached
RL_Internal	internal runlevel Is not for users !

Function Documentation

◆ create_hash_value_key()

IHashValueMap::tHashKey adtf::base::ant::create_hash_value_key ( const char * strToHash )

Generation of unambigious hash key for a string. This generation is independent to process and platform.

Parameters

[in] strToHash null terminated string to generate a hash key for.

Returns: Hash key for strToHash.

◆ get_hash_value()

adtf::util::cVariant adtf::base::ant::get_hash_value	(	const IHashValueMap &	oMap,
		const IHashValueMap::tHashKey &	oHash,
		const adtf::util::cVariant	oDefault )

Retrieves a variant value for the hash key oHash out of the hashed value map oMap. If the value does not exists the oDefault is returned.

Parameters

[in]	oMap	The map to retrieve the value from.
[in]	oHash	The hash key of the value.
[in]	oDefault	default value if value does not exist.

Returns: retrieved value.

◆ get_property() [1/4]

template<typename VALUETYPE>

VALUETYPE adtf::base::ant::get_property	(	const IConfiguration &	oConfiguration,
		const char *	strNameOfValue )

Get the property converted to the VALUETYPE.

Template Parameters

VALUETYPE The type of the property

Parameters

oConfiguration	The configuration to look at
strNameOfValue	The name of the property

Returns: VALUETYPE

◆ get_property() [2/4]

template<typename VALUETYPE>

VALUETYPE adtf::base::ant::get_property	(	const IConfiguration &	oConfiguration,
		const char *	strNameOfValue,
		VALUETYPE	oDefaultValue )

Get the property content converted to the VALUETYPE.

Template Parameters

VALUETYPE The type of the property

Parameters

oConfiguration	The configuratiion to look at
strNameOfValue	The name of the property
oDefaultValue	The default value if not found

Returns: VALUETYPE

◆ get_property() [3/4]

template<typename VALUETYPE>

VALUETYPE adtf::base::ant::get_property	(	const IProperties &	oProperties,
		const char *	strNameOfValue )

Gets a property value of the value type VALUETYPE from a IProperties implementation.

Make sure the property<VALUETYPE> implementation exists, see also property_type_definition.

Template Parameters

VALUETYPE [in] value type of the value to return

Parameters

oProperties	[in] property store where to get the property from.
strNameOfValue	[in] The Name of the property

Returns: Returns the value as VALUETYPE

◆ get_property() [4/4]

template<typename T>

T adtf::base::ant::get_property	(	const IProperties &	oProperties,
		const char *	strNameOfValue,
		const T &	oDefaultValue )

Gets a property value of the value type VALUETYPE from a IProperties implementation.

Make sure the property<VALUETYPE> implementation exists, see also property_type_definition.

Template Parameters

VALUETYPE [in] value type of the value to return

Parameters

oProperties	[in] property store where to get the property from.
strNameOfValue	[in] The Name of the property
oDefaultValue	[in] default value of return value if property is not found.

Returns: Returns the value as VALUETYPE

◆ operator!=() [1/2]

bool adtf::base::ant::operator!=	(	const IProperties &	oPropertiesLeft,
		const IProperties &	oPropertiesRight )

The not-equality operator returns false only if the given oPropertiesLeft has the same properties and property values as oPropertiesRight. Therefore property values, names and sub properties are compared. The property type is exactly compared for standard property types. User defined properties are compared as strings. This works in both ways.

Parameters

oPropertiesLeft	The left property set for comparison
oPropertiesRight	The property set to compare with

Return values

true	properties and the corresponding values are not equal
false	properties and the corresponding values are equal

◆ operator!=() [2/2]

bool adtf::base::ant::operator!=	(	const IProperty &	oPropertyLeft,
		const IProperty &	oPropertyRight )

The not-equality operator returns false only if the given oPropertyLeft is exact the same as oPropertyRight. It checks the property types and raw values for equality. Standard property types are compared by their types, user defined properties as strings. This works in both ways.

Parameters

oPropertyLeft	The left property for comparison
oPropertyRight	The property to compare with

Return values

true	property value and the corresponding property type are not equal
false	property value and the corresponding property type are equal

◆ operator==() [1/2]

bool adtf::base::ant::operator==	(	const IProperties &	oPropertiesLeft,
		const IProperties &	oPropertiesRight )

The equality operator returns true only if the given oPropertiesLeft has the same properties and property values as oPropertiesRight. Therefore property values, names and sub properties are compared. The property type is exactly compared for standard property types. User defined properties are compared as strings. This works in both ways.

Parameters

oPropertiesLeft	The left property set for comparison
oPropertiesRight	The property set to compare with

Return values

true	properties and the corresponding values are equal
false	properties and the corresponding values are not equal

◆ operator==() [2/2]

bool adtf::base::ant::operator==	(	const IProperty &	oPropertyLeft,
		const IProperty &	oPropertyRight )

The equality operator returns true only if the given oPropertyLeft is the same as oPropertyRight. It checks the property (sub properties included) values and names for equality. Standard property types are compared by their types, user defined properties as strings. This works in both ways.

Parameters

oPropertyLeft	The left property for comparison
oPropertyRight	The property to compare with

Return values

true	property value and the corresponding property type are equal
false	property value and the corresponding property type are not equal

◆ set_hash_value()

tResult adtf::base::ant::set_hash_value	(	IHashValueMap &	oMap,
		const IHashValueMap::tHashKey &	oHash,
		const adtf::util::cVariant	oValue )

Sets a variant value for the hash key oHash into the hashed value map oMap.

Parameters

[in]	oMap	The map to set the value to.
[in]	oHash	The hash key of the value.
[in]	oValue	value to set.

Returns: standard error code

Return values

ERR_NOERROR	value is set
ERR_INVALID_TYPE	Type is not supported. See IHashValueMapValue::tType

◆ set_property() [1/4]

tResult adtf::base::ant::set_property	(	IConfiguration &	oConfiguration,
		const char *	strNameOfValue,
		const char *	poValue )

inline

Set the property of type string for a const char* parameter poValue.

Parameters

oConfiguration	The configuration to set at
strNameOfValue	The name of the property
oValue	The value of the property

Returns: tResult

◆ set_property() [2/4]

template<typename VALUETYPE>

tResult adtf::base::ant::set_property	(	IConfiguration &	oConfiguration,
		const char *	strNameOfValue,
		VALUETYPE	oValue )

Set the property.

Template Parameters

VALUETYPE The type of the property to set

Parameters

oConfiguration	The configuration to set at
strNameOfValue	The name of the property
oValue	The value of the property

Returns: tResult

◆ set_property() [3/4]

tResult adtf::base::ant::set_property	(	IProperties &	oProperties,
		const char *	strNameOfValue,
		const char *	poValue )

inline

Sets a property of the value type const char* to a IProperties implementation.

This function specialization will be used to set const char* values as adtf::util::cString value.

Parameters

[in]	oProperties	property store where to set the property to.
[in]	strNameOfValue	the name of the property
[in]	poValue	const tCHar* value

Return values

ERR_NOERROR	Property is set.
ERR_NOT_IMPL	Property can not be set.

◆ set_property() [4/4]

template<typename VALUETYPE>

tResult adtf::base::ant::set_property	(	IProperties &	oProperties,
		const char *	strNameOfValue,
		VALUETYPE	oValue )

Sets a property of the value type VALUETYPE to a IProperties implementation.

Make sure the property<VALUETYPE> implementation exists, see also property_type_definition.

Template Parameters

VALUETYPE [in] value type of value oValue

Parameters

[in]	oProperties	property store where to set the property to.
[in]	strNameOfValue	the name of the property
[in]	oValue	value of type `VALUETYPE`

Return values

ERR_NOERROR	Property is set.
ERR_NOT_IMPL	Property can not be set.

Namespaces

Classes

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ runnable

Enumeration Type Documentation

◆ tADTFRunLevel

Function Documentation

◆ create_hash_value_key()

◆ get_hash_value()

◆ get_property() [1/4]

◆ get_property() [2/4]

◆ get_property() [3/4]

◆ get_property() [4/4]

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ set_hash_value()

◆ set_property() [1/4]

◆ set_property() [2/4]

◆ set_property() [3/4]

◆ set_property() [4/4]