ddl::mapping::rt::Source Class Reference

the engine source More...

#include <source.h>

Inherits ddl::mapping::rt::ISignalListener.

Public Member Functions
	Source (IMappingEnvironment &env)
	Source (const Source &)=delete
	no copy CTOR
Source &	operator= (const Source &)=delete
	no copy assignment operator
	~Source ()
a_util::result::Result	create (const mapping::MapSource &map_source, const std::string &type_description)
a_util::result::Result	addAssignment (const ddl::mapping::MapConfiguration &map_config, const std::string &source_element, TargetElement *target_element)
a_util::result::Result	addTrigger (const MapConfiguration &map_config, TriggerBase *trigger)
a_util::result::Result	removeAssignmentsFor (const Target *target)
const std::string &	getTypeName () const
const Assignments &	getAssigmentList () const
a_util::result::Result	onSampleReceived (const void *data, size_t size)
Public Member Functions inherited from ddl::mapping::rt::ISignalListener
virtual	~ISignalListener ()
	DTOR.

Detailed Description

the engine source

Constructor & Destructor Documentation

Source()

ddl::mapping::rt::Source::Source

(

IMappingEnvironment &

env

)

CTOR

Parameters

[in]

env

The mapping environment

~Source()

ddl::mapping::rt::Source::~Source

(

)

DTOR

Member Function Documentation

addAssignment()

a_util::result::Result ddl::mapping::rt::Source::addAssignment	(	const ddl::mapping::MapConfiguration &	map_config,
		const std::string &	source_element,
		TargetElement *	target_element )

Method to add a new pair of source element and target element to the intern assignment list

Parameters

[in]	map_config	The Configuration instance
[in]	source_element	The name of the source element to map
[in]	target_element	The target element instance

Return values

a_util::result::SUCCESS

Everything went fine

addTrigger()

a_util::result::Result ddl::mapping::rt::Source::addTrigger	(	const MapConfiguration &	map_config,
		TriggerBase *	trigger )

Method to add a new trigger to the intern trigger list

Parameters

[in]	map_config	The Configuration instance
[in]	trigger	The trigger

Return values

a_util::result::SUCCESS

Everything went fine

create()

a_util::result::Result ddl::mapping::rt::Source::create	(	const mapping::MapSource &	map_source,
		const std::string &	type_description )

Creation method to fill the object with data.

Parameters

[in]	map_source	The soucre representation from mapping configuration
[in]	type_description	The description for the source type

Return values

a_util::result::SUCCESS	Everything went fine
ERR_FAILED	Error while filing the object

getAssigmentList()

const Assignments & ddl::mapping::rt::Source::getAssigmentList

(

)

const

Getter for the assignment list

Returns

the assignment list

getTypeName()

const std::string & ddl::mapping::rt::Source::getTypeName

(

)

const

Getter for the source type

Returns

the source type

onSampleReceived()

a_util::result::Result ddl::mapping::rt::Source::onSampleReceived ( const void * data, size_t size )

virtual

Method to handle a sample when it is received.

Parameters

[in]	data	The memory location of the received buffer
[in]	size	The memory size of the received buffer

Return values

a_util::result::SUCCESS

Everything went fine

Implements ddl::mapping::rt::ISignalListener.

operator=()

Source & ddl::mapping::rt::Source::operator= ( const Source & )

delete

no copy assignment operator

Returns

Source&

removeAssignmentsFor()

a_util::result::Result ddl::mapping::rt::Source::removeAssignmentsFor

(

const Target *

target

)

Method to remove all elements of a target from the intern assignment list

Parameters

[in]

target

The target to unmap

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/source.h