adtf::system Namespace Reference

Namespace for the ADTF System SDK. More...

Namespaces
namespace	ant
	Namespace for all functionality of the ADTF System SDK provided since v3.0.
namespace	flash
	Namespace for all functionality of the ADTF System SDK provided since v3.5.
namespace	hollow
	Namespace for all functionality of the ADTF System SDK provided since v3.7.
namespace	lucky
	Namespace for all functionality of the ADTF System SDK provided since v3.11.
namespace	testing
	Namespace for all testing functionality of the ADTF System SDK.
namespace	yak
	Namespace for all functionality of the ADTF System SDK provided since v3.24.

Classes
class	cADTFService
class	cADTFSystem
class	cBaseClock
class	cDiscreteClock
class	cInterpolatingClock
class	cKernelThreadLoop
class	ICacheStatus
class	kernel_runnable
class	kernel_thread
class	kernel_thread_looper
class	kernel_timeout
class	kernel_timer
struct	tResolvedMacro

Functions
template<typename CALLABLE, typename... ARGS>
	kernel_runnable (CALLABLE &&, ARGS &&...) -> kernel_runnable< adtf::base::ant::IRunnable::RUN_THREAD, CALLABLE && >
std::string	create_report ()
void	create_report (std::ostream &oStream)
Json::Value	create_resolved_macros (const std::vector< tResolvedMacro > &oResolvedMacros)
std::vector< tResolvedMacro >	get_resolved_macros ()

Detailed Description

Namespace for the ADTF System SDK.

Within this namespace all interfaces, classes and functions always refer to their last revised implementation (version namespace). When using types defined within this namespace it is guaranteed to always use the latest version of the types.

The ADTF System SDK provides basic implementations for the ADTF System at service level.

ADTF was designed as service oriented runtime system. The main focus of this package is to define concrete interfaces system interface and helper implementations to develop a (system) service to provide functionality/interfaces.

All available versioned interfaces are collected at the namespace adtf::services.

Use the adtf::services::cADTFService base class to develop own services.

Base classes to create and register own clocks:

ADTFs main service interface is the adtf::services::IReferenceClock. To add and register your own clock you can use the base classes:

• adtf::servicescDiscreteClock for a discrete clock that send events each time the time is changing
• adtf::servicescInterpolatingClock for a continuous clock that interpolates between each synchronization point

Create a standalone ADTF System:

The class adtf::services::cADTFSystem is used to create a launcher for a ADTF System. This is also the Base class used for the ADTF Launcher, but has more a testing purpose.

Function Documentation

create_report() [1/2]

std::string adtf::system::create_report

(

)

Creates a report of the ADTF system.

Returns

The report as JSON string.

create_report() [2/2]

void adtf::system::create_report

(

std::ostream &

oStream

)

Creates a report of the ADTF system and writes it to a stream.

Parameters

[in,out]

oStream

The stream to write the JSON report to.

create_resolved_macros()

Json::Value adtf::system::create_resolved_macros

(

const std::vector< tResolvedMacro > &

oResolvedMacros

)

Creates the JSON representation of resolved macros and environment variables. Environment-variable values are masked in the resulting JSON data.

Parameters

[in]

oResolvedMacros

The resolved macros and environment variables.

Returns

The resolved macros as a JSON array.

kernel_runnable()

template<typename CALLABLE, typename... ARGS>

adtf::system::kernel_runnable	(	CALLABLE &&	,
		ARGS &&	... ) -> kernel_runnable< adtf::base::ant::IRunnable::RUN_THREAD, CALLABLE && >

deduction guide for kernel_runnable with default activation type RUN_THREAD

Note

Usage:

// activation type is always deduced as RUN_THREAD:
kernel_runnable kr1(callable);
 
// Use of deduction guide — with activation type RUN_TIMER at runtime:
kernel_runnable kr1(callable, adtf::base::ant::IRunnable::RUN_TIMER);