ddl::mapping::rt::MappingEngine Class Reference

The mapping engine to create the targets. More...

#include <mapping_engine_legacy.h>

Public Member Functions
	MappingEngine (IMappingEnvironment &env)
	~MappingEngine ()
a_util::result::Result	setConfiguration (const MapConfiguration &config)
a_util::result::Result	Map (const std::string &target_name, handle_t &mapped_signal)
a_util::result::Result	reset ()
a_util::result::Result	start ()
a_util::result::Result	stop ()
a_util::result::Result	unmap (handle_t mapped_signal)
bool	hasTriggers (handle_t mapped_signal) const
a_util::result::Result	getCurrentData (handle_t mapped_signal, void *target_buffer, size_t target_buffer_size) const
a_util::result::Result	unmapAll ()

Detailed Description

The mapping engine to create the targets.

Constructor & Destructor Documentation

MappingEngine()

ddl::mapping::rt::MappingEngine::MappingEngine

(

IMappingEnvironment &

env

)

CTOR

Parameters

[in]

env

- Mapping environment, used as interface

~MappingEngine()

ddl::mapping::rt::MappingEngine::~MappingEngine

(

)

DTOR

Member Function Documentation

getCurrentData()

a_util::result::Result ddl::mapping::rt::MappingEngine::getCurrentData	(	handle_t	mapped_signal,
		void *	target_buffer,
		size_t	target_buffer_size ) const

Method to send current data

Parameters

[in]	mapped_signal	The target handle
[in]	target_buffer	The pointer referencing the target buffer
[in]	target_buffer_size	The size of the target buffer

Return values

a_util::result::SUCCESS	Everything went fine
ERR_INVALID_ARG	Invalid target handle or target buffer is NULL
ERR_MEMORY	Target buffer not large enough

hasTriggers()

bool ddl::mapping::rt::MappingEngine::hasTriggers

(

handle_t

mapped_signal

)

const

Method to know if signal has triggers or not

Parameters

[in]

mapped_signal

The target handle

Return values

true	Signal has triggers
false	Signal has no triggers

Map()

a_util::result::Result ddl::mapping::rt::MappingEngine::Map	(	const std::string &	target_name,
		handle_t &	mapped_signal )

Method to instanciate or expand the mapping structure for one particular target

Parameters

[in]	target_name	The target name
[out]	mapped_signal	- Destination parameter for the signal handle

Return values

a_util::result::SUCCESS	Everything went fine
ERR_INVALID_ARG	Error target already mapped or not found in mapping configuration
ERR_FAILED	Error during creation of the mapping

reset()

a_util::result::Result ddl::mapping::rt::MappingEngine::reset

(

)

Method to reset target buffers

Return values

a_util::result::SUCCESS	Everything went fine
ERR_FAILED	Error during runtime

setConfiguration()

a_util::result::Result ddl::mapping::rt::MappingEngine::setConfiguration

(

const MapConfiguration &

config

)

Setter for the current mapping configuration

Parameters

[in]

config

- The Configuration instance

Return values

a_util::result::SUCCESS

Everything went fine

start()

a_util::result::Result ddl::mapping::rt::MappingEngine::start

(

)

Method to start mapping

Return values

a_util::result::SUCCESS	Everything went fine
ERR_FAILED	Error during runtime

stop()

a_util::result::Result ddl::mapping::rt::MappingEngine::stop

(

)

Method to stop mapping

Return values

a_util::result::SUCCESS

Everything went fine

unmap()

a_util::result::Result ddl::mapping::rt::MappingEngine::unmap

(

handle_t

mapped_signal

)

Method to remove a target from the existing mapping structure

Parameters

[in]

mapped_signal

- Target handle

Return values

a_util::result::SUCCESS	Everything went fine
ERR_INVALID_ARG	Error target not found in mapping structure
ERR_FAILED	Error during removal

unmapAll()

a_util::result::Result ddl::mapping::rt::MappingEngine::unmapAll

(

)

Method to reinitialize the existing mapping structure

Return values

a_util::result::SUCCESS	Everything went fine
ERR_FAILED	Error during reinitialization

---

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

• include/ddl/mapping/legacy/engine/mapping_engine_legacy.h