adtf::base::ant Namespace Reference

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
class	hash_value_map
class	IConfiguration
class	IHashValueMap
class	IHashValueMapValue
class	IProperties
class	IProperty
class	IPropertyObserver
class	IPropertyValue
class	IRawMemory
class	IRawValue
class	IRunnable
class	IString

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
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)
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.

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