#include <mapping_environment_intf.h>

Public Member Functions
virtual	~IMappingEnvironment ()
	DTOR.

virtual a_util::result::Result	registerSource (const char source_name, const char type_name, ISignalListener *listener, handle_t &handle)=0

virtual a_util::result::Result	unregisterSource (handle_t handle)=0

virtual a_util::result::Result	sendTarget (handle_t target, const void *data, size_t size, timestamp_t time_stamp)=0

virtual a_util::result::Result	targetMapped (const char target_name, const char target_type, handle_t target, size_t target_size)=0

virtual a_util::result::Result	targetUnmapped (const char *target_name, handle_t target)=0

virtual a_util::result::Result	resolveType (const char type_name, const char &type_description)=0

virtual timestamp_t	getTime () const =0

virtual a_util::result::Result	registerPeriodicTimer (timestamp_t period_us, IPeriodicListener *listener)=0

virtual a_util::result::Result	unregisterPeriodicTimer (timestamp_t period_us, IPeriodicListener *listener)=0

Detailed Description

Mapping environment interface class This in combination with ISignalListener forms the functionality that the environment using the mapping package must provide.

Member Function Documentation

◆ getTime()

virtual timestamp_t ddl::mapping::rt::IMappingEnvironment::getTime ( ) const

pure virtual

getTime is used by the mapping engine to get the current time. Since only the application of mapping can now what time domain should be used, this method has to be implementied by the environment.

Returns: The current timestamp in microseconds

◆ registerPeriodicTimer()

virtual a_util::result::Result ddl::mapping::rt::IMappingEnvironment::registerPeriodicTimer	(	timestamp_t	period_us,
		IPeriodicListener *	listener )

pure virtual

registerPeriodicTimer is used by the mapping engine to register periodic timers

Parameters

[in]	period_us	The period
[in]	listener	The listener to be called periodically

Returns: Standard result

◆ registerSource()

virtual a_util::result::Result ddl::mapping::rt::IMappingEnvironment::registerSource	(	const char *	source_name,
		const char *	type_name,
		ISignalListener *	listener,
		handle_t &	handle )

pure virtual

Method to register a source signal. registerSource is called for all source signals inside a mapped target signal.

Parameters

[in]	source_name	The name of the source signal
[in]	type_name	The type of the source signal
[in]	listener	The signal listener instance
[in]	handle	The output parameter for the source handle

Return values

a_util::result::SUCCESS Everything went fine

◆ resolveType()

virtual a_util::result::Result ddl::mapping::rt::IMappingEnvironment::resolveType	(	const char *	type_name,
		const char *&	type_description )

pure virtual

Method to get the ddl description for a type

Parameters

[in]	type_name	The name of the type to be resolved
[out]	type_description	Output paramter for the description for the type

Return values

a_util::result::SUCCESS Everything went fine

◆ sendTarget()

virtual a_util::result::Result ddl::mapping::rt::IMappingEnvironment::sendTarget	(	handle_t	target,
		const void *	data,
		size_t	size,
		timestamp_t	time_stamp )

pure virtual

Method to send a target signal. It is called upon

Parameters

[in]	target	The target handle
[in]	data	The pointer referencing the target buffer
[in]	size	The size of the target buffer
[in]	time_stamp	The timestamp of the target

Return values

a_util::result::SUCCESS Everything went fine

◆ targetMapped()

virtual a_util::result::Result ddl::mapping::rt::IMappingEnvironment::targetMapped	(	const char *	target_name,
		const char *	target_type,
		handle_t	target,
		size_t	target_size )

pure virtual

targetMapped is invoked by the mapping engine upon the creation of a mapping. The callback is supposed to give the mapping environment a chance to preallocate any sample buffers to be used during runtime.

Parameters

[in]	target_name	The target name
[in]	target_type	The target type
[in]	target	The handle under which the target is refered to in `sendTarget`
[in]	target_size	The target type size (size of a sample in bytes)

Return values

a_util::result::SUCCESS Everything went fine

◆ targetUnmapped()

virtual a_util::result::Result ddl::mapping::rt::IMappingEnvironment::targetUnmapped	(	const char *	target_name,
		handle_t	target )

pure virtual

targetUnmapped is invoked by the mapping engine upon the destruction of a mapping. The callback is supposed to give the mapping environment a chance to cleanup any sample buffers associated with that target.

Parameters

[in]	target_name	The target name
[in]	target	The target handle

Return values

a_util::result::SUCCESS Everything went fine

◆ unregisterPeriodicTimer()

virtual a_util::result::Result ddl::mapping::rt::IMappingEnvironment::unregisterPeriodicTimer	(	timestamp_t	period_us,
		IPeriodicListener *	listener )

pure virtual

registerPeriodicTimer is used by the mapping engine to unregister periodic timers

Parameters

[in]	period_us	The period
[in]	listener	The listener

Returns: Standard result

◆ unregisterSource()

virtual a_util::result::Result ddl::mapping::rt::IMappingEnvironment::unregisterSource ( handle_t handle )

pure virtual

Method to unregister a source signal. Used to unregister any source signals upon unmapping of a target signal.

Parameters

[in] handle The handle of the source signal

Return values

a_util::result::SUCCESS Everything went fine

The documentation for this class was generated from the following file:

include/ddl/mapping/legacy/engine/mapping_environment_intf.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ getTime()

◆ registerPeriodicTimer()

◆ registerSource()

◆ resolveType()

◆ sendTarget()

◆ targetMapped()

◆ targetUnmapped()

◆ unregisterPeriodicTimer()

◆ unregisterSource()