ddl::mapping::rt::Target Class Reference

Target represents a mapped target signal in the runtime api. More...

#include <target.h>

Public Types
typedef std::vector< std::pair< std::string, TargetElement * > >	Assignments
	Assignment container.
typedef std::vector< std::pair< uint64_t, TargetElement * > >	TriggerCounters
	Trigger counter container.
typedef std::vector< std::pair< std::string, TargetElement * > >	Constants
	Constant container.
typedef std::vector< uint8_t >	MemoryBuffer
	Generic byte-buffer.

Public Member Functions
	Target (IMappingEnvironment &env)
	~Target ()
a_util::result::Result	create (const MapConfiguration &map_config, const MapTarget &map_target, const std::string &target_description, SourceMap &sources)
a_util::result::Result	reset (const MapConfiguration &map_config)
const std::string &	getName () const
const std::string &	getTypeName () const
const TargetElementList &	getElementList () const
size_t	getSize () const
a_util::result::Result	getCurrentBuffer (void *target_buffer, size_t target_buffer_size)
a_util::result::Result	getBufferRef (const void *&buffer, size_t &target_buffer_size)
a_util::result::Result	updateAccessFunctionValues ()
a_util::result::Result	updateTriggerFunctionValues ()
void	aquireWriteLock () const
	Lock the buffer for a source update.
void	releaseWriteLock () const
	Unlock the buffer after a source update.
void	aquireReadLock () const
	Lock the buffer for a buffer read.
void	releaseReadLock () const
	Unlock the buffer after a buffer read.

Detailed Description

Target represents a mapped target signal in the runtime api.

Constructor & Destructor Documentation

Target()

ddl::mapping::rt::Target::Target

(

IMappingEnvironment &

env

)

CTOR

Parameters

[in]

env

The environment

~Target()

ddl::mapping::rt::Target::~Target

(

)

DTOR

Member Function Documentation

create()

a_util::result::Result ddl::mapping::rt::Target::create	(	const MapConfiguration &	map_config,
		const MapTarget &	map_target,
		const std::string &	target_description,
		SourceMap &	sources )

Creation method to fill the object with data.

Parameters

[in]	map_config	- The Configuration instance
[in]	map_target	- target representation from mapping configuration
[in]	target_description	- target description
[in,out]	sources	the sources

Return values

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

getBufferRef()

a_util::result::Result ddl::mapping::rt::Target::getBufferRef	(	const void *&	buffer,
		size_t &	target_buffer_size )

Method to get access to the current buffer without copying it

Parameters

[in]	buffer	Destination pointer
[out]	target_buffer_size	Destination parameter for the size of the buffer

Return values

a_util::result::SUCCESS

Everything went fine

getCurrentBuffer()

a_util::result::Result ddl::mapping::rt::Target::getCurrentBuffer	(	void *	target_buffer,
		size_t	target_buffer_size )

Method to get a copy of the current target buffer

Parameters

[in]	target_buffer	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_MEMORY	Target buffer size not large enough

getElementList()

const TargetElementList & ddl::mapping::rt::Target::getElementList

(

)

const

Getter for the element list

Returns

the element list

getName()

const std::string & ddl::mapping::rt::Target::getName

(

)

const

Getter for the target name

Returns

the target name

getSize()

size_t ddl::mapping::rt::Target::getSize

(

)

const

Method to get buffer size

Return values

buffer

size

getTypeName()

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

(

)

const

Getter for the target type

Returns

the target type

reset()

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

(

const MapConfiguration &

map_config

)

Reset target Buffers

Parameters

[in]

map_config

- The Configuration instance

Returns

error code

updateAccessFunctionValues()

a_util::result::Result ddl::mapping::rt::Target::updateAccessFunctionValues

(

)

Method to update all dynamic values that are to be updates during buffer access (i.e. simulation time)

updateTriggerFunctionValues()

a_util::result::Result ddl::mapping::rt::Target::updateTriggerFunctionValues

(

)

Method to update all dynamic values that are to be updates during a trigger (i.e. trigger counters)

---

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

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