MappingEngine

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

Public Member Functions
	MappingEngine (IMappingEnvironment &env)
	CTOR. More...
	~MappingEngine ()
	DTOR.
a_util::result::Result	setConfiguration (const MapConfiguration &config)
	Setter for the current mapping configuration. More...
a_util::result::Result	Map (const std::string &target_name, handle_t &mapped_signal)
	Method to instanciate or expand the mapping structure for one particular target. More...
a_util::result::Result	reset ()
	Method to reset target buffers. More...
a_util::result::Result	start ()
	Method to start mapping. More...
a_util::result::Result	stop ()
	Method to stop mapping. More...
a_util::result::Result	unmap (handle_t mapped_signal)
	Method to remove a target from the existing mapping structure. More...
bool	hasTriggers (handle_t mapped_signal) const
	Method to know if signal has triggers or not. More...
a_util::result::Result	getCurrentData (handle_t mapped_signal, void *target_buffer, size_t target_buffer_size) const
	Method to send current data. More...
a_util::result::Result	unmapAll ()
	Method to reinitialize the existing mapping structure. More...

Private Member Functions
a_util::result::Result	initializeModel ()
	Method to give an initial value to all targets. More...

Private Attributes
IMappingEnvironment &	_env
bool	_running
MapConfiguration	_map_config
TargetMap	_targets
SourceMap	_sources
TriggerMap	_triggers

Detailed Description

The mapping engine to create the targets.

Definition at line 41 of file mapping_engine.h.

Constructor & Destructor Documentation

MappingEngine()

MappingEngine

(

IMappingEnvironment &

env

)

CTOR.

Parameters

[in]

env

- Mapping environment, used as interface

Member Function Documentation

getCurrentData()

a_util::result::Result 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 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

initializeModel()

a_util::result::Result initializeModel ( )

private

Method to give an initial value to all targets.

Return values

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

Map()

a_util::result::Result 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 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 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 start

(

)

Method to start mapping.

Return values

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

stop()

a_util::result::Result stop

(

)

Method to stop mapping.

Return values

a_util::result::SUCCESS

Everything went fine

unmap()

a_util::result::Result 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 unmapAll

(

)

Method to reinitialize the existing mapping structure.

Return values

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