ddl::mapping::DDLSource Class Reference

DDLSource implementation class representing a MemorySource that provides named source values for ddl based decoding. More...

#include <mapping_ddl_source.h>

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

Public Member Functions
	DDLSource (std::string name, Properties properties)
	CTOR.
std::vector< std::string >	getAllValues () const override
	Get all value names.
std::shared_ptr< const SourceValue >	getValue (const std::string &value_name) const override
	Get the value source with a certain name.
size_t	getExpectedDataSize () const override
	Get the expected data size in bytes.
void	updateMemory (std::shared_ptr< const Memory > memory) override
	Update the sources memory buffer.
Public Member Functions inherited from ddl::mapping::MapperElementBase< MemorySource >
	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::MapperElement
virtual	~MapperElement ()=default
	DTOR.

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

DDLSource implementation class representing a MemorySource that provides named source values for ddl based decoding.

Constructor & Destructor Documentation

DDLSource()

ddl::mapping::DDLSource::DDLSource	(	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::DDLSource::getAllValues ( ) const

overridevirtual

Get all value names.

Returns

std::vector<std::string>

Implements ddl::mapping::Source.

getDefaultProperties()

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

inlinestatic

Get the Default Properties to register within factory.

Returns

Properties

getExpectedDataSize()

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

overridevirtual

Get the expected data size in bytes.

Returns

size_t

Implements ddl::mapping::MemorySource.

getType()

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

inlinestatic

Get the Type as string to register within factory.

Returns

std::string

getValue()

std::shared_ptr< const SourceValue > ddl::mapping::DDLSource::getValue ( const std::string & value_name ) const

overridevirtual

Get the value source with a certain name.

Parameters

value_name

the name of the value source to retrieve

Returns

std::shared_ptr<const SourceValue>

Implements ddl::mapping::Source.

updateMemory()

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

overridevirtual

Update the sources memory buffer.

Parameters

memory

the memory for the underlying source implementation

Implements ddl::mapping::MemorySource.

---

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

• include/ddl/mapping/mapping_ddl_source.h