ddl::mapping::DDLTarget Class Reference

DDLTarget implementation class representing a MemoryTarget that provides named target values for ddl based encoding. More...

#include <mapping_ddl_target.h>

Inherits ddl::mapping::MapperElementBase< MemoryTarget >.

Public Member Functions
	DDLTarget (std::string name, Properties properties)
	CTOR.
std::vector< std::string >	getAllValues () const override
	Get all value names.
std::shared_ptr< TargetValue >	getValue (const std::string &value_name) const override
	Get the value Target with a certain name.
size_t	getExpectedDataSize () const override
	Get the expected data size of the buffer.
void	updateMemory (std::shared_ptr< Memory > memory) override
	Sets the target's memory buffer where to set the values to.
void	updateEnd () override
	Function callback interface that is called after a value was updated.
Public Member Functions inherited from ddl::mapping::MapperElementBase< MemoryTarget >
	MapperElementBase (std::string name, Properties properties)
	CTOR.
	~MapperElementBase () override=default
	DTOR.
const std::string &	getName () const override
	Get the Name.
const Properties &	getProperties () const override
	Get the Properties.
const Property &	getProperty (const std::string &property_name) const
	Get the Property.
Public Member Functions inherited from ddl::mapping::MemoryTarget
	~MemoryTarget () override=default
	DTOR.
void	reset () override
	resets the current memory buffer
Public Member Functions inherited from ddl::mapping::MapperElement
virtual	~MapperElement ()=default
	DTOR.
Public Member Functions inherited from ddl::mapping::Updateable
virtual void	updateBegin (std::chrono::nanoseconds)
	Function callback interface that is called before a value will be updated.

Static Public Member Functions
static std::string	getType ()
	Get the Type as string to register within factory.
static Properties	getDefaultProperties ()
	Get the Default Properties to register within factory.

Detailed Description

DDLTarget implementation class representing a MemoryTarget that provides named target values for ddl based encoding.

Constructor & Destructor Documentation

DDLTarget()

ddl::mapping::DDLTarget::DDLTarget	(	std::string	name,
		Properties	properties )

CTOR.

Parameters

name	the name of the instance
properties	the properties for the instance

Member Function Documentation

getAllValues()

std::vector< std::string > ddl::mapping::DDLTarget::getAllValues ( ) const

overridevirtual

Get all value names.

Returns

std::vector<std::string>

Implements ddl::mapping::Target.

getDefaultProperties()

static Properties ddl::mapping::DDLTarget::getDefaultProperties ( )

inlinestatic

Get the Default Properties to register within factory.

Returns

Properties

getExpectedDataSize()

size_t ddl::mapping::DDLTarget::getExpectedDataSize ( ) const

overridevirtual

Get the expected data size of the buffer.

Returns

size_t

Implements ddl::mapping::MemoryTarget.

getType()

static std::string ddl::mapping::DDLTarget::getType ( )

inlinestatic

Get the Type as string to register within factory.

Returns

std::string

getValue()

std::shared_ptr< TargetValue > ddl::mapping::DDLTarget::getValue ( const std::string & value_name ) const

overridevirtual

Get the value Target with a certain name.

Parameters

value_name

the name of the value target to retrieve

Returns

std::shared_ptr<TargetValue>

Implements ddl::mapping::Target.

updateEnd()

void ddl::mapping::DDLTarget::updateEnd ( )

overridevirtual

Function callback interface that is called after a value was updated.

Reimplemented from ddl::mapping::Updateable.

updateMemory()

void ddl::mapping::DDLTarget::updateMemory ( std::shared_ptr< Memory > memory )

overridevirtual

Sets the target's memory buffer where to set the values to.

Parameters

memory

the memory buffer

Implements ddl::mapping::MemoryTarget.

---

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

• include/ddl/mapping/mapping_ddl_target.h